roboptim::GenericQuadraticFunction< T > Class Template Reference

Define an abstract quadratic function. More...

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

Inheritance diagram for roboptim::GenericQuadraticFunction< T >:

Collaboration diagram for roboptim::GenericQuadraticFunction< T >:

List of all members.

Public Types
typedef GenericTwiceDifferentiableFunction < T >	parent_t
typedef parent_t::size_type	size_type
	Size type.
Public Member Functions
	GenericQuadraticFunction (size_type inputSize, size_type outputSize=1, std::string name=std::string()) throw ()
	Concrete class constructor should call this constructor.
virtual std::ostream &	print (std::ostream &) const throw ()
	Display the function on the specified output stream.

---

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

template<typename T >

typedef GenericTwiceDifferentiableFunction<T> roboptim::GenericQuadraticFunction< T >::parent_t

Reimplemented in roboptim::GenericLinearFunction< T >.

template<typename T >

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

Size type.

This type is used to represent sizes, indexes, etc.

Reimplemented from roboptim::GenericFunction< T >.

Reimplemented in roboptim::GenericLinearFunction< T >.

---

Constructor & Destructor Documentation

template<typename T >

roboptim::GenericQuadraticFunction< T >::GenericQuadraticFunction	(	size_type	inputSize,
		size_type	outputSize = 1,
		std::string	name = std::string ()
	)		throw ()

Concrete class constructor should call this constructor.

Parameters:

inputSize	function arity
outputSize	result size
name	function's name

---

Member Function Documentation

template<typename T >

std::ostream & roboptim::GenericQuadraticFunction< T >::print

(

std::ostream &

o

)

const throw () [virtual]

Display the function on the specified output stream.

Parameters:

o	output stream used for display

Returns:

output stream

Reimplemented from roboptim::GenericTwiceDifferentiableFunction< T >.

Reimplemented in roboptim::GenericLinearFunction< T >, roboptim::NumericQuadraticFunction, roboptim::GenericNumericLinearFunction< T >, roboptim::IdentityFunction, and roboptim::ConstantFunction.