mrpt::math::CDiagonalMatrixView< MATRIXTYPE > Class Template Reference

View the diagonal of an existing NxN matrix as a 1xN matrix (or equivalently for many MRPT methods, an N-vector). More...

#include <mrpt/math/CMatrixViews.h>

Inheritance diagram for mrpt::math::CDiagonalMatrixView< MATRIXTYPE >:

[legend]

Collaboration diagram for mrpt::math::CDiagonalMatrixView< MATRIXTYPE >:

[legend]

List of all members.

Public Types
typedef CDiagonalMatrixView < MATRIXTYPE >	mrpt_autotype
Public Member Functions
DECLARE_MRPT_CONTAINER_TYPES DECLARE_MRPT_CONTAINER_IS_MATRIX DECLARE_MRPT_MATRIX_ITERATORS	CDiagonalMatrixView (MATRIXTYPE &m)
size_t	getRowCount () const
size_t	getColCount () const
value_type &	get_unsafe (size_t r, size_t c)
value_type	get_unsafe (size_t r, size_t c) const
void	set_unsafe (size_t r, size_t c, value_type v)
value_type &	operator() (size_t r, size_t c)
value_type	operator() (size_t r, size_t c) const
value_type	operator[] (size_t i) const
value_type &	operator[] (size_t i)
template<typename CONTAINER >
mrpt_autotype &	operator= (const CONTAINER &m)
	Assigns the contents of another MATRIX or VECTOR to this diagonal.
CMatrixTemplateSize	size () const
void	setSize (size_t r, size_t c)
void	resize (size_t rtc)
Protected Attributes
MATRIXTYPE &	base

---

Detailed Description

template<typename MATRIXTYPE>
class mrpt::math::CDiagonalMatrixView< MATRIXTYPE >

View the diagonal of an existing NxN matrix as a 1xN matrix (or equivalently for many MRPT methods, an N-vector).

The original matrix should be square, but any matrix can be used as long as only valid elements are accessed. Apart from the matrix-like interface, you can use "[index]" to access individual diagonal elements like if it were a vector.

Definition at line 458 of file CMatrixViews.h.

---

Member Typedef Documentation

template<typename MATRIXTYPE >

typedef CDiagonalMatrixView<MATRIXTYPE> mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::mrpt_autotype

Definition at line 462 of file CMatrixViews.h.

---

Constructor & Destructor Documentation

template<typename MATRIXTYPE >

DECLARE_MRPT_CONTAINER_TYPES DECLARE_MRPT_CONTAINER_IS_MATRIX DECLARE_MRPT_MATRIX_ITERATORS mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::CDiagonalMatrixView

(

MATRIXTYPE &

m

)

[inline]

Definition at line 469 of file CMatrixViews.h.

---

Member Function Documentation

template<typename MATRIXTYPE >

value_type mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::get_unsafe	(	size_t	r,
		size_t	c
	)			const [inline]

Definition at line 476 of file CMatrixViews.h.

References mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base.

template<typename MATRIXTYPE >

value_type& mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::get_unsafe	(	size_t	r,
		size_t	c
	)			[inline]

Definition at line 472 of file CMatrixViews.h.

References mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base.

template<typename MATRIXTYPE >

size_t mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::getColCount

(

)

const [inline]

Definition at line 471 of file CMatrixViews.h.

References mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base.

template<typename MATRIXTYPE >

size_t mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::getRowCount

(

)

const [inline]

Definition at line 470 of file CMatrixViews.h.

template<typename MATRIXTYPE >

value_type mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::operator()	(	size_t	r,
		size_t	c
	)			const [inline]

Definition at line 488 of file CMatrixViews.h.

References mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base.

template<typename MATRIXTYPE >

value_type& mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::operator()	(	size_t	r,
		size_t	c
	)			[inline]

Definition at line 484 of file CMatrixViews.h.

References mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base.

template<typename MATRIXTYPE >

template<typename CONTAINER >

mrpt_autotype& mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::operator=

(

const CONTAINER &

m

)

[inline]

Assigns the contents of another MATRIX or VECTOR to this diagonal.

Definition at line 499 of file CMatrixViews.h.

References ASSERT_, mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base, and mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::size().

template<typename MATRIXTYPE >

value_type& mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::operator[]

(

size_t

i

)

[inline]

Parameters:

i

Vector-like access

Definition at line 495 of file CMatrixViews.h.

References mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base.

template<typename MATRIXTYPE >

value_type mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::operator[]

(

size_t

i

)

const [inline]

< Vector-like access

Definition at line 492 of file CMatrixViews.h.

References mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base.

template<typename MATRIXTYPE >

void mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::resize

(

size_t

rtc

)

[inline]

Definition at line 517 of file CMatrixViews.h.

References mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base.

template<typename MATRIXTYPE >

void mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::set_unsafe	(	size_t	r,
		size_t	c,
		value_type	v
	)			[inline]

Definition at line 480 of file CMatrixViews.h.

References mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base.

template<typename MATRIXTYPE >

void mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::setSize	(	size_t	r,
		size_t	c
	)			[inline]

Definition at line 514 of file CMatrixViews.h.

References mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base.

template<typename MATRIXTYPE >

CMatrixTemplateSize mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::size

(

)

const [inline]

Definition at line 508 of file CMatrixViews.h.

References mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base.

Referenced by mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::operator=().

---

Member Data Documentation

template<typename MATRIXTYPE >

MATRIXTYPE& mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::base [protected]

Definition at line 460 of file CMatrixViews.h.

Referenced by mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::get_unsafe(), mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::getColCount(), mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::operator()(), mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::operator=(), mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::operator[](), mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::resize(), mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::set_unsafe(), mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::setSize(), and mrpt::math::CDiagonalMatrixView< MATRIXTYPE >::size().