ocra-recipes
Doxygen documentation for the ocra-recipes repository
Public Member Functions | List of all members
ocra::Objective< T > Class Template Reference

Objective class. More...

#include <Objective.h>

Inheritance diagram for ocra::Objective< T >:
[legend]
Collaboration diagram for ocra::Objective< T >:
[legend]

Public Member Functions

 Objective (T *function, double weight=1.)
 
 operator const T & ()
 
virtual T & getFunction (void)
 
virtual const T & getFunction (void) const
 

Detailed Description

template<class T>
class ocra::Objective< T >

Objective class.

Warning
None

Given a function $ f $ over $ x \in R^n $ and possibly over the time $ t $, we can write an objective whose most generic expression is $ \alpha f(x,t) $, where $ alpha $ could be a square matrix of size the output dimension of $ f $, but we will only consider that $ alpha $ can be a real (which generally amounts to the same since most objectives have a dimension of 1).

The Objective class is built in a very similar way as the Constraint class, with the same mechanism to replicate the Function hierarchy and the derivation from FunctionInterfaceMapping to retrieve part of the interface of the Function class given as template parameter. Please refer to Constraint documentation for more details.

See also
Constraint

Definition at line 44 of file Objective.h.

Constructor & Destructor Documentation

template<class T>
ocra::Objective< T >::Objective ( T *  function,
double  weight = 1. 
)
inline

Definition at line 114 of file Objective.h.

Member Function Documentation

template<class T>
virtual T& ocra::Objective< T >::getFunction ( void  )
inlinevirtual

getter on the function on which the constraint is built

Definition at line 64 of file Objective.h.

template<class T>
virtual const T& ocra::Objective< T >::getFunction ( void  ) const
inlinevirtual

Definition at line 65 of file Objective.h.

template<class T>
ocra::Objective< T >::operator const T & ( )
inline

Conversion operator

Definition at line 60 of file Objective.h.


The documentation for this class was generated from the following file: