MOAB  4.9.3pre
Eigen::DiagonalBase< Derived > Class Template Reference

#include <DiagonalMatrix.h>

Inheritance diagram for Eigen::DiagonalBase< Derived >:
Collaboration diagram for Eigen::DiagonalBase< Derived >:

List of all members.

Public Types

enum  {
  RowsAtCompileTime = DiagonalVectorType::SizeAtCompileTime, ColsAtCompileTime = DiagonalVectorType::SizeAtCompileTime, MaxRowsAtCompileTime = DiagonalVectorType::MaxSizeAtCompileTime, MaxColsAtCompileTime = DiagonalVectorType::MaxSizeAtCompileTime,
  IsVectorAtCompileTime = 0, Flags = NoPreferredStorageOrderBit
}
typedef internal::traits
< Derived >
::DiagonalVectorType 
DiagonalVectorType
typedef DiagonalVectorType::Scalar Scalar
typedef
DiagonalVectorType::RealScalar 
RealScalar
typedef internal::traits
< Derived >::StorageKind 
StorageKind
typedef internal::traits
< Derived >::StorageIndex 
StorageIndex
typedef Matrix< Scalar,
RowsAtCompileTime,
ColsAtCompileTime,
0, MaxRowsAtCompileTime,
MaxColsAtCompileTime
DenseMatrixType
typedef DenseMatrixType DenseType
typedef DiagonalMatrix< Scalar,
DiagonalVectorType::SizeAtCompileTime,
DiagonalVectorType::MaxSizeAtCompileTime > 
PlainObject
typedef DiagonalWrapper< const
CwiseUnaryOp
< internal::scalar_inverse_op
< Scalar >, const
DiagonalVectorType > > 
InverseReturnType
typedef DiagonalWrapper< const
CwiseUnaryOp
< internal::scalar_multiple_op
< Scalar >, const
DiagonalVectorType > > 
ScalarMultipleReturnType

Public Member Functions

EIGEN_DEVICE_FUNC const Derived & derived () const
EIGEN_DEVICE_FUNC Derived & derived ()
EIGEN_DEVICE_FUNC DenseMatrixType toDenseMatrix () const
EIGEN_DEVICE_FUNC const
DiagonalVectorType
diagonal () const
EIGEN_DEVICE_FUNC
DiagonalVectorType
diagonal ()
EIGEN_DEVICE_FUNC Index rows () const
EIGEN_DEVICE_FUNC Index cols () const
template<typename MatrixDerived >
EIGEN_DEVICE_FUNC const
Product< Derived,
MatrixDerived, LazyProduct
operator* (const MatrixBase< MatrixDerived > &matrix) const
EIGEN_DEVICE_FUNC const
InverseReturnType 
inverse () const
EIGEN_DEVICE_FUNC const
ScalarMultipleReturnType 
operator* (const Scalar &scalar) const

Friends

EIGEN_DEVICE_FUNC friend const
ScalarMultipleReturnType 
operator* (const Scalar &scalar, const DiagonalBase &other)

Detailed Description

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

Definition at line 18 of file DiagonalMatrix.h.


Member Typedef Documentation

Definition at line 36 of file DiagonalMatrix.h.

template<typename Derived>
typedef DenseMatrixType Eigen::DiagonalBase< Derived >::DenseType

Definition at line 37 of file DiagonalMatrix.h.

template<typename Derived>
typedef internal::traits<Derived>::DiagonalVectorType Eigen::DiagonalBase< Derived >::DiagonalVectorType

Definition at line 66 of file DiagonalMatrix.h.

template<typename Derived>
typedef DiagonalMatrix<Scalar,DiagonalVectorType::SizeAtCompileTime,DiagonalVectorType::MaxSizeAtCompileTime> Eigen::DiagonalBase< Derived >::PlainObject

Definition at line 38 of file DiagonalMatrix.h.

template<typename Derived>
typedef DiagonalVectorType::RealScalar Eigen::DiagonalBase< Derived >::RealScalar

Definition at line 23 of file DiagonalMatrix.h.

template<typename Derived>
typedef DiagonalVectorType::Scalar Eigen::DiagonalBase< Derived >::Scalar

