ROL
ROL_Dirac.hpp
Go to the documentation of this file.
1// @HEADER
2// ************************************************************************
3//
4// Rapid Optimization Library (ROL) Package
5// Copyright (2014) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact lead developers:
38// Drew Kouri (dpkouri@sandia.gov) and
39// Denis Ridzal (dridzal@sandia.gov)
40//
41// ************************************************************************
42// @HEADER
43
44#ifndef ROL_DIRAC_HPP
45#define ROL_DIRAC_HPP
46
47#include "ROL_Distribution.hpp"
48#include "ROL_ParameterList.hpp"
49
50namespace ROL {
51
52template<class Real>
53class Dirac : public Distribution<Real> {
54private:
55 Real data_;
56
57public:
58 Dirac(const Real data = 0.) : data_(data) {}
59
60 Dirac(ROL::ParameterList &parlist) {
61 data_ = parlist.sublist("SOL").sublist("Distribution").sublist("Dirac").get("Location",0.);
62 }
63
64 Real evaluatePDF(const Real input) const {
65 return ((input==data_) ? 1.0 : 0.0);
66 }
67
68 Real evaluateCDF(const Real input) const {
69 return ((input >= data_) ? 1.0 : 0.0);
70 }
71
72 Real integrateCDF(const Real input) const {
73 return ((input < data_) ? 0.0 : input);
74 }
75
76 Real invertCDF(const Real input) const {
77 return data_;
78 }
79
80 Real moment(const size_t m) const {
81 if (m==1) {
82 return data_;
83 }
84 return std::pow(data_,(Real)m);
85 }
86
87 Real lowerBound(void) const {
88 return data_;
89 }
90
91 Real upperBound(void) const {
92 return data_;
93 }
94
95 void test(std::ostream &outStream = std::cout ) const {
96 size_t size = 0;
97 std::vector<Real> X(size,4.*(Real)rand()/(Real)RAND_MAX - 2.);
98 std::vector<int> T(size,0);
99 Distribution<Real>::test(X,T,outStream);
100 }
101};
102
103}
104
105#endif
Dirac(const Real data=0.)
Definition: ROL_Dirac.hpp:58
Real lowerBound(void) const
Definition: ROL_Dirac.hpp:87
Real integrateCDF(const Real input) const
Definition: ROL_Dirac.hpp:72
Dirac(ROL::ParameterList &parlist)
Definition: ROL_Dirac.hpp:60
Real upperBound(void) const
Definition: ROL_Dirac.hpp:91
Real evaluatePDF(const Real input) const
Definition: ROL_Dirac.hpp:64
void test(std::ostream &outStream=std::cout) const
Definition: ROL_Dirac.hpp:95
Real evaluateCDF(const Real input) const
Definition: ROL_Dirac.hpp:68
Real invertCDF(const Real input) const
Definition: ROL_Dirac.hpp:76
Real moment(const size_t m) const
Definition: ROL_Dirac.hpp:80
Real data_
Definition: ROL_Dirac.hpp:55
virtual void test(std::ostream &outStream=std::cout) const