Rcpp::SubMatrix< RTYPE > Class Template Reference

#include <SubMatrix.h>

Inheritance diagram for Rcpp::SubMatrix< RTYPE >:

Collaboration diagram for Rcpp::SubMatrix< RTYPE >:

Public Types
typedef Matrix< RTYPE >	MATRIX
typedef Vector< RTYPE >::iterator	vec_iterator
typedef MATRIX::Proxy	Proxy
Public Types inherited from Rcpp::MatrixBase< RTYPE, true, SubMatrix< RTYPE > >
typedef traits::storage_type< RTYPE >::type	stored_type

Public Member Functions
	SubMatrix (MATRIX &m_, const Range &row_range_, const Range &col_range_)
R_xlen_t	size () const
R_xlen_t	ncol () const
R_xlen_t	nrow () const
Proxy	operator() (int i, int j) const
vec_iterator	column_iterator (int j) const
Public Member Functions inherited from Rcpp::MatrixBase< RTYPE, true, SubMatrix< RTYPE > >
SubMatrix< RTYPE > &	get_ref ()
stored_type	operator() (int i, int j) const
R_xlen_t	size () const
R_xlen_t	nrow () const
R_xlen_t	ncol () const
iterator	begin () const
iterator	end () const

Private Attributes
MATRIX &	m
vec_iterator	iter
R_xlen_t	m_nr
R_xlen_t	nc
R_xlen_t	nr

Additional Inherited Members
Static Public Member Functions inherited from Rcpp::MatrixBase< RTYPE, true, SubMatrix< RTYPE > >
static SubMatrix< RTYPE >	eye (int n)
static SubMatrix< RTYPE >	ones (int n)
static SubMatrix< RTYPE >	zeros (int n)

Detailed Description

template<int RTYPE>
class Rcpp::SubMatrix< RTYPE >

Definition at line 27 of file SubMatrix.h.

Member Typedef Documentation

MATRIX

template<int RTYPE>

typedef Matrix<RTYPE> Rcpp::SubMatrix< RTYPE >::MATRIX

Definition at line 29 of file SubMatrix.h.

Proxy

template<int RTYPE>

typedef MATRIX::Proxy Rcpp::SubMatrix< RTYPE >::Proxy

Definition at line 31 of file SubMatrix.h.

vec_iterator

template<int RTYPE>

typedef Vector<RTYPE>::iterator Rcpp::SubMatrix< RTYPE >::vec_iterator

Definition at line 30 of file SubMatrix.h.

Constructor & Destructor Documentation

SubMatrix()

template<int RTYPE>

Rcpp::SubMatrix< RTYPE >::SubMatrix ( MATRIX &  m_, const Range &  row_range_, const Range &  col_range_  )

inline

Definition at line 33 of file SubMatrix.h.

Member Function Documentation

column_iterator()

template<int RTYPE>

vec_iterator Rcpp::SubMatrix< RTYPE >::column_iterator ( int  j ) const

inline

Definition at line 49 of file SubMatrix.h.

References Rcpp::SubMatrix< RTYPE >::iter, and Rcpp::SubMatrix< RTYPE >::m_nr.

ncol()

template<int RTYPE>

R_xlen_t Rcpp::SubMatrix< RTYPE >::ncol ( ) const

inline

Definition at line 42 of file SubMatrix.h.

References Rcpp::SubMatrix< RTYPE >::nc.

Referenced by Rcpp::SubMatrix< RTYPE >::size().

nrow()

template<int RTYPE>

R_xlen_t Rcpp::SubMatrix< RTYPE >::nrow ( ) const

inline

Definition at line 43 of file SubMatrix.h.

References Rcpp::SubMatrix< RTYPE >::nr.

Referenced by Rcpp::SubMatrix< RTYPE >::size().

operator()()

template<int RTYPE>

Proxy Rcpp::SubMatrix< RTYPE >::operator() ( int  i, int  j  ) const

inline

Definition at line 45 of file SubMatrix.h.

References Rcpp::SubMatrix< RTYPE >::iter, and Rcpp::SubMatrix< RTYPE >::m_nr.

size()

template<int RTYPE>

R_xlen_t Rcpp::SubMatrix< RTYPE >::size ( ) const

inline

Definition at line 41 of file SubMatrix.h.

References Rcpp::as(), Rcpp::SubMatrix< RTYPE >::ncol(), and Rcpp::SubMatrix< RTYPE >::nrow().

Here is the call graph for this function:

Member Data Documentation

iter

template<int RTYPE>

vec_iterator Rcpp::SubMatrix< RTYPE >::iter

private

Definition at line 53 of file SubMatrix.h.

Referenced by Rcpp::SubMatrix< RTYPE >::column_iterator(), and Rcpp::SubMatrix< RTYPE >::operator()().

m

template<int RTYPE>

MATRIX& Rcpp::SubMatrix< RTYPE >::m

private

Definition at line 52 of file SubMatrix.h.

m_nr

template<int RTYPE>

R_xlen_t Rcpp::SubMatrix< RTYPE >::m_nr

private

Definition at line 54 of file SubMatrix.h.

Referenced by Rcpp::SubMatrix< RTYPE >::column_iterator(), and Rcpp::SubMatrix< RTYPE >::operator()().

nc

template<int RTYPE>

R_xlen_t Rcpp::SubMatrix< RTYPE >::nc

private

Definition at line 54 of file SubMatrix.h.

Referenced by Rcpp::SubMatrix< RTYPE >::ncol().

nr

template<int RTYPE>

R_xlen_t Rcpp::SubMatrix< RTYPE >::nr

private

Definition at line 54 of file SubMatrix.h.

Referenced by Rcpp::SubMatrix< RTYPE >::nrow().

---

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

• inst/include/Rcpp/Vector.h
• inst/include/Rcpp/vector/SubMatrix.h