WPILibC++ 2023.4.3-108-ge5452e3
Eigen::TranspositionsWrapper< _IndicesType > Class Template Reference

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/Transpositions.h>

Inheritance diagram for Eigen::TranspositionsWrapper< _IndicesType >:
Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >

Public Types

typedef TranspositionsBase< TranspositionsWrapperBase
 
typedef Traits::IndicesType IndicesType
 
typedef IndicesType::Scalar StorageIndex
 
- Public Types inherited from Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >
typedef Traits::IndicesType IndicesType
 
typedef IndicesType::Scalar StorageIndex
 
typedef Eigen::Index Index
 

Public Member Functions

 TranspositionsWrapper (IndicesType &indices)
 
template<typename OtherDerived >
TranspositionsWrapperoperator= (const TranspositionsBase< OtherDerived > &other)
 Copies the other transpositions into *this. More...
 
EIGEN_DEVICE_FUNC const IndicesTypeindices () const
 const version of indices(). More...
 
EIGEN_DEVICE_FUNC IndicesTypeindices ()
 
- Public Member Functions inherited from Eigen::TranspositionsBase< TranspositionsWrapper< _IndicesType > >
EIGEN_DEVICE_FUNC TranspositionsWrapper< _IndicesType > & derived ()
 
EIGEN_DEVICE_FUNC const TranspositionsWrapper< _IndicesType > & derived () const
 
TranspositionsWrapper< _IndicesType > & operator= (const TranspositionsBase< OtherDerived > &other)
 Copies the other transpositions into *this. More...
 
EIGEN_DEVICE_FUNC Index size () const
 
EIGEN_DEVICE_FUNC Index rows () const
 
EIGEN_DEVICE_FUNC Index cols () const
 
EIGEN_DEVICE_FUNC const StorageIndexcoeff (Index i) const
 Direct access to the underlying index vector. More...
 
StorageIndexcoeffRef (Index i)
 Direct access to the underlying index vector. More...
 
const StorageIndexoperator() (Index i) const
 Direct access to the underlying index vector. More...
 
StorageIndexoperator() (Index i)
 Direct access to the underlying index vector. More...
 
const StorageIndexoperator[] (Index i) const
 Direct access to the underlying index vector. More...
 
StorageIndexoperator[] (Index i)
 Direct access to the underlying index vector. More...
 
EIGEN_DEVICE_FUNC const IndicesTypeindices () const
 const version of indices(). More...
 
EIGEN_DEVICE_FUNC IndicesTypeindices ()
 
void resize (Index newSize)
 Resizes to given size. More...
 
void setIdentity ()
 Sets *this to represents an identity transformation. More...
 
Transpose< TranspositionsBaseinverse () const
 
Transpose< TranspositionsBasetranspose () const
 

Protected Attributes

IndicesType::Nested m_indices
 

Member Typedef Documentation

◆ Base

template<typename _IndicesType >
typedef TranspositionsBase<TranspositionsWrapper> Eigen::TranspositionsWrapper< _IndicesType >::Base

◆ IndicesType

template<typename _IndicesType >
typedef Traits::IndicesType Eigen::TranspositionsWrapper< _IndicesType >::IndicesType

◆ StorageIndex

template<typename _IndicesType >
typedef IndicesType::Scalar Eigen::TranspositionsWrapper< _IndicesType >::StorageIndex

Constructor & Destructor Documentation

◆ TranspositionsWrapper()

template<typename _IndicesType >
Eigen::TranspositionsWrapper< _IndicesType >::TranspositionsWrapper ( IndicesType indices)
inlineexplicit

Member Function Documentation

◆ indices() [1/2]

template<typename _IndicesType >
EIGEN_DEVICE_FUNC IndicesType & Eigen::TranspositionsWrapper< _IndicesType >::indices ( )
inline
Returns
a reference to the stored array representing the transpositions.

◆ indices() [2/2]

template<typename _IndicesType >
EIGEN_DEVICE_FUNC const IndicesType & Eigen::TranspositionsWrapper< _IndicesType >::indices ( ) const
inline

const version of indices().

◆ operator=()

template<typename _IndicesType >
template<typename OtherDerived >
TranspositionsWrapper & Eigen::TranspositionsWrapper< _IndicesType >::operator= ( const TranspositionsBase< OtherDerived > &  other)
inline

Copies the other transpositions into *this.

Member Data Documentation

◆ m_indices

template<typename _IndicesType >
IndicesType::Nested Eigen::TranspositionsWrapper< _IndicesType >::m_indices
protected

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