roboptim::GenericLinearFunction< T > Class Template Reference

Define an abstract linear function. More...

#include <roboptim/core/linear-function.hh>

Inheritance diagram for roboptim::GenericLinearFunction< T >:

Public Member Functions

 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...
 
virtual std::ostream & print (std::ostream &) const
 Display the function on the specified output stream. More...
 

Protected Member Functions

void impl_hessian (hessian_ref hessian, const_argument_ref argument, size_type functionId=0) const
 

Detailed Description

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

Define an abstract linear function.

Inherit from this class when implementing linear functions.

Examples
numeric-linear-function.cc.

Constructor & Destructor Documentation

◆ GenericLinearFunction()

template<typename T >
roboptim::GenericLinearFunction< T >::GenericLinearFunction ( size_type  inputSize,
size_type  outputSize = 1,
std::string  name = std::string () 
)

Concrete class constructor should call this constructor.

Parameters
inputSizefunction arity
outputSizeresult size
namefunction's name

Member Function Documentation

◆ impl_hessian()

template<typename T >
void roboptim::GenericLinearFunction< T >::impl_hessian ( hessian_ref  hessian,
const_argument_ref  argument,
size_type  functionId = 0 
) const
protected

◆ print()

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

Display the function on the specified output stream.

Parameters
ooutput stream used for display
Returns
output stream

Reimplemented in roboptim::GenericConstantFunction< T >, and roboptim::GenericIdentityFunction< T >.

◆ ROBOPTIM_TWICE_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_()

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