roboptim::GenericIdentityFunction< T > Class Template Reference

Identity function. More...

#include <roboptim/core/fwd.hh>

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

Public Member Functions

 ROBOPTIM_TWICE_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ (GenericLinearFunction< T >)
 
 GenericIdentityFunction (const_vector_ref offset)
 Build an identity function. More...
 
 ~GenericIdentityFunction ()
 
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 argument) const
 
void impl_jacobian (jacobian_ref jacobian, const_argument_ref) const
 
void impl_gradient (gradient_ref gradient, const_argument_ref, size_type idFunction) const
 
void impl_gradient (gradient_ref gradient, const_argument_ref, size_type idFunction) 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::GenericIdentityFunction< T >

Identity function.

Implement a linear function using the formula:

\[f(x) = x + offset\]

where $A$ and $b$ are set when the class is instantiated.

Constructor & Destructor Documentation

◆ GenericIdentityFunction()

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

Build an identity function.

Parameters
offsetidentity function offset

◆ ~GenericIdentityFunction()

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

Member Function Documentation

◆ impl_compute()

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

◆ impl_gradient()

void roboptim::GenericIdentityFunction< EigenMatrixSparse >::impl_gradient ( gradient_ref  gradient,
const_argument_ref  ,
size_type  idFunction 
) const
inlineprotected

◆ impl_jacobian()

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

◆ print()

template<typename T >
virtual std::ostream& roboptim::GenericIdentityFunction< 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::GenericIdentityFunction< T >::ROBOPTIM_TWICE_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_ ( GenericLinearFunction< T >  )