Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
pinocchio::ForceRef< Vector6ArgType > Class Template Reference

#include <force-ref.hpp>

Inheritance diagram for pinocchio::ForceRef< Vector6ArgType >:
Inheritance graph
[legend]

Public Types

typedef traits< ForceRef >::DataRefType DataRefType
 
- Public Types inherited from pinocchio::ForceDense< ForceRef< Vector6ArgType > >
typedef ForceBase< ForceRef< Vector6ArgType > > Base
 
typedef traits< ForceRef< Vector6ArgType > >::ForceRefType ForceRefType
 

Public Member Functions

ConstAngularType angular_impl () const
 
AngularType angular_impl ()
 
template<typename V3 >
void angular_impl (const Eigen::MatrixBase< V3 > &w)
 
 FORCE_TYPEDEF_TPL (ForceRef)
 
 ForceRef (typename PINOCCHIO_EIGEN_REF_TYPE(Vector6ArgType) f_like)
 Default constructor from a 6 dimensional vector. More...
 
 ForceRef (const ForceRef &other)
 Copy constructor from another ForceRef. More...
 
ConstLinearType linear_impl () const
 
LinearType linear_impl ()
 
template<typename V3 >
void linear_impl (const Eigen::MatrixBase< V3 > &v)
 
ForceRefref ()
 
ToVectorConstReturnType toVector_impl () const
 
ToVectorReturnType toVector_impl ()
 
- Public Member Functions inherited from pinocchio::ForceDense< ForceRef< Vector6ArgType > >
ForcePlain __div__ (const OtherScalar &alpha) const
 
ForceRef< Vector6ArgType > & __mequ__ (const ForceDense< M1 > &v)
 
ForcePlain __minus__ (const ForceDense< M1 > &v) const
 
ForcePlain __mult__ (const OtherScalar &alpha) const
 
ForcePlain __opposite__ () const
 
ForceRef< Vector6ArgType > & __pequ__ (const ForceDense< M1 > &v)
 
ForcePlain __plus__ (const ForceDense< M1 > &v) const
 
void disp_impl (std::ostream &os) const
 
Scalar dot (const MotionDense< F1 > &phi) const
 
 FORCE_TYPEDEF_TPL (ForceRef< Vector6ArgType >)
 
bool isApprox (const ForceDense< M2 > &f, const Scalar &prec=Eigen::NumTraits< Scalar >::dummy_precision()) const
 
bool isApprox_impl (const ForceDense< D2 > &f, const Scalar &prec=Eigen::NumTraits< Scalar >::dummy_precision()) const
 
bool isEqual_impl (const ForceDense< D2 > &other) const
 
bool isEqual_impl (const ForceBase< D2 > &other) const
 
bool isZero_impl (const Scalar &prec=Eigen::NumTraits< Scalar >::dummy_precision()) const
 
void motionAction (const MotionDense< M1 > &v, ForceDense< M2 > &fout) const
 
ForcePlain motionAction (const MotionDense< M1 > &v) const
 
ForcePlain operator+ (const ForceDense< F1 > &f) const
 
ForceRef< Vector6ArgType > & operator+= (const ForceDense< F1 > &f)
 
ForceRef< Vector6ArgType > & operator+= (const ForceBase< F1 > &f)
 
ForcePlain operator- () const
 
ForcePlain operator- (const ForceDense< F1 > &f) const
 
ForceRef< Vector6ArgType > & operator-= (const ForceDense< M1 > &v)
 
ForceRef< Vector6ArgType > & operator= (const ForceDense< D2 > &other)
 
ForceRef< Vector6ArgType > & operator= (const Eigen::MatrixBase< V6 > &v)
 
ForceRefType ref ()
 
void se3Action_impl (const SE3Tpl< S2, O2 > &m, ForceDense< D2 > &f) const
 
ForcePlain se3Action_impl (const SE3Tpl< S2, O2 > &m) const
 
void se3ActionInverse_impl (const SE3Tpl< S2, O2 > &m, ForceDense< D2 > &f) const
 
ForcePlain se3ActionInverse_impl (const SE3Tpl< S2, O2 > &m) const
 
ForceRef< Vector6ArgType > & setFrom (const ForceDense< D2 > &other)
 
ForceRef< Vector6ArgType > & setRandom ()
 
ForceRef< Vector6ArgType > & setZero ()
 
- Public Member Functions inherited from pinocchio::ForceBase< Derived >
ConstAngularType angular () const
 Return the angular part of the force vector. More...
 
AngularType angular ()
 Return the angular part of the force vector. More...
 
template<typename V3Like >
void angular (const Eigen::MatrixBase< V3Like > &n)
 Set the angular part of the force vector. More...
 
Derived & derived ()
 
const Derived & derived () const
 
void disp (std::ostream &os) const
 
template<typename MotionDerived >
Scalar dot (const MotionDense< MotionDerived > &m) const
 
 FORCE_TYPEDEF_TPL (Derived)
 
bool isApprox (const Derived &other, const Scalar &prec=Eigen::NumTraits< Scalar >::dummy_precision()) const
 
bool isZero (const Scalar &prec=Eigen::NumTraits< Scalar >::dummy_precision()) const
 
ConstLinearType linear () const
 Return the linear part of the force vector. More...
 
LinearType linear ()
 Return the linear part of the force vector. More...
 
template<typename V3Like >
void linear (const Eigen::MatrixBase< V3Like > &f)
 Set the linear part of the force vector. More...
 
template<typename M1 >
MotionAlgebraAction< Derived, M1 >::ReturnType motionAction (const MotionDense< M1 > &v) const
 
 operator Vector6 () const
 