Definition at line 74 of file DiagonalMatrix.h.

template<typename Derived>
typedef internal::traits<Derived>::StorageIndex Eigen::DiagonalBase< Derived >::StorageIndex
template<typename Derived>
typedef internal::traits<Derived>::StorageKind Eigen::DiagonalBase< Derived >::StorageKind

Member Enumeration Documentation

template<typename Derived>
anonymous enum
Enumerator:
RowsAtCompileTime 
ColsAtCompileTime 
MaxRowsAtCompileTime 
MaxColsAtCompileTime 
IsVectorAtCompileTime 
Flags 

Definition at line 27 of file DiagonalMatrix.h.

         {
      RowsAtCompileTime = DiagonalVectorType::SizeAtCompileTime,
      ColsAtCompileTime = DiagonalVectorType::SizeAtCompileTime,
      MaxRowsAtCompileTime = DiagonalVectorType::MaxSizeAtCompileTime,
      MaxColsAtCompileTime = DiagonalVectorType::MaxSizeAtCompileTime,
      IsVectorAtCompileTime = 0,
      Flags = NoPreferredStorageOrderBit
    };

Member Function Documentation

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

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 56 of file DiagonalMatrix.h.

{ return diagonal().size(); }
template<typename Derived>
EIGEN_DEVICE_FUNC const Derived& Eigen::DiagonalBase< Derived >::derived ( ) const [inline]
Returns:
a const reference to the derived object

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 41 of file DiagonalMatrix.h.

{ return *static_cast<const Derived*>(this); }
template<typename Derived>
EIGEN_DEVICE_FUNC Derived& Eigen::DiagonalBase< Derived >::derived ( ) [inline]
Returns:
a reference to the derived object

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 43 of file DiagonalMatrix.h.

{ return *static_cast<Derived*>(this); }
template<typename Derived>
EIGEN_DEVICE_FUNC const DiagonalVectorType& Eigen::DiagonalBase< Derived >::diagonal ( ) const [inline]
template<typename Derived>
EIGEN_DEVICE_FUNC DiagonalVectorType& Eigen::DiagonalBase< Derived >::diagonal ( ) [inline]

Reimplemented in Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >.

Definition at line 51 of file DiagonalMatrix.h.

{ return derived().diagonal(); }
template<typename Derived>
EIGEN_DEVICE_FUNC const InverseReturnType Eigen::DiagonalBase< Derived >::inverse ( ) const [inline]

Definition at line 69 of file DiagonalMatrix.h.

template<typename Derived>
template<typename MatrixDerived >
EIGEN_DEVICE_FUNC const Product<Derived,MatrixDerived,LazyProduct> Eigen::DiagonalBase< Derived >::operator* ( const MatrixBase< MatrixDerived > &  matrix) const [inline]

Definition at line 61 of file DiagonalMatrix.h.

    {
      return Product<Derived, MatrixDerived, LazyProduct>(derived(),matrix.derived());
    }
template<typename Derived>
EIGEN_DEVICE_FUNC const ScalarMultipleReturnType Eigen::DiagonalBase< Derived >::operator* ( const Scalar scalar) const [inline]

Definition at line 77 of file DiagonalMatrix.h.

    {
      return ScalarMultipleReturnType(diagonal() * scalar);
    }
template<typename Derived>
EIGEN_DEVICE_FUNC Index Eigen::DiagonalBase< Derived >::rows ( void  ) const [inline]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 54 of file DiagonalMatrix.h.

{ return diagonal().size(); }
template<typename Derived>
EIGEN_DEVICE_FUNC DenseMatrixType Eigen::DiagonalBase< Derived >::toDenseMatrix ( ) const [inline]

Definition at line 46 of file DiagonalMatrix.h.

{ return derived(); }

Friends And Related Function Documentation

template<typename Derived>
EIGEN_DEVICE_FUNC friend const ScalarMultipleReturnType operator* ( const Scalar scalar,
const DiagonalBase< Derived > &  other 
) [friend]

Definition at line 83 of file DiagonalMatrix.h.

    {
      return ScalarMultipleReturnType(other.diagonal() * scalar);
    }

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines