WeightedSquareDistanceFunction class. More...

#include <WeightedSquareDistanceFunction.h>

Inheritance diagram for ocra::WeightedSquareDistanceFunction:

Collaboration diagram for ocra::WeightedSquareDistanceFunction:

Public Types
typedef QuadraticFunction	functionType_t

Public Types inherited from ocra::QuadraticFunction
typedef Function	functionType_t

Public Member Functions
template<class VectorBase >
	WeightedSquareDistanceFunction (Variable &x, double weight, const VectorBase &reference)

template<class VectorBase1 , class VectorBase2 >
	WeightedSquareDistanceFunction (Variable &x, const VectorBase1 &weight, const VectorBase2 &reference)

void	changeWeight (double weight)

template<class VectorBase >
void	changeWeight (const VectorBase &weight)

const VectorXd &	getWeight () const

template<class VectorBase >
void	changeReference (const VectorBase &reference)

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	updateValue () const

void	updateJacobian () const

void	doUpdateInputSizeBegin ()

void	doUpdateInputSizeEnd ()

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

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

void	doChangeri (double ri, int index=0)

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

virtual void	updateHessian () const

virtual void	updateq () const

virtual void	updater () const

virtual void	doUpdateDimensionEnd (int oldDimension)

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
VectorXd	_weight

VectorXd	_reference

double	_defaultWeight

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

WeightedSquareDistanceFunction class.

Warning: None

Quadratic function of the form & 1/2 |x - x_{ref} |^2_W & where W is a diagonal matrix.

Definition at line 32 of file WeightedSquareDistanceFunction.h.

Member Typedef Documentation

typedef QuadraticFunction ocra::WeightedSquareDistanceFunction::functionType_t

Definition at line 36 of file WeightedSquareDistanceFunction.h.

Constructor & Destructor Documentation

template<class VectorBase >

ocra::WeightedSquareDistanceFunction::WeightedSquareDistanceFunction	(	Variable &	x,
		double	weight,
		const VectorBase &	reference
	)

inline

Definition at line 89 of file WeightedSquareDistanceFunction.h.

template<class VectorBase1 , class VectorBase2 >

ocra::WeightedSquareDistanceFunction::WeightedSquareDistanceFunction	(	Variable &	x,
		const VectorBase1 &	weight,
		const VectorBase2 &	reference
	)

inline

Definition at line 116 of file WeightedSquareDistanceFunction.h.

Member Function Documentation

template<class VectorBase >

void ocra::WeightedSquareDistanceFunction::changeReference ( const VectorBase & reference )

inline

Definition at line 163 of file WeightedSquareDistanceFunction.h.

void ocra::WeightedSquareDistanceFunction::changeWeight ( double weight )

Definition at line 34 of file WeightedSquareDistanceFunction.cpp.

template<class VectorBase >

void ocra::WeightedSquareDistanceFunction::changeWeight ( const VectorBase & weight )

inline

Definition at line 147 of file WeightedSquareDistanceFunction.h.

void ocra::WeightedSquareDistanceFunction::doChangePi	(	const MatrixXd &	Pi,
		int	index = `0`
	)

protectedvirtual

Reimplemented from ocra::QuadraticFunction.

Definition at line 6 of file WeightedSquareDistanceFunction.cpp.

void ocra::WeightedSquareDistanceFunction::doChangeqi	(	const VectorXd &	qi,
		int	index = `0`
	)

protectedvirtual

Reimplemented from ocra::QuadraticFunction.

Definition at line 23 of file WeightedSquareDistanceFunction.cpp.

void ocra::WeightedSquareDistanceFunction::doChangeri	(	double	ri,
		int	index = `0`
	)

protectedvirtual

Reimplemented from ocra::QuadraticFunction.

Definition at line 29 of file WeightedSquareDistanceFunction.cpp.

void ocra::WeightedSquareDistanceFunction::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 65 of file WeightedSquareDistanceFunction.cpp.

void ocra::WeightedSquareDistanceFunction::doUpdateInputSizeEnd ( void )

protectedvirtual

Reimplemented from ocra::QuadraticFunction.

Definition at line 71 of file WeightedSquareDistanceFunction.cpp.

const VectorXd& ocra::WeightedSquareDistanceFunction::getWeight ( ) const

inline

Definition at line 57 of file WeightedSquareDistanceFunction.h.

void ocra::WeightedSquareDistanceFunction::updateJacobian ( ) const

protectedvirtual

Reimplemented from ocra::QuadraticFunction.