Public Types | Public Member Functions | Protected Attributes

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 CwiseNullaryOp< NullaryOp, PlainObjectType >:
internal::no_assignment_operator

List of all members.

Public Types

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

Public Member Functions

 CwiseNullaryOp (Index rows, Index cols, const NullaryOp &func=NullaryOp())
EIGEN_STRONG_INLINE Index rows () const
EIGEN_STRONG_INLINE Index cols () const
EIGEN_STRONG_INLINE const Scalar coeff (Index rows, Index cols) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar packet (Index row, Index col) const
EIGEN_STRONG_INLINE const Scalar coeff (Index index) const
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar packet (Index index) const

Protected Attributes

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

Detailed Description

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

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

Parameters:
NullaryOp template functor implementing the operator
PlainObjectType the 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()

Member Typedef Documentation

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

Constructor & Destructor Documentation

template<typename NullaryOp, typename PlainObjectType>
CwiseNullaryOp< NullaryOp, PlainObjectType >::CwiseNullaryOp ( Index  rows,
Index  cols,
const NullaryOp &  func = NullaryOp() 
) [inline]

Member Function Documentation

template<typename NullaryOp, typename PlainObjectType>
EIGEN_STRONG_INLINE const Scalar CwiseNullaryOp< NullaryOp, PlainObjectType >::coeff ( Index  rows,
Index  cols 
) const [inline]
template<typename NullaryOp, typename PlainObjectType>
EIGEN_STRONG_INLINE const Scalar CwiseNullaryOp< NullaryOp, PlainObjectType >::coeff ( Index  index  )  const [inline]
template<typename NullaryOp, typename PlainObjectType>
EIGEN_STRONG_INLINE Index CwiseNullaryOp< NullaryOp, PlainObjectType >::cols (  )  const [inline]
template<typename NullaryOp, typename PlainObjectType>
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar CwiseNullaryOp< NullaryOp, PlainObjectType >::packet ( Index  index  )  const [inline]
template<typename NullaryOp, typename PlainObjectType>
template<int LoadMode>
EIGEN_STRONG_INLINE PacketScalar CwiseNullaryOp< NullaryOp, PlainObjectType >::packet ( Index  row,
Index  col 
) const [inline]
template<typename NullaryOp, typename PlainObjectType>
EIGEN_STRONG_INLINE Index CwiseNullaryOp< NullaryOp, PlainObjectType >::rows (  )  const [inline]

Member Data Documentation

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

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