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 <model.hpp>

Inheritance diagram for pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >:
Inheritance graph
[legend]

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

const Datadata (const size_t index) const
 Return a specific data. More...
 
Datadata (const size_t index)
 Returns a specific data. More...
 
const DataVectordatas () const
 Returns the data vectors. More...
 
DataVectordatas ()
 Returns the data vectors. More...
 
const Modelmodel () const
 Returns the model stored within the pool. More...
 
Modelmodel ()
 Returns the model stored within the pool. More...
 
 ModelPoolTpl (const Model &model, const int pool_size=omp_get_max_threads())
 Default constructor from a model and a pool size. More...
 
 ModelPoolTpl (const ModelPoolTpl &pool_model)
 Copy constructor from an other PoolModel. More...
 
void resize (const int new_size)
 Set the size of the pool and perform the appropriate resize. More...
 
int size () const
 Returns the size of the pool. More...
 
void update (const Model &model)
 Update the model, meaning that all the datas will be refreshed accordingly. More...
 
void update (const Data &data)
 Update all the datas with the input data value. More...
 
void update (const Model &model, const Data &data)
 Update the model and data with the new input values. In this case, all the geometry_datas will be replaced. More...
 
virtual ~ModelPoolTpl ()
  . More...
 

Public Attributes

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar Scalar
 

Protected Member Functions

virtual void do_resize (const int new_size)
  . More...
 

Protected Attributes

DataVector m_datas
  . More...
 
Model m_model
 Model stored within the pool. More...
 
int m_size
 Number of threads used for parallel computations. More...
 

Detailed Description

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

Definition at line 19 of file src/multibody/pool/model.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 29 of file src/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 32 of file src/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 28 of file src/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 31 of file src/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 26 of file src/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 int  pool_size = 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 39 of file src/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_model)
inline

Copy constructor from an other PoolModel.

Parameters
[in]pool_modelPoolModel to copy.

Definition at line 50 of file src/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 135 of file src/multibody/pool/model.hpp.

Member Function Documentation

◆ data() [1/2]

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

Return a specific data.

Definition at line 119 of file src/multibody/pool/model.hpp.

◆ data() [2/2]

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

Returns a specific data.

Definition at line 127 of file src/multibody/pool/model.hpp.

◆ datas() [1/2]

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

Returns the data vectors.

Definition at line 113 of file src/multibody/pool/model.hpp.

◆ datas() [2/2]

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

Returns the data vectors.

Definition at line 116 of file src/multibody/pool/model.hpp.

◆ do_resize()

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

 .

Method to implement in the derived classes.

Reimplemented in pinocchio::GeometryPoolTpl< _Scalar, _Options, JointCollectionTpl >.

Definition at line 149 of file src/multibody/pool/model.hpp.

◆ model() [1/2]

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

Returns the model stored within the pool.

Definition at line 57 of file src/multibody/pool/model.hpp.

◆ model() [2/2]

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

Returns the model stored within the pool.

Definition at line 60 of file src/multibody/pool/model.hpp.

◆ resize()

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

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

Definition at line 99 of file src/multibody/pool/model.hpp.

◆ size()

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

Returns the size of the pool.

Definition at line 96 of file src/multibody/pool/model.hpp.

◆ update() [1/3]

template<typename _Scalar, int _Options, template< typename, int > class JointCollectionTpl>
void pinocchio::ModelPoolTpl< _Scalar, _Options, JointCollectionTpl >::update ( const Model model)
inline

Update the model, meaning that all the datas will be refreshed accordingly.

 

Parameters
[in]modelnew model value.

Definition at line 66 of file src/multibody/pool/model.hpp.

◆ update() [2/3]

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 76 of file src/multibody/pool/model.hpp.

◆ update() [3/3]

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

Update the model and data with the new input values. In this case, all the geometry_datas will be replaced.

Parameters
[in]geometry_modelnew geometry model value.
[in]geometry_datanew geometry data value

Definition at line 88 of file src/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 143 of file src/multibody/pool/model.hpp.

◆ m_model

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

Model stored within the pool.

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

◆ m_size

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

Number of threads used for parallel computations.

Definition at line 146 of file src/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 25 of file src/multibody/pool/model.hpp.


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


pinocchio
Author(s):
autogenerated on Fri Jun 23 2023 02:38:35