SquaredLinearFunction class. More...

#include <SquaredLinearFunction.h>

Inheritance diagram for ocra::SquaredLinearFunction:

Collaboration diagram for ocra::SquaredLinearFunction:

Public Types
typedef QuadraticFunction	functionType_t

Public Types inherited from ocra::QuadraticFunction
typedef Function	functionType_t

Public Member Functions
	SquaredLinearFunction (LinearFunction *f)

	~SquaredLinearFunction ()

void	changeWeight (const VectorXd &weight)

LinearFunction &	getFunction ()

const LinearFunction &	getFunction () const

Public Member Functions inherited from ocra::QuadraticFunction
template<class Derived , class VectorBase >
	QuadraticFunction (Variable &x, const MatrixBase< Derived > &P, const VectorBase &q, double r)

virtual	~QuadraticFunction ()

const MatrixXd &	getPi (int index=0) const

const VectorXd &	getqi (int index=0) const

double	getri (int index=0) const

const VectorXd &	getr () const

void	changePi (const MatrixXd &Pi, int index=0)

void	changeqi (const VectorXd &qi, int index=0)

void	changeri (double ri, int index=0)

Public Member Functions inherited from ocra::Function
virtual	~Function ()

int	getDimension () const

virtual void	updateFdot () const

virtual void	updateFddot () const

virtual void	updateJdotXdot () const

const Variable &	getVariable () const

Variable &	getVariable ()

template<eFunctionAbility Ability>
void	invalidate ()

void	invalidateAll (int timestamp)

void	invalidateAll ()

template<eFunctionAbility Ability>
bool	isValid () const

template<eFunctionAbility Ability>
bool	canCompute () const

template<eFunctionAbility Ability>
const IFunction< Ability >::return_type &	get () const

template<eFunctionAbility Ability>
IFunction< Ability >::return_sub_type	get (int index) const

const VectorXd &	getValue () const

double	getValue (int index) const

const MatrixXd &	getJacobian () const

MatrixXdRow	getJacobian (int index) const

Public Member Functions inherited from ocra::ObserverSubject
	ObserverSubject ()

virtual	~ObserverSubject ()

Public Member Functions inherited from ocra::Observer
virtual	~Observer ()

template<int EVT>
void	bind (SubjectBase< EVT > &subject)
	Call this method to automatically propagate observed events to observers connected to the subject given in argument. More...

template<int EVT>
void	stopPropagation ()

Public Member Functions inherited from ocra::ObserverBase< EVT_RESIZE >
void	bind (subject_type &subject)
	Call this method to automatically propagate observed events to observers connected to the subject given in argument. More...

Public Member Functions inherited from ocra::ObserverBase< EVT_CHANGE_DEPENDENCIES >
void	bind (subject_type &subject)
	Call this method to automatically propagate observed events to observers connected to the subject given in argument. More...

Public Member Functions inherited from ocra::ObserverBase< EVT_CHANGE_VALUE >
void	bind (subject_type &subject)
	Call this method to automatically propagate observed events to observers connected to the subject given in argument. More...

Public Member Functions inherited from ocra::Subject
virtual	~Subject ()

template<int EVT, class Derived , class Base >
void	connect (Derived &object, void(Base::*newCallback)(int)) const
	Call this method to register a non-static method as a callback. More...

template<int EVT>
void	connect (void(*newCallback)(int)) const
	Call this method to register a free function as a callback. More...

template<int EVT, class Derived , class Base >
void	disconnect (Derived &object, void(Base::*callbackToErase)(int)) const
	Disconnect non-static method. More...

template<int EVT>
void	disconnect (void(*callbackToErase)(int)) const
	Disconnect free function. More...

template<int EVT>
void	propagate () const

template<int EVT>
void	propagate (int timestamp) const

Public Member Functions inherited from ocra::SubjectBase< EVT_RESIZE >
void	connect (T &object, typename SubjectBaseTraits< EVT, T >::callback_type newCallback) const
	Call this method to register a non-static method as a callback. More...

void	connect (typename SubjectBaseTraits< EVT, void >::callback_type newCallback) const
	Call this method to register a free function as a callback. More...

void	disconnect (T &object, typename SubjectBaseTraits< EVT, T >::callback_type callback) const
	Disconnect non-static method. More...

void	disconnect (typename SubjectBaseTraits< EVT, void >::callback_type callbackToErase) const
	Disconnect free function. More...

void	propagate (int timestamp) const

void	propagate () const

Public Member Functions inherited from ocra::SubjectBase< EVT_CHANGE_DEPENDENCIES >
void	connect (T &object, typename SubjectBaseTraits< EVT, T >::callback_type newCallback) const
	Call this method to register a non-static method as a callback. More...

void	connect (typename SubjectBaseTraits< EVT, void >::callback_type newCallback) const
	Call this method to register a free function as a callback. More...

void	disconnect (T &object, typename SubjectBaseTraits< EVT, T >::callback_type callback) const
	Disconnect non-static method. More...

