Public Types | Public Member Functions | Protected Attributes
Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType > Class Template Reference

Generic expression of a matrix where all coefficients are defined by a functor. More...

#include <CwiseNullaryOp.h>

Inheritance diagram for Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef
internal::dense_xpr_base
< CwiseNullaryOp >::type 
Base

Public Member Functions

EIGEN_STRONG_INLINE const Scalar coeff (Index rowId, Index colId) const
EIGEN_STRONG_INLINE const Scalar coeff (Index index) const
EIGEN_STRONG_INLINE Index cols () const
 CwiseNullaryOp (Index nbRows, Index nbCols, const NullaryOp &func=NullaryOp())
const NullaryOp & functor () const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar packet (Index rowId, Index colId) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar packet (Index index) const
EIGEN_STRONG_INLINE Index rows () const

Protected Attributes

const
internal::variable_if_dynamic
< Index, ColsAtCompileTime > 
m_cols
const NullaryOp m_functor
const
internal::variable_if_dynamic
< Index, RowsAtCompileTime > 
m_rows

Detailed Description

template<typename NullaryOp, typename PlainObjectType>
class Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >

Generic expression of a matrix where all coefficients are defined by a functor.

Parameters:
NullaryOptemplate functor implementing the operator
PlainObjectTypethe underlying plain matrix/array type

This class represents an expression of a generic nullary operator. It is the return type of the Ones(), Zero(), Constant(), Identity() and Random() methods, and most of the time this is the only way it is used.

However, if you want to write a function returning such an expression, you will need to use this class.

See also:
class CwiseUnaryOp, class CwiseBinaryOp, DenseBase::NullaryExpr()

Definition at line 49 of file CwiseNullaryOp.h.


Member Typedef Documentation

template<typename NullaryOp, typename PlainObjectType>
typedef internal::dense_xpr_base<CwiseNullaryOp>::type Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >::Base

Definition at line 54 of file CwiseNullaryOp.h.


Constructor & Destructor Documentation

template<typename NullaryOp, typename PlainObjectType>
Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >::CwiseNullaryOp ( Index  nbRows,
Index  nbCols,
const NullaryOp &  func = NullaryOp() 
) [inline]

Definition at line 57 of file CwiseNullaryOp.h.


Member Function Documentation

template<typename NullaryOp, typename PlainObjectType>
EIGEN_STRONG_INLINE const Scalar Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >::coeff ( Index  rowId,
Index  colId 
) const [inline]

Definition at line 69 of file CwiseNullaryOp.h.

template<typename NullaryOp, typename PlainObjectType>
EIGEN_STRONG_INLINE const Scalar Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >::coeff ( Index  index) const [inline]

Definition at line 80 of file CwiseNullaryOp.h.

template<typename NullaryOp, typename PlainObjectType>
EIGEN_STRONG_INLINE Index Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >::cols ( ) const [inline]

Definition at line 67 of file CwiseNullaryOp.h.

template<typename NullaryOp, typename PlainObjectType>
const NullaryOp& Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >::functor ( ) const [inline]
Returns:
the functor representing the nullary operation

Definition at line 92 of file CwiseNullaryOp.h.

template<typename NullaryOp, typename PlainObjectType>
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >::packet ( Index  rowId,
Index  colId 
) const [inline]

Definition at line 75 of file CwiseNullaryOp.h.

template<typename NullaryOp, typename PlainObjectType>
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >::packet ( Index  index) const [inline]

Definition at line 86 of file CwiseNullaryOp.h.

template<typename NullaryOp, typename PlainObjectType>
EIGEN_STRONG_INLINE Index Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >::rows ( ) const [inline]

Definition at line 66 of file CwiseNullaryOp.h.


Member Data Documentation

template<typename NullaryOp, typename PlainObjectType>
const internal::variable_if_dynamic<Index, ColsAtCompileTime> Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >::m_cols [protected]

Definition at line 96 of file CwiseNullaryOp.h.

template<typename NullaryOp, typename PlainObjectType>
const NullaryOp Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >::m_functor [protected]

Definition at line 97 of file CwiseNullaryOp.h.

template<typename NullaryOp, typename PlainObjectType>
const internal::variable_if_dynamic<Index, RowsAtCompileTime> Eigen::CwiseNullaryOp< NullaryOp, PlainObjectType >::m_rows [protected]

Definition at line 95 of file CwiseNullaryOp.h.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Thu Aug 27 2015 12:01:46