roboptim::GenericQuadraticFunction< T > Class Template Reference

Define an abstract quadratic function. More...

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

Public Types

typedef GenericTwiceDifferentiableFunction< T > parent_t
 
typedef parent_t::size_type size_type
 

Public Member Functions

 GenericQuadraticFunction (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...
 

Detailed Description

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

Define an abstract quadratic function.

Inherit from this class when implementing quadratic functions.

Member Typedef Documentation

◆ parent_t

◆ size_type

template<typename T >
typedef parent_t::size_type roboptim::GenericQuadraticFunction< T >::size_type

Constructor & Destructor Documentation

◆ GenericQuadraticFunction()

template<typename T >
roboptim::GenericQuadraticFunction< T >::GenericQuadraticFunction ( 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

◆ print()

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

Display the function on the specified output stream.

Parameters
ooutput stream used for display
Returns
output stream