aligator::FrameVelocityResidualTpl< _Scalar > Struct Template Reference

#include <aligator/modelling/multibody/frame-velocity.hpp>

Inheritance diagram for aligator::FrameVelocityResidualTpl< _Scalar >:

Collaboration diagram for aligator::FrameVelocityResidualTpl< _Scalar >:

Public Types
using	Scalar = _Scalar
using	BaseData = typename Base::Data
using	Model = pinocchio::ModelTpl<Scalar>
using	ManifoldPtr = xyz::polymorphic<ManifoldAbstractTpl<Scalar>>
using	SE3 = pinocchio::SE3Tpl<Scalar>
using	Motion = pinocchio::MotionTpl<Scalar>
using	Data = FrameVelocityDataTpl<Scalar>
Public Types inherited from aligator::UnaryFunctionTpl< _Scalar >
using	Scalar = _Scalar
using	Base = StageFunctionTpl<Scalar>
using	Data = StageFunctionDataTpl<Scalar>
Public Types inherited from aligator::StageFunctionTpl< _Scalar >
using	Scalar = _Scalar
using	Data = StageFunctionDataTpl<Scalar>

Public Member Functions
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
	ALIGATOR_UNARY_FUNCTION_INTERFACE (Scalar)
	FrameVelocityResidualTpl (const int ndx, const int nu, const Model &model, const Motion &velocity, const pinocchio::FrameIndex id, const pinocchio::ReferenceFrame type)
ALIGATOR_DEPRECATED const Motion &	getReference () const
ALIGATOR_DEPRECATED void	setReference (const Motion &v_new)
void	evaluate (const ConstVectorRef &x, BaseData &data) const
void	computeJacobians (const ConstVectorRef &x, BaseData &data) const
shared_ptr< BaseData >	createData () const
	Instantiate a Data object.
Public Member Functions inherited from aligator::UnaryFunctionTpl< _Scalar >
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
virtual void	evaluate (const ConstVectorRef &x, Data &data) const =0
virtual void	computeJacobians (const ConstVectorRef &x, Data &data) const =0
virtual void	computeVectorHessianProducts (const ConstVectorRef &, const ConstVectorRef &, Data &) const
void	evaluate (const ConstVectorRef &x, const ConstVectorRef &, Data &data) const override
	Evaluate the function.
void	computeJacobians (const ConstVectorRef &x, const ConstVectorRef &, Data &data) const override
	Compute Jacobians of this function.
void	computeVectorHessianProducts (const ConstVectorRef &x, const ConstVectorRef &, const ConstVectorRef &lbda, Data &data) const override
	Compute the vector-hessian products of this function.
Public Member Functions inherited from aligator::StageFunctionTpl< _Scalar >
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)
	StageFunctionTpl (const int ndx, const int nu, const int nr)
virtual	~StageFunctionTpl ()=default
Public Member Functions inherited from aligator::frame_api
pinocchio::FrameIndex	getFrameId () const
void	setFrameId (const std::size_t id)

Public Attributes
Model	pin_model_
Motion	vref_
pinocchio::ReferenceFrame	type_
Public Attributes inherited from aligator::StageFunctionTpl< _Scalar >
const int	ndx1
	Current state dimension.
const int	nu
	Control dimension.
const int	nr
	Function codimension.

Additional Inherited Members
Protected Attributes inherited from aligator::frame_api
pinocchio::FrameIndex	pin_frame_id_

Detailed Description

template<typename _Scalar>
struct aligator::FrameVelocityResidualTpl< _Scalar >

Definition at line 16 of file frame-velocity.hpp.

Member Typedef Documentation

Scalar

template<typename _Scalar>

using aligator::FrameVelocityResidualTpl< _Scalar >::Scalar = _Scalar

Definition at line 19 of file frame-velocity.hpp.

BaseData

template<typename _Scalar>

using aligator::FrameVelocityResidualTpl< _Scalar >::BaseData = typename Base::Data

