MOAB  4.9.3pre
Public Types | Public Member Functions | Protected Attributes
Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > Class Template Reference

Represents a diagonal matrix with its storage. More...

#include <DiagonalMatrix.h>

Inheritance diagram for Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >:
Inheritance graph
[legend]
Collaboration diagram for Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef internal::traits
< DiagonalMatrix >
::DiagonalVectorType 		DiagonalVectorType
typedef const DiagonalMatrix & Nested
typedef _Scalar Scalar
typedef internal::traits
< DiagonalMatrix >
::StorageKind 		StorageKind
typedef internal::traits
< DiagonalMatrix >
::StorageIndex 		StorageIndex

Public Member Functions

EIGEN_DEVICE_FUNC const
DiagonalVectorType & 		diagonal () const
EIGEN_DEVICE_FUNC
DiagonalVectorType & 		diagonal ()
EIGEN_DEVICE_FUNC DiagonalMatrix ()
EIGEN_DEVICE_FUNC DiagonalMatrix (Index dim)
EIGEN_DEVICE_FUNC DiagonalMatrix (const Scalar &x, const Scalar &y)
EIGEN_DEVICE_FUNC DiagonalMatrix (const Scalar &x, const Scalar &y, const Scalar &z)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC DiagonalMatrix (const DiagonalBase< OtherDerived > &other)
 DiagonalMatrix (const DiagonalMatrix &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC DiagonalMatrix (const MatrixBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC DiagonalMatrix & operator= (const DiagonalBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC DiagonalMatrix & operator= (const DiagonalMatrix &other)
EIGEN_DEVICE_FUNC void resize (Index size)
EIGEN_DEVICE_FUNC void setZero ()
EIGEN_DEVICE_FUNC void setZero (Index size)
EIGEN_DEVICE_FUNC void setIdentity ()
EIGEN_DEVICE_FUNC void setIdentity (Index size)

Protected Attributes

DiagonalVectorType m_diagonal

Detailed Description

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
class Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >

Represents a diagonal matrix with its storage.

Parameters:
_Scalarthe type of coefficients
SizeAtCompileTimethe dimension of the matrix, or Dynamic
MaxSizeAtCompileTimethe dimension of the matrix, or Dynamic. This parameter is optional and defaults to SizeAtCompileTime. Most of the time, you do not need to specify it.
See also:
class DiagonalWrapper

Definition at line 117 of file DiagonalMatrix.h.

Member Typedef Documentation

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
typedef internal::traits<DiagonalMatrix>::DiagonalVectorType Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalVectorType

Reimplemented from Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.

Definition at line 122 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
typedef const DiagonalMatrix& Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::Nested

Definition at line 123 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
typedef _Scalar Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::Scalar

Reimplemented from Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.

Definition at line 124 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
typedef internal::traits<DiagonalMatrix>::StorageIndex Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::StorageIndex

Reimplemented from Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.

Definition at line 126 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
typedef internal::traits<DiagonalMatrix>::StorageKind Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::StorageKind

Reimplemented from Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.

Definition at line 125 of file DiagonalMatrix.h.

Constructor & Destructor Documentation

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( ) [inline]

Default constructor without initialization

Definition at line 144 of file DiagonalMatrix.h.

{}
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( Index  dim) [inline, explicit]

Constructs a diagonal matrix with given dimension

Definition at line 148 of file DiagonalMatrix.h.

: m_diagonal(dim) {}
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( const Scalar &  x,
const Scalar &  y 
) [inline]

2D constructor.

Definition at line 152 of file DiagonalMatrix.h.

: m_diagonal(x,y) {}
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( const Scalar &  x,
const Scalar &  y,
const Scalar &  z 
) [inline]

3D constructor.

Definition at line 156 of file DiagonalMatrix.h.

: m_diagonal(x,y,z) {}
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( const DiagonalBase< OtherDerived > &  other) [inline]

Copy constructor.

Definition at line 161 of file DiagonalMatrix.h.

: m_diagonal(other.diagonal()) {}
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > &  other) [inline]

copy constructor. prevent a default copy constructor from hiding the other templated constructor

Definition at line 165 of file DiagonalMatrix.h.

: m_diagonal(other.diagonal()) {}
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( const MatrixBase< OtherDerived > &  other) [inline, explicit]

generic constructor from expression of the diagonal coefficients

Definition at line 171 of file DiagonalMatrix.h.

                                                                          : m_diagonal(other)
    {}

Member Function Documentation

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
EIGEN_DEVICE_FUNC const DiagonalVectorType& Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::diagonal ( ) const [inline]

const version of diagonal().

Reimplemented from Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.

Definition at line 137 of file DiagonalMatrix.h.

{ return m_diagonal; }
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
EIGEN_DEVICE_FUNC DiagonalVectorType& Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::diagonal ( ) [inline]
Returns:
a reference to the stored vector of diagonal coefficients.

Reimplemented from Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.

Definition at line 140 of file DiagonalMatrix.h.

{ return m_diagonal; }
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
template<typename OtherDerived >
EIGEN_DEVICE_FUNC DiagonalMatrix& Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::operator= ( const DiagonalBase< OtherDerived > &  other) [inline]

Copy operator.

Definition at line 177 of file DiagonalMatrix.h.

    {
      m_diagonal = other.diagonal();
      return *this;
    }
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
EIGEN_DEVICE_FUNC DiagonalMatrix& Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::operator= ( const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > &  other) [inline]

This is a special case of the templated operator=. Its purpose is to prevent a default operator= from hiding the templated operator=.

Definition at line 188 of file DiagonalMatrix.h.

    {
      m_diagonal = other.diagonal();
      return *this;
    }
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::resize ( Index  size) [inline]

Resizes to given size.

Definition at line 197 of file DiagonalMatrix.h.

{ m_diagonal.resize(size); }
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity ( ) [inline]

Sets this matrix to be the identity matrix of the current size.

Definition at line 206 of file DiagonalMatrix.h.

{ m_diagonal.setOnes(); }
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity ( Index  size) [inline]

Sets this matrix to be the identity matrix of the given size.

Definition at line 209 of file DiagonalMatrix.h.

{ m_diagonal.setOnes(size); }
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero ( ) [inline]

Sets all coefficients to zero.

Definition at line 200 of file DiagonalMatrix.h.

{ m_diagonal.setZero(); }
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero ( Index  size) [inline]

Resizes and sets all coefficients to zero.

Definition at line 203 of file DiagonalMatrix.h.

{ m_diagonal.setZero(size); }

Member Data Documentation

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
DiagonalVectorType Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal [protected]

Definition at line 131 of file DiagonalMatrix.h.

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