Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
Eigen::SkylineMatrixBase< Derived > Class Template Reference

Base class of any skyline matrices or skyline expressions. More...

#include <SkylineMatrixBase.h>

Inheritance diagram for Eigen::SkylineMatrixBase< Derived >:
Inheritance graph
[legend]

Public Types

enum  {
  RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, SizeAtCompileTime, MaxRowsAtCompileTime = RowsAtCompileTime,
  MaxColsAtCompileTime = ColsAtCompileTime, MaxSizeAtCompileTime, IsVectorAtCompileTime = RowsAtCompileTime == 1 || ColsAtCompileTime == 1, Flags = internal::traits<Derived>::Flags,
  CoeffReadCost = internal::traits<Derived>::CoeffReadCost, IsRowMajor = Flags & RowMajorBit ? 1 : 0
}
 
typedef internal::index< StorageKind >::type Index
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef internal::traits< Derived >::Scalar Scalar
 
typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime) > SquareMatrixType
 
typedef internal::traits< Derived >::StorageKind StorageKind
 
- Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
 The interface type of indices. More...
 
typedef internal::traits< Derived >::StorageKind StorageKind
 

Public Member Functions

template<typename OtherDerived >
void assignGeneric (const OtherDerived &other)
 
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
Derived & const_cast_derived () const
 
const Derived & derived () const
 
Derived & derived ()
 
EIGEN_STRONG_INLINE const internal::eval< Derived, IsSkyline >::type eval () const
 
template<typename DenseDerived >
void evalTo (MatrixBase< DenseDerived > &dst) const
 
Index innerSize () const
 
bool isRValue () const
 
Derived & markAsRValue ()
 
Index nonZeros () const
 
template<typename OtherDerived >
const SkylineProductReturnType< Derived, OtherDerived >::Type operator* (const MatrixBase< OtherDerived > &other) const
 
template<typename OtherDerived >
EIGEN_STRONG_INLINE const SkylineProductReturnType< Derived, OtherDerived >::Type operator* (const MatrixBase< OtherDerived > &other) const
 
Derived & operator= (const Derived &other)
 
template<typename OtherDerived >
Derived & operator= (const SkylineMatrixBase< OtherDerived > &other)
 
template<typename Lhs , typename Rhs >
Derived & operator= (const SkylineProduct< Lhs, Rhs, SkylineTimeSkylineProduct > &product)
 
Index outerSize () const
 
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 
 SkylineMatrixBase ()
 
Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTimetoDense () const
 
- Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void addTo (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void applyThisOnTheLeft (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void applyThisOnTheRight (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC Derived & const_cast_derived () const
 
EIGEN_DEVICE_FUNC const Derived & const_derived () const
 
EIGEN_DEVICE_FUNC Derived & derived ()
 
EIGEN_DEVICE_FUNC const Derived & derived () const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 
template<typename Dest >
EIGEN_DEVICE_FUNC void subTo (Dest &dst) const
 

Protected Attributes

bool m_isRValue
 

Friends

std::ostream & operator<< (std::ostream &s, const SkylineMatrixBase &m)
 

Detailed Description

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

Base class of any skyline matrices or skyline expressions.

Parameters
Derived

Definition at line 26 of file SkylineMatrixBase.h.

Member Typedef Documentation

◆ Index

template<typename Derived>
typedef internal::index<StorageKind>::type Eigen::SkylineMatrixBase< Derived >::Index

Definition at line 31 of file SkylineMatrixBase.h.

◆ RealScalar

template<typename Derived>
typedef NumTraits<Scalar>::Real Eigen::SkylineMatrixBase< Derived >::RealScalar

This is the "real scalar" type; if the Scalar type is already real numbers (e.g. int, float or double) then RealScalar is just the same as Scalar. If Scalar is std::complex<T> then RealScalar is T.

See also
class NumTraits

Definition at line 85 of file SkylineMatrixBase.h.

◆ Scalar

template<typename Derived>
typedef internal::traits<Derived>::Scalar Eigen::SkylineMatrixBase< Derived >::Scalar

Definition at line 29 of file SkylineMatrixBase.h.

◆ SquareMatrixType

type of the equivalent square matrix

Definition at line 89 of file SkylineMatrixBase.h.

◆ StorageKind

template<typename Derived>
typedef internal::traits<Derived>::StorageKind Eigen::SkylineMatrixBase< Derived >::StorageKind

Definition at line 30 of file SkylineMatrixBase.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename Derived>
anonymous enum
Enumerator
RowsAtCompileTime 

The number of rows at compile-time. This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant.

See also
MatrixBase::rows(), MatrixBase::cols(), ColsAtCompileTime, SizeAtCompileTime
ColsAtCompileTime 

The number of columns at compile-time. This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant.

See also
MatrixBase::rows(), MatrixBase::cols(), RowsAtCompileTime, SizeAtCompileTime
SizeAtCompileTime 

This is equal to the number of coefficients, i.e. the number of rows times the number of columns, or to Dynamic if this is not known at compile-time.

See also
RowsAtCompileTime, ColsAtCompileTime
MaxRowsAtCompileTime 
MaxColsAtCompileTime 
MaxSizeAtCompileTime 
IsVectorAtCompileTime 

This is set to true if either the number of rows or the number of columns is known at compile-time to be equal to 1. Indeed, in that case, we are dealing with a column-vector (if there is only one column) or with a row-vector (if there is only one row).

Flags 

This stores expression Flags flags which may or may not be inherited by new expressions constructed from this one. See the list of flags.

CoeffReadCost 

This is a rough measure of how expensive it is to read one coefficient from this expression.

IsRowMajor 

Definition at line 33 of file SkylineMatrixBase.h.

Constructor & Destructor Documentation

◆ SkylineMatrixBase()

template<typename Derived>
Eigen::SkylineMatrixBase< Derived >::SkylineMatrixBase ( )
inline

Definition at line 147 of file SkylineMatrixBase.h.

Member Function Documentation

◆ assignGeneric()

template<typename Derived>
template<typename OtherDerived >
void Eigen::SkylineMatrixBase< Derived >::assignGeneric ( const OtherDerived &  other)
inline

Definition at line 157 of file SkylineMatrixBase.h.

◆ cols()

template<typename Derived>
EIGEN_CONSTEXPR Index Eigen::SkylineMatrixBase< Derived >::cols ( void  ) const
inline
Returns
the number of columns.
See also
rows(), ColsAtCompileTime

Definition at line 110 of file SkylineMatrixBase.h.

◆ const_cast_derived()

template<typename Derived>
Derived& Eigen::SkylineMatrixBase< Derived >::const_cast_derived ( ) const
inline

Definition at line 99 of file SkylineMatrixBase.h.

◆ derived() [1/2]

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

Definition at line 91 of file SkylineMatrixBase.h.

◆ derived() [2/2]

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

Definition at line 95 of file SkylineMatrixBase.h.

◆ eval()

template<typename Derived>
EIGEN_STRONG_INLINE const internal::eval<Derived, IsSkyline>::type Eigen::SkylineMatrixBase< Derived >::eval ( ) const
inline
Returns
the matrix or vector obtained by evaluating this expression.

Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy.

Definition at line 202 of file SkylineMatrixBase.h.

◆ evalTo()

template<typename Derived>
template<typename DenseDerived >
void Eigen::SkylineMatrixBase< Derived >::evalTo ( MatrixBase< DenseDerived > &  dst) const
inline

Definition at line 186 of file SkylineMatrixBase.h.

◆ innerSize()

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::innerSize ( ) const
inline
Returns
the size of the inner dimension according to the storage order, i.e., the number of rows for a columns major matrix, and the number of cols otherwise

Definition at line 134 of file SkylineMatrixBase.h.

◆ isRValue()

template<typename Derived>
bool Eigen::SkylineMatrixBase< Derived >::isRValue ( ) const
inline

Definition at line 138 of file SkylineMatrixBase.h.

◆ markAsRValue()

template<typename Derived>
Derived& Eigen::SkylineMatrixBase< Derived >::markAsRValue ( )
inline

Definition at line 142 of file SkylineMatrixBase.h.

◆ nonZeros()

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::nonZeros ( ) const
inline
Returns
the number of nonzero coefficients which is in practice the number of stored coefficients.

Definition at line 122 of file SkylineMatrixBase.h.

◆ operator*() [1/2]

template<typename Derived>
template<typename OtherDerived >
const SkylineProductReturnType<Derived, OtherDerived>::Type Eigen::SkylineMatrixBase< Derived >::operator* ( const MatrixBase< OtherDerived > &  other) const

◆ operator*() [2/2]

template<typename Derived>
template<typename OtherDerived >
EIGEN_STRONG_INLINE const SkylineProductReturnType<Derived, OtherDerived>::Type Eigen::SkylineMatrixBase< Derived >::operator* ( const MatrixBase< OtherDerived > &  other) const

Definition at line 288 of file SkylineProduct.h.

◆ operator=() [1/3]

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

Definition at line 151 of file SkylineMatrixBase.h.

◆ operator=() [2/3]

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

Definition at line 168 of file SkylineMatrixBase.h.

◆ operator=() [3/3]

template<typename Derived>
template<typename Lhs , typename Rhs >
Derived& Eigen::SkylineMatrixBase< Derived >::operator= ( const SkylineProduct< Lhs, Rhs, SkylineTimeSkylineProduct > &  product)
inline

◆ outerSize()

template<typename Derived>
Index Eigen::SkylineMatrixBase< Derived >::outerSize ( ) const
inline
Returns
the size of the storage major dimension, i.e., the number of columns for a columns major matrix, and the number of rows otherwise

Definition at line 128 of file SkylineMatrixBase.h.

◆ rows()

template<typename Derived>
EIGEN_CONSTEXPR Index Eigen::SkylineMatrixBase< Derived >::rows ( void  ) const
inline
Returns
the number of rows.
See also
cols(), RowsAtCompileTime

Definition at line 105 of file SkylineMatrixBase.h.

◆ size()

template<typename Derived>
EIGEN_CONSTEXPR Index Eigen::SkylineMatrixBase< Derived >::size ( ) const
inline
Returns
the number of coefficients, which is rows()*cols().
See also
rows(), cols(), SizeAtCompileTime.

Definition at line 116 of file SkylineMatrixBase.h.

◆ toDense()

template<typename Derived>
Matrix<Scalar, RowsAtCompileTime, ColsAtCompileTime> Eigen::SkylineMatrixBase< Derived >::toDense ( ) const
inline

Definition at line 193 of file SkylineMatrixBase.h.

Friends And Related Function Documentation

◆ operator<<

template<typename Derived>
std::ostream& operator<< ( std::ostream &  s,
const SkylineMatrixBase< Derived > &  m 
)
friend

Definition at line 175 of file SkylineMatrixBase.h.

Member Data Documentation

◆ m_isRValue

template<typename Derived>
bool Eigen::SkylineMatrixBase< Derived >::m_isRValue
protected

Definition at line 207 of file SkylineMatrixBase.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:43:13