Definition at line 22 of file frame-velocity.hpp.

Model

template<typename _Scalar>

using aligator::FrameVelocityResidualTpl< _Scalar >::Model = pinocchio::ModelTpl<Scalar>

Definition at line 23 of file frame-velocity.hpp.

ManifoldPtr

template<typename _Scalar>

using aligator::FrameVelocityResidualTpl< _Scalar >::ManifoldPtr = xyz::polymorphic<ManifoldAbstractTpl<Scalar>>

Definition at line 24 of file frame-velocity.hpp.

SE3

template<typename _Scalar>

using aligator::FrameVelocityResidualTpl< _Scalar >::SE3 = pinocchio::SE3Tpl<Scalar>

Definition at line 25 of file frame-velocity.hpp.

Motion

template<typename _Scalar>

using aligator::FrameVelocityResidualTpl< _Scalar >::Motion = pinocchio::MotionTpl<Scalar>

Definition at line 26 of file frame-velocity.hpp.

Data

template<typename _Scalar>

using aligator::FrameVelocityResidualTpl< _Scalar >::Data = FrameVelocityDataTpl<Scalar>

Definition at line 27 of file frame-velocity.hpp.

Constructor & Destructor Documentation

FrameVelocityResidualTpl()

template<typename _Scalar>

aligator::FrameVelocityResidualTpl< _Scalar >::FrameVelocityResidualTpl	(	const int	ndx,
		const int	nu,
		const Model &	model,
		const Motion &	velocity,
		const pinocchio::FrameIndex	id,
		const pinocchio::ReferenceFrame	type )

Member Function Documentation

ALIGATOR_DYNAMIC_TYPEDEFS()

template<typename _Scalar>

aligator::FrameVelocityResidualTpl< _Scalar >::ALIGATOR_DYNAMIC_TYPEDEFS

(

Scalar

)

ALIGATOR_UNARY_FUNCTION_INTERFACE()

template<typename _Scalar>

aligator::FrameVelocityResidualTpl< _Scalar >::ALIGATOR_UNARY_FUNCTION_INTERFACE

(

Scalar

)

getReference()

template<typename _Scalar>

ALIGATOR_DEPRECATED const Motion & aligator::FrameVelocityResidualTpl< _Scalar >::getReference ( ) const

inline

Definition at line 38 of file frame-velocity.hpp.

setReference()

template<typename _Scalar>

ALIGATOR_DEPRECATED void aligator::FrameVelocityResidualTpl< _Scalar >::setReference ( const Motion & v_new )

inline

Definition at line 39 of file frame-velocity.hpp.

evaluate()

template<typename _Scalar>

void aligator::FrameVelocityResidualTpl< _Scalar >::evaluate	(	const ConstVectorRef &	x,
		BaseData &	data ) const

computeJacobians()

template<typename _Scalar>

void aligator::FrameVelocityResidualTpl< _Scalar >::computeJacobians	(	const ConstVectorRef &	x,
		BaseData &	data ) const

createData()

template<typename _Scalar>

shared_ptr< BaseData > aligator::FrameVelocityResidualTpl< _Scalar >::createData ( ) const

inlinevirtual

Instantiate a Data object.

Reimplemented from aligator::StageFunctionTpl< _Scalar >.

Definition at line 44 of file frame-velocity.hpp.

Member Data Documentation

pin_model_

template<typename _Scalar>

Model aligator::FrameVelocityResidualTpl< _Scalar >::pin_model_

Definition at line 29 of file frame-velocity.hpp.

vref_

template<typename _Scalar>

Motion aligator::FrameVelocityResidualTpl< _Scalar >::vref_

Definition at line 30 of file frame-velocity.hpp.

type_

template<typename _Scalar>

pinocchio::ReferenceFrame aligator::FrameVelocityResidualTpl< _Scalar >::type_

Definition at line 31 of file frame-velocity.hpp.

---

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

• include/aligator/modelling/multibody/frame-velocity.hpp