ActivationModelAbstractTpl< _Scalar > Class Template Reference

Inheritance diagram for ActivationModelAbstractTpl< _Scalar >:

Public Types
typedef ActivationDataAbstractTpl< Scalar >	ActivationDataAbstract
typedef MathBaseTpl< Scalar >	MathBase
typedef MathBase::MatrixXs	MatrixXs
typedef MathBase::VectorXs	VectorXs

Public Member Functions
	ActivationModelAbstractTpl (const std::size_t nr)
virtual void	calc (const std::shared_ptr< ActivationDataAbstract > &data, const Eigen::Ref< const VectorXs > &r)=0
virtual void	calcDiff (const std::shared_ptr< ActivationDataAbstract > &data, const Eigen::Ref< const VectorXs > &r)=0
virtual std::shared_ptr< ActivationDataAbstract >	createData ()
std::size_t	get_nr () const
virtual void	print (std::ostream &os) const
	Print relevant information of the activation model.

Public Attributes
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar	Scalar

Protected Attributes
std::size_t	nr_

Friends
std::ostream &	operator<< (std::ostream &os, const ActivationModelAbstractTpl< Scalar > &model)
	Print information on the activation model.

Detailed Description

template<typename _Scalar>
class crocoddyl::ActivationModelAbstractTpl< _Scalar >

Definition at line 25 of file activation-base.hpp.

Member Typedef Documentation

MathBase

template<typename _Scalar>

typedef MathBaseTpl<Scalar> MathBase

Definition at line 30 of file activation-base.hpp.

ActivationDataAbstract

template<typename _Scalar>

typedef ActivationDataAbstractTpl<Scalar> ActivationDataAbstract

Definition at line 31 of file activation-base.hpp.

VectorXs

template<typename _Scalar>

typedef MathBase::VectorXs VectorXs

Definition at line 32 of file activation-base.hpp.

MatrixXs

template<typename _Scalar>

typedef MathBase::MatrixXs MatrixXs

Definition at line 33 of file activation-base.hpp.

Constructor & Destructor Documentation

ActivationModelAbstractTpl() [1/2]

template<typename _Scalar>

ActivationModelAbstractTpl ( const std::size_t nr )

inlineexplicit

Definition at line 35 of file activation-base.hpp.

ActivationModelAbstractTpl() [2/2]

template<typename _Scalar>

ActivationModelAbstractTpl ( )

inlineprotected

Definition at line 69 of file activation-base.hpp.

Member Function Documentation

calc()

template<typename _Scalar>

virtual void calc ( const std::shared_ptr< ActivationDataAbstract > & data, const Eigen::Ref< const VectorXs > & r )

pure virtual

Implemented in ActivationModel2NormBarrierTpl< _Scalar >, ActivationModel2NormBarrierTpl< double >, ActivationModelNumDiffTpl< _Scalar >, ActivationModelNumDiffTpl< double >, ActivationModelSmooth1NormTpl< _Scalar >, ActivationModelSmooth1NormTpl< double >, ActivationModelSmooth1NormTpl< Scalar >, ActivationModelSmooth2NormTpl< _Scalar >, and ActivationModelSmooth2NormTpl< double >.

calcDiff()

template<typename _Scalar>

virtual void calcDiff ( const std::shared_ptr< ActivationDataAbstract > & data, const Eigen::Ref< const VectorXs > & r )

pure virtual

Implemented in ActivationModel2NormBarrierTpl< _Scalar >, ActivationModel2NormBarrierTpl< double >, ActivationModelNumDiffTpl< _Scalar >, ActivationModelNumDiffTpl< double >, ActivationModelSmooth1NormTpl< _Scalar >, ActivationModelSmooth1NormTpl< double >, ActivationModelSmooth1NormTpl< Scalar >, ActivationModelSmooth2NormTpl< _Scalar >, and ActivationModelSmooth2NormTpl< double >.

createData()

template<typename _Scalar>

virtual std::shared_ptr< ActivationDataAbstract > createData ( )

inlinevirtual

Reimplemented in ActivationModel2NormBarrierTpl< _Scalar >, ActivationModel2NormBarrierTpl< double >, ActivationModelNumDiffTpl< _Scalar >, ActivationModelNumDiffTpl< double >, ActivationModelQuadFlatExpTpl< _Scalar >, ActivationModelQuadFlatExpTpl< double >, ActivationModelSmooth1NormTpl< _Scalar >, ActivationModelSmooth1NormTpl< double >, ActivationModelSmooth1NormTpl< Scalar >, ActivationModelSmooth2NormTpl< _Scalar >, and ActivationModelSmooth2NormTpl< double >.

Definition at line 42 of file activation-base.hpp.

get_nr()

template<typename _Scalar>

std::size_t get_nr ( ) const

inline

Definition at line 47 of file activation-base.hpp.

print()

template<typename _Scalar>

virtual void print ( std::ostream & os ) const

inlinevirtual

Print relevant information of the activation model.

Parameters

[out]

os

Output stream object

Reimplemented in ActivationModel2NormBarrierTpl< _Scalar >, ActivationModel2NormBarrierTpl< double >, ActivationModelQuadFlatExpTpl< _Scalar >, ActivationModelQuadFlatExpTpl< double >, ActivationModelQuadFlatLogTpl< _Scalar >, ActivationModelQuadFlatLogTpl< double >, ActivationModelQuadraticBarrierTpl< _Scalar >, ActivationModelQuadraticBarrierTpl< double >, ActivationModelQuadTpl< _Scalar >, ActivationModelQuadTpl< double >, ActivationModelQuadTpl< Scalar >, ActivationModelSmooth1NormTpl< _Scalar >, ActivationModelSmooth1NormTpl< double >, ActivationModelSmooth1NormTpl< Scalar >, ActivationModelSmooth2NormTpl< _Scalar >, ActivationModelSmooth2NormTpl< double >, ActivationModelWeightedQuadraticBarrierTpl< _Scalar >, ActivationModelWeightedQuadraticBarrierTpl< double >, ActivationModelWeightedQuadTpl< _Scalar >, and ActivationModelWeightedQuadTpl< double >.

Definition at line 63 of file activation-base.hpp.

Friends And Related Symbol Documentation

operator<<

template<typename _Scalar>

std::ostream & operator<< ( std::ostream & os, const ActivationModelAbstractTpl< Scalar > & model )

friend

Print information on the activation model.

Definition at line 52 of file activation-base.hpp.

Member Data Documentation

Scalar

template<typename _Scalar>

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar Scalar

Definition at line 29 of file activation-base.hpp.

nr_

template<typename _Scalar>

std::size_t nr_

protected

Definition at line 68 of file activation-base.hpp.

---

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

• /build/source/include/crocoddyl/core/activation-base.hpp