Eigen::Replicate< MatrixType, RowFactor, ColFactor > Class Template Reference

Expression of the multiple replication of a matrix or vector. More...

#include <Replicate.h>

Inheritance diagram for Eigen::Replicate< MatrixType, RowFactor, ColFactor >:

Collaboration diagram for Eigen::Replicate< MatrixType, RowFactor, ColFactor >:

List of all members.

Public Types
typedef internal::dense_xpr_base < Replicate >::type	Base
typedef internal::remove_all < MatrixType >::type	NestedExpression
Public Member Functions
template<typename OriginalMatrixType >
EIGEN_DEVICE_FUNC	Replicate (const OriginalMatrixType &matrix)
template<typename OriginalMatrixType >
EIGEN_DEVICE_FUNC	Replicate (const OriginalMatrixType &matrix, Index rowFactor, Index colFactor)
EIGEN_DEVICE_FUNC Index	rows () const
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC const _MatrixTypeNested &	nestedExpression () const
Protected Attributes
MatrixTypeNested	m_matrix
const internal::variable_if_dynamic < Index, RowFactor >	m_rowFactor
const internal::variable_if_dynamic < Index, ColFactor >	m_colFactor
Private Types
typedef internal::traits < Replicate > ::MatrixTypeNested	MatrixTypeNested
typedef internal::traits < Replicate > ::_MatrixTypeNested	_MatrixTypeNested

---

Detailed Description

template<typename MatrixType, int RowFactor, int ColFactor>
class Eigen::Replicate< MatrixType, RowFactor, ColFactor >

Expression of the multiple replication of a matrix or vector.

Template Parameters:

MatrixType	the type of the object we are replicating
RowFactor	number of repetitions at compile time along the vertical direction, can be Dynamic.
ColFactor	number of repetitions at compile time along the horizontal direction, can be Dynamic.

This class represents an expression of the multiple replication of a matrix or vector. It is the return type of DenseBase::replicate() and most of the time this is the only way it is used.

See also:

DenseBase::replicate()

Definition at line 61 of file Replicate.h.

---

Member Typedef Documentation

template<typename MatrixType, int RowFactor, int ColFactor>

typedef internal::traits<Replicate>::_MatrixTypeNested Eigen::Replicate< MatrixType, RowFactor, ColFactor >::_MatrixTypeNested [private]

Definition at line 65 of file Replicate.h.

template<typename MatrixType, int RowFactor, int ColFactor>

typedef internal::dense_xpr_base<Replicate>::type Eigen::Replicate< MatrixType, RowFactor, ColFactor >::Base

Definition at line 68 of file Replicate.h.

template<typename MatrixType, int RowFactor, int ColFactor>

typedef internal::traits<Replicate>::MatrixTypeNested Eigen::Replicate< MatrixType, RowFactor, ColFactor >::MatrixTypeNested [private]

Definition at line 64 of file Replicate.h.

template<typename MatrixType, int RowFactor, int ColFactor>

typedef internal::remove_all<MatrixType>::type Eigen::Replicate< MatrixType, RowFactor, ColFactor >::NestedExpression

Definition at line 70 of file Replicate.h.

---

Constructor & Destructor Documentation

template<typename MatrixType, int RowFactor, int ColFactor>

template<typename OriginalMatrixType >

EIGEN_DEVICE_FUNC Eigen::Replicate< MatrixType, RowFactor, ColFactor >::Replicate

(

const OriginalMatrixType &

matrix

)

[inline, explicit]

Definition at line 74 of file Replicate.h.

      : m_matrix(matrix), m_rowFactor(RowFactor), m_colFactor(ColFactor)
    {
      EIGEN_STATIC_ASSERT((internal::is_same<typename internal::remove_const<MatrixType>::type,OriginalMatrixType>::value),
                          THE_MATRIX_OR_EXPRESSION_THAT_YOU_PASSED_DOES_NOT_HAVE_THE_EXPECTED_TYPE)
      eigen_assert(RowFactor!=Dynamic && ColFactor!=Dynamic);
    }

template<typename MatrixType, int RowFactor, int ColFactor>

template<typename OriginalMatrixType >

EIGEN_DEVICE_FUNC Eigen::Replicate< MatrixType, RowFactor, ColFactor >::Replicate	(	const OriginalMatrixType &	matrix,
		Index	rowFactor,
		Index	colFactor
	)		[inline]

Definition at line 84 of file Replicate.h.

      : m_matrix(matrix), m_rowFactor(rowFactor), m_colFactor(colFactor)
    {
      EIGEN_STATIC_ASSERT((internal::is_same<typename internal::remove_const<MatrixType>::type,OriginalMatrixType>::value),
                          THE_MATRIX_OR_EXPRESSION_THAT_YOU_PASSED_DOES_NOT_HAVE_THE_EXPECTED_TYPE)
    }

---

Member Function Documentation

template<typename MatrixType, int RowFactor, int ColFactor>

EIGEN_DEVICE_FUNC Index Eigen::Replicate< MatrixType, RowFactor, ColFactor >::cols

(

void

)

const [inline]

Definition at line 94 of file Replicate.h.

{ return m_matrix.cols() * m_colFactor.value(); }

template<typename MatrixType, int RowFactor, int ColFactor>

EIGEN_DEVICE_FUNC const _MatrixTypeNested& Eigen::Replicate< MatrixType, RowFactor, ColFactor >::nestedExpression

(

)

const [inline]

Definition at line 97 of file Replicate.h.

    { 
      return m_matrix; 
    }

template<typename MatrixType, int RowFactor, int ColFactor>

EIGEN_DEVICE_FUNC Index Eigen::Replicate< MatrixType, RowFactor, ColFactor >::rows

(

void

)

const [inline]

Definition at line 92 of file Replicate.h.

{ return m_matrix.rows() * m_rowFactor.value(); }

---

Member Data Documentation

template<typename MatrixType, int RowFactor, int ColFactor>

const internal::variable_if_dynamic<Index, ColFactor> Eigen::Replicate< MatrixType, RowFactor, ColFactor >::m_colFactor [protected]

Definition at line 105 of file Replicate.h.

template<typename MatrixType, int RowFactor, int ColFactor>

MatrixTypeNested Eigen::Replicate< MatrixType, RowFactor, ColFactor >::m_matrix [protected]

Definition at line 103 of file Replicate.h.

template<typename MatrixType, int RowFactor, int ColFactor>

const internal::variable_if_dynamic<Index, RowFactor> Eigen::Replicate< MatrixType, RowFactor, ColFactor >::m_rowFactor [protected]

Definition at line 104 of file Replicate.h.

---

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

• Replicate.h