Public Types | Public Member Functions | Private Types | List of all members
Eigen::TranspositionsBase< Derived > Class Template Reference

#include <Transpositions.h>

Public Types

typedef Eigen::Index Index
 
typedef Traits::IndicesType IndicesType
 
typedef IndicesType::Scalar StorageIndex
 

Public Member Functions

EIGEN_DEVICE_FUNC const StorageIndexcoeff (Index i) const
 
StorageIndexcoeffRef (Index i)
 
EIGEN_DEVICE_FUNC Index cols () const
 
EIGEN_DEVICE_FUNC Derived & derived ()
 
EIGEN_DEVICE_FUNC const Derived & derived () const
 
EIGEN_DEVICE_FUNC const IndicesTypeindices () const
 
EIGEN_DEVICE_FUNC IndicesTypeindices ()
 
Transpose< TranspositionsBaseinverse () const
 
const StorageIndexoperator() (Index i) const
 
StorageIndexoperator() (Index i)
 
template<typename OtherDerived >
Derived & operator= (const TranspositionsBase< OtherDerived > &other)
 
const StorageIndexoperator[] (Index i) const
 
StorageIndexoperator[] (Index i)
 
void resize (Index newSize)
 
EIGEN_DEVICE_FUNC Index rows () const
 
void setIdentity ()
 
EIGEN_DEVICE_FUNC Index size () const
 
Transpose< TranspositionsBasetranspose () const
 

Private Types

typedef internal::traits< Derived > Traits
 

Detailed Description

template<typename Derived>
class Eigen::TranspositionsBase< Derived >

Definition at line 16 of file Transpositions.h.

Member Typedef Documentation

◆ Index

template<typename Derived>
typedef Eigen::Index Eigen::TranspositionsBase< Derived >::Index
Deprecated:
since Eigen 3.3

Definition at line 24 of file Transpositions.h.

◆ IndicesType

template<typename Derived>
typedef Traits::IndicesType Eigen::TranspositionsBase< Derived >::IndicesType

Definition at line 22 of file Transpositions.h.

◆ StorageIndex

template<typename Derived>
typedef IndicesType::Scalar Eigen::TranspositionsBase< Derived >::StorageIndex

Definition at line 23 of file Transpositions.h.

◆ Traits

template<typename Derived>
typedef internal::traits<Derived> Eigen::TranspositionsBase< Derived >::Traits
private

Definition at line 18 of file Transpositions.h.

Member Function Documentation

◆ coeff()

template<typename Derived>
EIGEN_DEVICE_FUNC const StorageIndex& Eigen::TranspositionsBase< Derived >::coeff ( Index  i) const
inline

Direct access to the underlying index vector

Definition at line 51 of file Transpositions.h.

◆ coeffRef()

template<typename Derived>
StorageIndex& Eigen::TranspositionsBase< Derived >::coeffRef ( Index  i)
inline

Direct access to the underlying index vector

Definition at line 53 of file Transpositions.h.

◆ cols()

template<typename Derived>
EIGEN_DEVICE_FUNC Index Eigen::TranspositionsBase< Derived >::cols ( void  ) const
inline
Returns
the number of columns of the equivalent permutation matrix

Definition at line 47 of file Transpositions.h.

◆ derived() [1/2]

template<typename Derived>
EIGEN_DEVICE_FUNC Derived& Eigen::TranspositionsBase< Derived >::derived ( )
inline

Definition at line 27 of file Transpositions.h.

◆ derived() [2/2]

template<typename Derived>
EIGEN_DEVICE_FUNC const Derived& Eigen::TranspositionsBase< Derived >::derived ( ) const
inline

Definition at line 29 of file Transpositions.h.

◆ indices() [1/2]

template<typename Derived>
EIGEN_DEVICE_FUNC const IndicesType& Eigen::TranspositionsBase< Derived >::indices ( ) const
inline

const version of indices().

Definition at line 65 of file Transpositions.h.

◆ indices() [2/2]

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

Definition at line 68 of file Transpositions.h.

◆ inverse()

template<typename Derived>
Transpose<TranspositionsBase> Eigen::TranspositionsBase< Derived >::inverse ( ) const
inline
Returns
the inverse transformation

Definition at line 105 of file Transpositions.h.

◆ operator()() [1/2]

template<typename Derived>
const StorageIndex& Eigen::TranspositionsBase< Derived >::operator() ( Index  i) const
inline

Direct access to the underlying index vector

Definition at line 55 of file Transpositions.h.

◆ operator()() [2/2]

template<typename Derived>
StorageIndex& Eigen::TranspositionsBase< Derived >::operator() ( Index  i)
inline

Direct access to the underlying index vector

Definition at line 57 of file Transpositions.h.

◆ operator=()

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

Copies the other transpositions into *this

Definition at line 33 of file Transpositions.h.

◆ operator[]() [1/2]

template<typename Derived>
const StorageIndex& Eigen::TranspositionsBase< Derived >::operator[] ( Index  i) const
inline

Direct access to the underlying index vector

Definition at line 59 of file Transpositions.h.

◆ operator[]() [2/2]

template<typename Derived>
StorageIndex& Eigen::TranspositionsBase< Derived >::operator[] ( Index  i)
inline

Direct access to the underlying index vector

Definition at line 61 of file Transpositions.h.

◆ resize()

template<typename Derived>
void Eigen::TranspositionsBase< Derived >::resize ( Index  newSize)
inline

Resizes to given size.

Definition at line 71 of file Transpositions.h.

◆ rows()

template<typename Derived>
EIGEN_DEVICE_FUNC Index Eigen::TranspositionsBase< Derived >::rows ( void  ) const
inline
Returns
the number of rows of the equivalent permutation matrix

Definition at line 44 of file Transpositions.h.

◆ setIdentity()

template<typename Derived>
void Eigen::TranspositionsBase< Derived >::setIdentity ( )
inline

Sets *this to represents an identity transformation

Definition at line 77 of file Transpositions.h.

◆ size()

template<typename Derived>
EIGEN_DEVICE_FUNC Index Eigen::TranspositionsBase< Derived >::size ( ) const
inline
Returns
the number of transpositions

Definition at line 41 of file Transpositions.h.

◆ transpose()

template<typename Derived>
Transpose<TranspositionsBase> Eigen::TranspositionsBase< Derived >::transpose ( ) const
inline
Returns
the tranpose transformation

Definition at line 109 of file Transpositions.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:44:18