template<typename F2 >
bool operator!= (const ForceBase< F2 > &other) const
 
template<typename OtherScalar >
ForcePlain operator* (const OtherScalar &alpha) const
 
Derived operator+ (const ForceBase< Derived > &phi) const
 
Derived & operator+= (const ForceBase< Derived > &phi)
 Replaces *this by *this + other. More...
 
Derived operator- () const
 
Derived operator- (const ForceBase< Derived > &phi) const
 
Derived & operator-= (const ForceBase< Derived > &phi)
 Replaces *this by *this - other. More...
 
template<typename OtherScalar >
ForcePlain operator/ (const OtherScalar &alpha) const
 
Derived & operator= (const ForceBase< Derived > &other)
 Copies the Derived Force into *this. More...
 
template<typename F2 >
bool operator== (const ForceBase< F2 > &other) const
 
template<typename S2 , int O2>
SE3GroupAction< Derived >::ReturnType se3Action (const SE3Tpl< S2, O2 > &m) const
 Transform from A to B coordinates the Force represented by *this such that

\begin{equation*} {}^{B}f = {}^{B}X_A^* * {}^{A}f \end{equation*}

. More...

 
template<typename S2 , int O2>
SE3GroupAction< Derived >::ReturnType se3ActionInverse (const SE3Tpl< S2, O2 > &m) const
 Transform from B to A coordinates the Force represented by *this such that

\begin{equation*} {}^{A}f = {}^{A}X_B^* * {}^{A}f \end{equation*}

. More...

 
ToVectorConstReturnType toVector () const
 Return the force as an Eigen vector. More...
 
ToVectorReturnType toVector ()
 Return the force as an Eigen vector. More...
 

Public Attributes

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef ForceDense< ForceRefBase
 

Protected Attributes

DataRefType m_ref
 

Detailed Description

template<typename Vector6ArgType>
class pinocchio::ForceRef< Vector6ArgType >

Definition at line 52 of file force-ref.hpp.

Member Typedef Documentation

◆ DataRefType

template<typename Vector6ArgType>
typedef traits<ForceRef>::DataRefType pinocchio::ForceRef< Vector6ArgType >::DataRefType

Definition at line 57 of file force-ref.hpp.

Constructor & Destructor Documentation

◆ ForceRef() [1/2]

template<typename Vector6ArgType>
pinocchio::ForceRef< Vector6ArgType >::ForceRef ( typename PINOCCHIO_EIGEN_REF_TYPE(Vector6ArgType)  f_like)
inline

Default constructor from a 6 dimensional vector.

Definition at line 65 of file force-ref.hpp.

◆ ForceRef() [2/2]

template<typename Vector6ArgType>
pinocchio::ForceRef< Vector6ArgType >::ForceRef ( const ForceRef< Vector6ArgType > &  other)
inline

Copy constructor from another ForceRef.

Definition at line 74 of file force-ref.hpp.

Member Function Documentation

◆ angular_impl() [1/3]

template<typename Vector6ArgType>
ConstAngularType pinocchio::ForceRef< Vector6ArgType >::angular_impl ( ) const
inline

Definition at line 82 of file force-ref.hpp.

◆ angular_impl() [2/3]

template<typename Vector6ArgType>
AngularType pinocchio::ForceRef< Vector6ArgType >::angular_impl ( )
inline

Definition at line 84 of file force-ref.hpp.

◆ angular_impl() [3/3]

template<typename Vector6ArgType>
template<typename V3 >
void pinocchio::ForceRef< Vector6ArgType >::angular_impl ( const Eigen::MatrixBase< V3 > &  w)
inline

Definition at line 88 of file force-ref.hpp.

◆ FORCE_TYPEDEF_TPL()

template<typename Vector6ArgType>
pinocchio::ForceRef< Vector6ArgType >::FORCE_TYPEDEF_TPL ( ForceRef< Vector6ArgType >  )

◆ linear_impl() [1/3]

template<typename Vector6ArgType>
ConstLinearType pinocchio::ForceRef< Vector6ArgType >::linear_impl ( ) const
inline

Definition at line 83 of file force-ref.hpp.

◆ linear_impl() [2/3]

template<typename Vector6ArgType>
LinearType pinocchio::ForceRef< Vector6ArgType >::linear_impl ( )
inline

Definition at line 85 of file force-ref.hpp.

◆ linear_impl() [3/3]

template<typename Vector6ArgType>
template<typename V3 >
void pinocchio::ForceRef< Vector6ArgType >::linear_impl ( const Eigen::MatrixBase< V3 > &  v)
inline

Definition at line 95 of file force-ref.hpp.

◆ ref()

template<typename Vector6ArgType>
ForceRef& pinocchio::ForceRef< Vector6ArgType >::ref ( )
inline

Definition at line 101 of file force-ref.hpp.

◆ toVector_impl() [1/2]

template<typename Vector6ArgType>
ToVectorConstReturnType pinocchio::ForceRef< Vector6ArgType >::toVector_impl ( ) const
inline

Definition at line 78 of file force-ref.hpp.

◆ toVector_impl() [2/2]

template<typename Vector6ArgType>
ToVectorReturnType pinocchio::ForceRef< Vector6ArgType >::toVector_impl ( )
inline

Definition at line 79 of file force-ref.hpp.

Member Data Documentation

◆ Base

template<typename Vector6ArgType>
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef ForceDense<ForceRef> pinocchio::ForceRef< Vector6ArgType >::Base

Definition at line 56 of file force-ref.hpp.

◆ m_ref

template<typename Vector6ArgType>
DataRefType pinocchio::ForceRef< Vector6ArgType >::m_ref
protected

Definition at line 104 of file force-ref.hpp.


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


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