void	disconnect (typename SubjectBaseTraits< EVT, void >::callback_type callbackToErase) const
	Disconnect free function. More...

void	propagate (int timestamp) const

void	propagate () const

Public Member Functions inherited from ocra::SubjectBase< EVT_CHANGE_VALUE >
void	connect (T &object, typename SubjectBaseTraits< EVT, T >::callback_type newCallback) const
	Call this method to register a non-static method as a callback. More...

void	connect (typename SubjectBaseTraits< EVT, void >::callback_type newCallback) const
	Call this method to register a free function as a callback. More...

void	disconnect (T &object, typename SubjectBaseTraits< EVT, T >::callback_type callback) const
	Disconnect non-static method. More...

void	disconnect (typename SubjectBaseTraits< EVT, void >::callback_type callbackToErase) const
	Disconnect free function. More...

void	propagate (int timestamp) const

void	propagate () const

Public Member Functions inherited from ocra::IFunctionProperties
bool	hasSeparableTimeDependancy (void) const

eFunctionLinearity	getType (void) const

eFunctionConvexity	getConvexityProperty (void) const

int	getContinuityProperty (void) const

const std::string &	getProperty (int i) const

int	getNumberOfProperties (void) const

bool	hasProperty (const std::string &functionProperty) const

bool	isExplicitlyTimeDependant (void) const

Public Member Functions inherited from ocra::NamedInstance
	NamedInstance (const std::string &name)

const std::string &	getName () const

virtual	~NamedInstance ()

Public Member Functions inherited from ocra::AbilitySet
AbilitySet &	add (eFunctionAbility prop)

AbilitySet &	remove (eFunctionAbility prop)

Protected Member Functions
void	updateHessian () const

void	updateq () const

void	updater () const

void	doUpdateInputSizeBegin ()

void	onResize (int)

Protected Member Functions inherited from ocra::QuadraticFunction
	QuadraticFunction (Variable &x, int dimension=1)

virtual void	updateValue () const

virtual void	updateJacobian () const

virtual void	doUpdateInputSizeEnd ()

virtual void	doUpdateDimensionEnd (int oldDimension)

virtual void	doChangePi (const MatrixXd &Pi, int index)

virtual void	doChangeqi (const VectorXd &qi, int index)

virtual void	doChangeri (double ri, int index)

void	invalidateq (int timestamp)

void	invalidater (int timestamp)

void	inhibitPropagationFrom_q_or_r () const

void	desinhibitPropagationFrom_q_or_r () const

Protected Member Functions inherited from ocra::Function
	Function (Variable &x, int dimension, eFunctionLinearity linearity=LINEARITY_UNDEFINED, eFunctionConvexity convexity=CONVEXITY_UNDEFINED, int continuity=CONTINUITY_UNKNOWN, bool explicitlyTimeDependant=false, bool separableTimeDependancy=true)
	Function Constructor. More...

void	disconnectVariable ()

void	changeFunctionDimension (int newDimension)

void	updateInputSize (int timestamp)

void	resize ()

virtual int	computeDimensionFromInputSize () const

virtual void	doUpdateDimensionBegin (int newDimension)

Protected Member Functions inherited from ocra::ObserverBase< EVT_RESIZE >
void	stopPropagation ()
	Call this method from your callbacks to avoid propagation to the bound subject (if any). More...

	ObserverBase ()

	~ObserverBase ()

Protected Member Functions inherited from ocra::ObserverBase< EVT_CHANGE_DEPENDENCIES >
void	stopPropagation ()
	Call this method from your callbacks to avoid propagation to the bound subject (if any). More...

	ObserverBase ()

	~ObserverBase ()

Protected Member Functions inherited from ocra::ObserverBase< EVT_CHANGE_VALUE >
void	stopPropagation ()
	Call this method from your callbacks to avoid propagation to the bound subject (if any). More...

	ObserverBase ()

	~ObserverBase ()

Protected Member Functions inherited from ocra::SubjectBase< EVT_RESIZE >
	SubjectBase ()

	~SubjectBase ()

Protected Member Functions inherited from ocra::SubjectBase< EVT_CHANGE_DEPENDENCIES >
	SubjectBase ()

	~SubjectBase ()

Protected Member Functions inherited from ocra::SubjectBase< EVT_CHANGE_VALUE >
	SubjectBase ()

	~SubjectBase ()

Protected Member Functions inherited from ocra::IFunctionProperties
	IFunctionProperties (eFunctionLinearity linearity=LINEARITY_UNDEFINED, eFunctionConvexity convexity=CONVEXITY_UNDEFINED, int continuity=CONTINUITY_UNKNOWN, bool explicitlyTimeDependant=false, bool separableTimeDependancy=true)
	IFunctionProperties Constructor. More...

void	changeType (eFunctionLinearity newType)

void	changeConvexityProperty (eFunctionConvexity newProperty)

void	changeContinuityProperty (int newProperty)

void	addProperty (const std::string &functionProperty)

void	removeProperty (const std::string &functionProperty)

void	changeExplicitTimeDependancy (bool b)

