Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl > Class Template Reference

#include <fwd.hpp>

Public Types

enum  { Options = _Options }
 
typedef DataTpl< Scalar, Options, JointCollectionTpl > Data
 
typedef std::vector< Data, Eigen::aligned_allocator< Data > > DataVector
 
typedef ModelTpl< Scalar, Options, JointCollectionTpl > Model
 
typedef std::vector< Model, Eigen::aligned_allocator< Model > > ModelVector
 

Public Member Functions

Data & getData (const size_t index)
 Returns a specific data. More...
 
const Data & getData (const size_t index) const
 Return a specific data. More...
 
DataVector & getDatas ()
 Returns the data vector. More...
 
const DataVector & getDatas () const
 Returns the data vector. More...
 
Model & getModel (const size_t index)
 Returns a specific model. More...
 
const Model & getModel (const size_t index) const
 Return a specific model. More...
 
ModelVector & getModels ()
 Returns the vector of models. More...
 
const ModelVector & getModels () const
 Returns the vector of models. More...
 
 ModelPoolTpl (const Model &model, const size_t pool_size=(size_t) omp_get_max_threads())
 Default constructor from a model and a pool size. More...
 
 ModelPoolTpl (const ModelPoolTpl &pool)
 Copy constructor from an other PoolModel. More...
 
void resize (const size_t new_size)
 Set the size of the pool and perform the appropriate resize. More...
 
size_t size () const
 Returns the size of the pool. More...
 
void update (const Data &data)
 Update all the datas with the input data value. More...
 
virtual ~ModelPoolTpl ()
   More...
 

Public Attributes

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar Scalar
 

Protected Member Functions

virtual void doResize (const size_t new_size)
   More...
 

Protected Attributes

DataVector m_datas
   More...
 
ModelVector m_models
   More...
 

Detailed Description

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
class pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >

Definition at line 17 of file multibody/pool/fwd.hpp.

Member Typedef Documentation

◆ Data

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
typedef DataTpl<Scalar, Options, JointCollectionTpl> pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::Data

Definition at line 31 of file multibody/pool/model.hpp.

◆ DataVector

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
typedef std::vector<Data, Eigen::aligned_allocator<Data> > pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::DataVector

Definition at line 34 of file multibody/pool/model.hpp.

◆ Model

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
typedef ModelTpl<Scalar, Options, JointCollectionTpl> pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::Model

Definition at line 30 of file multibody/pool/model.hpp.

◆ ModelVector

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
typedef std::vector<Model, Eigen::aligned_allocator<Model> > pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::ModelVector

Definition at line 33 of file multibody/pool/model.hpp.

Member Enumeration Documentation

◆ anonymous enum

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
anonymous enum
Enumerator
Options 

Definition at line 25 of file multibody/pool/model.hpp.

Constructor & Destructor Documentation

◆ ModelPoolTpl() [1/2]

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::ModelPoolTpl ( const Model &  model,
const size_t  pool_size = (size_t)omp_get_max_threads() 
)
inlineexplicit

Default constructor from a model and a pool size.

Parameters
[in]modelinput model used for parallel computations.
[in]pool_sizetotal size of the pool.

Definition at line 41 of file multibody/pool/model.hpp.

◆ ModelPoolTpl() [2/2]

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::ModelPoolTpl ( const ModelPoolTpl< _Scalar, _Options, JointCollectionTpl > &  pool)
inline

Copy constructor from an other PoolModel.

Parameters
[in]pool_modelPoolModel to copy.

Definition at line 52 of file multibody/pool/model.hpp.

◆ ~ModelPoolTpl()

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
virtual pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::~ModelPoolTpl ( )
inlinevirtual

 

Destructor

Definition at line 151 of file multibody/pool/model.hpp.

Member Function Documentation

◆ doResize()

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
virtual void pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::doResize ( const size_t  new_size)
inlineprotectedvirtual

 

Method to implement in the derived classes.

Definition at line 161 of file multibody/pool/model.hpp.

◆ getData() [1/2]

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
Data& pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::getData ( const size_t  index)
inline

Returns a specific data.

Definition at line 143 of file multibody/pool/model.hpp.

◆ getData() [2/2]

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
const Data& pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::getData ( const size_t  index) const
inline

Return a specific data.

Definition at line 135 of file multibody/pool/model.hpp.

◆ getDatas() [1/2]

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
DataVector& pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::getDatas ( )
inline

Returns the data vector.

Definition at line 129 of file multibody/pool/model.hpp.

◆ getDatas() [2/2]

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
const DataVector& pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::getDatas ( ) const
inline

Returns the data vector.

Definition at line 123 of file multibody/pool/model.hpp.

◆ getModel() [1/2]

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
Model& pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::getModel ( const size_t  index)
inline

Returns a specific model.

Definition at line 115 of file multibody/pool/model.hpp.

◆ getModel() [2/2]

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
const Model& pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::getModel ( const size_t  index) const
inline

Return a specific model.

Definition at line 107 of file multibody/pool/model.hpp.

◆ getModels() [1/2]

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
ModelVector& pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::getModels ( )
inline

Returns the vector of models.

Definition at line 101 of file multibody/pool/model.hpp.

◆ getModels() [2/2]

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
const ModelVector& pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::getModels ( ) const
inline

Returns the vector of models.

Definition at line 95 of file multibody/pool/model.hpp.

◆ resize()

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
void pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::resize ( const size_t  new_size)
inline

Set the size of the pool and perform the appropriate resize.

Definition at line 74 of file multibody/pool/model.hpp.

◆ size()

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
size_t pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::size ( ) const
inline

Returns the size of the pool.

Definition at line 68 of file multibody/pool/model.hpp.

◆ update()

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
void pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::update ( const Data &  data)
inline

Update all the datas with the input data value.

 

Parameters
[in]datanew value to use and to copy within the vector of data.

Definition at line 62 of file multibody/pool/model.hpp.

Member Data Documentation

◆ m_datas

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
DataVector pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::m_datas
protected

 

Vector of data elements

Definition at line 158 of file multibody/pool/model.hpp.

◆ m_models

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
ModelVector pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::m_models
protected

 

Vector of model

Definition at line 151 of file multibody/pool/model.hpp.

◆ Scalar

template<typename _Scalar , int _Options, template< typename, int > class JointCollectionTpl>
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::Scalar

Definition at line 24 of file multibody/pool/model.hpp.

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

pinocchio
Author(s):
autogenerated on Wed May 28 2025 02:41:25