roboptim::GenericConstantFunction< T > Class Template Reference

Constant function. More...

#include <roboptim/core/fwd.hh>

Inheritance diagram for roboptim::GenericConstantFunction< T >:
Collaboration diagram for roboptim::GenericConstantFunction< T >:

Public Member Functions

 ROBOPTIM_TWICE_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (GenericLinearFunction< T >)
 
 GenericConstantFunction (const_vector_ref offset)
 Build a constant function. More...
 
 GenericConstantFunction (size_type input_size, const_vector_ref offset)
 Build a constant function. More...
 
 ~GenericConstantFunction ()
 
virtual std::ostream & print (std::ostream &o) const
 Display the function on the specified output stream. More...
 
- Public Member Functions inherited from roboptim::GenericLinearFunction< T >
 ROBOPTIM_TWICE_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (GenericQuadraticFunction< T >)
 
 GenericLinearFunction (size_type inputSize, size_type outputSize=1, std::string name=std::string())
 Concrete class constructor should call this constructor. More...
 

Protected Member Functions

void impl_compute (result_ref result, const_argument_ref) const
 
void impl_gradient (gradient_ref gradient, const_argument_ref, size_type=0) const
 
void impl_jacobian (jacobian_ref jacobian, const_argument_ref) const
 
- Protected Member Functions inherited from roboptim::GenericLinearFunction< T >
void impl_hessian (hessian_ref hessian, const_argument_ref argument, size_type functionId=0) const
 

Detailed Description

template<typename T>
class roboptim::GenericConstantFunction< T >

Constant function.

Implement a constant function using the formula:

\[f(x) = offset\]

where $offset$ is set when the class is instantiated.

Examples
problem-cc.cc.

Constructor & Destructor Documentation

◆ GenericConstantFunction() [1/2]

template<typename T >
roboptim::GenericConstantFunction< T >::GenericConstantFunction ( const_vector_ref  offset)
inline

Build a constant function.

Parameters
offsetconstant function offset

◆ GenericConstantFunction() [2/2]

template<typename T >
roboptim::GenericConstantFunction< T >::GenericConstantFunction ( size_type  input_size,
const_vector_ref  offset 
)
inline

Build a constant function.

Parameters
input_sizeinput size of the function
offsetconstant function offset

◆ ~GenericConstantFunction()

template<typename T >
roboptim::GenericConstantFunction< T >::~GenericConstantFunction ( )
inline

Member Function Documentation

◆ impl_compute()

template<typename T >
void roboptim::GenericConstantFunction< T >::impl_compute ( result_ref  result,
const_argument_ref   
) const
inlineprotected

◆ impl_gradient()

template<typename T >
void roboptim::GenericConstantFunction< T >::impl_gradient ( gradient_ref  gradient,
const_argument_ref  ,
size_type  = 0 
) const
inlineprotected

◆ impl_jacobian()

template<typename T >
void roboptim::GenericConstantFunction< T >::impl_jacobian ( jacobian_ref  jacobian,
const_argument_ref   
) const
inlineprotected

◆ print()

template<typename T >
virtual std::ostream& roboptim::GenericConstantFunction< T >::print ( std::ostream &  o) const
inlinevirtual

Display the function on the specified output stream.

Parameters
ooutput stream used for display
Returns
output stream

Reimplemented from roboptim::GenericLinearFunction< T >.

References roboptim::decindent(), roboptim::iendl(), and roboptim::incindent().

◆ ROBOPTIM_TWICE_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_()

template<typename T >
roboptim::GenericConstantFunction< T >::ROBOPTIM_TWICE_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ ( GenericLinearFunction< T >  )