MOOCHO (Single Doxygen Collection)
Version of the Day
|
Adds the ability to compute phi(alpha) at alpha of a given set of vectors. More...
#include <ConstrainedOptPack_MeritFuncCalc1DQuadratic.hpp>
Public Types | |
typedef const Vector * | const_VectorWithOp_ptr |
Private Member Functions | |
MeritFuncCalc1DQuadratic () | |
MeritFuncCalc1DQuadratic & | operator= (const MeritFuncCalc1DQuadratic &) |
Private Attributes | |
const MeritFuncCalc & | phi_ |
size_type | p_ |
const_VectorWithOp_ptr | d_ [3] |
VectorMutable * | x_ |
Constructors | |
MeritFuncCalc1DQuadratic (const MeritFuncCalc &phi, size_type p, const_VectorWithOp_ptr d[], VectorMutable *x) | |
The only constructor. More... | |
Overridden from MeritFuncCalc1D | |
value_type | operator() (value_type alpha) const |
Returns phi( x = sum( alpha^k * d[k], k = 0...p-1 ) ) . More... | |
value_type | deriv () const |
Returns phi.deriv() More... | |
void | print_merit_func (std::ostream &out, const std::string &leading_str) const |
Calls phi->print_merit_func() . More... | |
Additional Inherited Members | |
Public Member Functions inherited from ConstrainedOptPack::MeritFuncCalc1D | |
virtual | ~MeritFuncCalc1D () |
Adds the ability to compute phi(alpha) at alpha of a given set of vectors.
Computes phi( x = sum( alpha^k * d[k], k = 0...p-1 ) )
where 1 <= p <= 2
.
Definition at line 55 of file ConstrainedOptPack_MeritFuncCalc1DQuadratic.hpp.
typedef const Vector* ConstrainedOptPack::MeritFuncCalc1DQuadratic::const_VectorWithOp_ptr |
Definition at line 59 of file ConstrainedOptPack_MeritFuncCalc1DQuadratic.hpp.
ConstrainedOptPack::MeritFuncCalc1DQuadratic::MeritFuncCalc1DQuadratic | ( | const MeritFuncCalc & | phi, |
size_type | p, | ||
const_VectorWithOp_ptr | d[], | ||
VectorMutable * | x | ||
) |
The only constructor.
Note that *x
and *d
gets updated as operator()(alpha)
is called.
The client must ensure that the memory pointed to by the vectors in d must not be desturbed while this object is in use. To do so may have bad side effects.
phi | [in] The merit function to use. |
p | [in] The number of vectors in d []. |
d | [in] Array (length p ) of pointers to the rhs d [] vectors. |
x | [out] The vector that gets updated. |
Preconditions:
1 <= p <= 3
d[k]->space().is_compatible(x->space()), for k = 0...p-1
Definition at line 50 of file ConstrainedOptPack_MeritFuncCalc1DQuadratic.cpp.
|
private |
|
virtual |
Returns phi( x = sum( alpha^k * d[k], k = 0...p-1 ) )
.
Implements ConstrainedOptPack::MeritFuncCalc1D.
Definition at line 67 of file ConstrainedOptPack_MeritFuncCalc1DQuadratic.cpp.
|
virtual |
Returns phi.deriv()
Implements ConstrainedOptPack::MeritFuncCalc1D.
Definition at line 78 of file ConstrainedOptPack_MeritFuncCalc1DQuadratic.cpp.
|
virtual |
Calls phi->print_merit_func()
.
Implements ConstrainedOptPack::MeritFuncCalc1D.
Definition at line 83 of file ConstrainedOptPack_MeritFuncCalc1DQuadratic.cpp.
|
private |
|
private |
Definition at line 106 of file ConstrainedOptPack_MeritFuncCalc1DQuadratic.hpp.
|
private |
Definition at line 107 of file ConstrainedOptPack_MeritFuncCalc1DQuadratic.hpp.
|
private |
Definition at line 108 of file ConstrainedOptPack_MeritFuncCalc1DQuadratic.hpp.
|
private |
Definition at line 109 of file ConstrainedOptPack_MeritFuncCalc1DQuadratic.hpp.