void	changeSeparableTimeDependancy (bool b)

Protected Member Functions inherited from ocra::AbilitySet
	AbilitySet (const std::vector< bool > &usageSet)

const std::vector< bool > &	getUsageSet () const

	AbilitySet (eFunctionAbility prop0=FUN_VALUE, eFunctionAbility prop1=FUN_VALUE)

	AbilitySet (eFunctionAbility prop0, eFunctionAbility prop1, eFunctionAbility prop2, eFunctionAbility prop3=FUN_VALUE, eFunctionAbility prop4=FUN_VALUE)

	AbilitySet (eFunctionAbility prop0, eFunctionAbility prop1, eFunctionAbility prop2, eFunctionAbility prop3, eFunctionAbility prop4, eFunctionAbility prop5, eFunctionAbility prop6=FUN_VALUE, eFunctionAbility prop7=FUN_VALUE, eFunctionAbility prop8=FUN_VALUE, eFunctionAbility prop9=FUN_VALUE)

Protected Member Functions inherited from ocra::CoupledInputOutputSize
	CoupledInputOutputSize (bool coupledInputOutputSize)

bool	inputAndOutputSizesAreCoupled () const

Protected Attributes
LinearFunction *	_f

VectorXd	_weight

Protected Attributes inherited from ocra::QuadraticFunction
std::vector< VectorXd * >	_q

VectorXd	_r

bool	_qIsUpToDate

bool	_rIsUpToDate

Protected Attributes inherited from ocra::Function
Variable &	x

VectorXd &	_value

MatrixXd &	_jacobian

const int &	_dim

Additional Inherited Members
Protected Types inherited from ocra::ObserverBase< EVT_RESIZE >
typedef SubjectBase< EVT >	subject_type

typedef InvokerBase< EVT >	invoker_type

Protected Types inherited from ocra::ObserverBase< EVT_CHANGE_DEPENDENCIES >
typedef SubjectBase< EVT >	subject_type

typedef InvokerBase< EVT >	invoker_type

Protected Types inherited from ocra::ObserverBase< EVT_CHANGE_VALUE >
typedef SubjectBase< EVT >	subject_type

typedef InvokerBase< EVT >	invoker_type

Detailed Description

SquaredLinearFunction class.

Warning: None

Quadratic function of the form & 1/2 |f(x)|^2 & with f(x) = Ax+b If A and b are constant, better use QuadraticFunction directly.

//TODO [todo] : optimize computations

Definition at line 38 of file SquaredLinearFunction.h.

Member Typedef Documentation

typedef QuadraticFunction ocra::SquaredLinearFunction::functionType_t

Definition at line 42 of file SquaredLinearFunction.h.

Constructor & Destructor Documentation

ocra::SquaredLinearFunction::SquaredLinearFunction ( LinearFunction * f )

Definition at line 5 of file SquaredLinearFunction.cpp.

ocra::SquaredLinearFunction::~SquaredLinearFunction ( )

Definition at line 21 of file SquaredLinearFunction.cpp.

Member Function Documentation

void ocra::SquaredLinearFunction::changeWeight ( const VectorXd & weight )

Definition at line 30 of file SquaredLinearFunction.cpp.

void ocra::SquaredLinearFunction::doUpdateInputSizeBegin ( )

protectedvirtual

Methods for pre and post update in case the variable size has changed. Default implementation of doUpdateInputSizeEnd does nothing, doUpdateInputSizeBegin throws an exception. These methods might throw exceptions when overloaded. Furthermore, doUpdateInputSizeEnd() must comply with the post condition of updateInputSize(), i.e. let the values of each ability invalidated.

Reimplemented from ocra::Function.

Definition at line 80 of file SquaredLinearFunction.cpp.

LinearFunction & ocra::SquaredLinearFunction::getFunction ( void )

Definition at line 49 of file SquaredLinearFunction.cpp.

const LinearFunction & ocra::SquaredLinearFunction::getFunction ( void ) const

Definition at line 55 of file SquaredLinearFunction.cpp.

void ocra::SquaredLinearFunction::onResize ( int )

protected

Definition at line 86 of file SquaredLinearFunction.cpp.

void ocra::SquaredLinearFunction::updateHessian ( ) const

protectedvirtual

Reimplemented from ocra::QuadraticFunction.

Definition at line 61 of file SquaredLinearFunction.cpp.

void ocra::SquaredLinearFunction::updateq ( ) const

protectedvirtual

Reimplemented from ocra::QuadraticFunction.

Definition at line 67 of file SquaredLinearFunction.cpp.

void ocra::SquaredLinearFunction::updater ( ) const

protectedvirtual

Reimplemented from ocra::QuadraticFunction.

Definition at line 74 of file SquaredLinearFunction.cpp.

Member Data Documentation

LinearFunction* ocra::SquaredLinearFunction::_f

protected

Definition at line 72 of file SquaredLinearFunction.h.

VectorXd ocra::SquaredLinearFunction::_weight

protected

Definition at line 73 of file SquaredLinearFunction.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation