MRPT logo
Classes | Public Types | Protected Attributes

mrpt::math::CMatrixRowAccessor< MAT > Class Template Reference

A vector-like wrapper for a Matrix for accessing the elements of a given row with a [] operator. More...

#include <mrpt/math/CMatrixViews.h>

List of all members.

Classes

struct  mrpt_container

Public Types

typedef MAT::value_type value_type
typedef CMatrixRowAccessor< MAT > mrpt_autotype

Protected Attributes

MAT * m_mat
size_t m_rowInd

Methods common to all containers



typedef
detail::AccessorIterator
< CMatrixRowAccessor< MAT >
, value_type > 
iterator
typedef
detail::AccessorIterator
< const CMatrixRowAccessor
< MAT >, const value_type > 
const_iterator
typedef
detail::ReverseAccessorIterator
< CMatrixRowAccessor< MAT >
, value_type > 
reverse_iterator
typedef
detail::ReverseAccessorIterator
< const CMatrixRowAccessor
< MAT >, const value_type > 
const_reverse_iterator
size_t countNonZero () const
void fill (const value_type &val)
value_type maximum (size_t *maxIndex=NULL) const
value_type minimum (size_t *minIndex=NULL) const
void minimum_maximum (value_type &out_min, value_type &out_max, size_t *minIndex=NULL, size_t *maxIndex=NULL) const
value_type norm_inf (size_t *maxIndex=NULL) const
value_type sumAll () const
template<class CONTAINEROUT >
void cumsum (CONTAINEROUT &out) const
template<class CONTAINEROUT >
CONTAINEROUT cumsum () const
template<class CONTAINER2 >
size_t countCommonElements (const CONTAINER2 &b) const
 Counts the number of elements that appear in both containers (comparison through the == operator).
std::vector< double > histogram (double limit_min, double limit_max, size_t number_bins, bool do_normalization=false) const
 Computes the normalized or normal histogram of a sequence of numbers given the number of bins and the limits.
template<class F >
mrpt_autotype & applyToAllElements (value_type(*function)(value_type))
mrpt_autotype & Sqrt ()
mrpt_autotype & Abs ()
mrpt_autotype & Square ()
mrpt_autotype & Exp ()
mrpt_autotype & Log ()
value_type squareNorm () const
value_type norm () const
value_type mean () const
void adjustRange (const value_type min_val, const value_type max_val)
void normalize (const value_type min_val=0, const value_type max_val=1)
double std (bool unbiased=true) const
void meanAndStd (double &out_mean, double &out_std, bool unbiased=true)
 CMatrixRowAccessor (MAT &mat, size_t rowIdx)
 CMatrixRowAccessor ()
value_type & operator[] (const size_t i)
value_type operator[] (const size_t i) const
iterator begin ()
const_iterator begin () const
iterator end ()
const_iterator end () const
reverse_iterator rbegin ()
const_reverse_iterator rbegin () const
reverse_iterator rend ()
const_reverse_iterator rend () const
size_t size () const
void resize (size_t N)

Detailed Description

template<typename MAT>
class mrpt::math::CMatrixRowAccessor< MAT >

A vector-like wrapper for a Matrix for accessing the elements of a given row with a [] operator.

See also:
CMatrixColumnAccessor,CMatrixRowAccessorExtended,CConstMatrixRowAccessor,CConstMatrixRowAccessorExtended

Definition at line 826 of file CMatrixViews.h.


Member Typedef Documentation

Definition at line 842 of file CMatrixViews.h.

Definition at line 844 of file CMatrixViews.h.

Definition at line 841 of file CMatrixViews.h.

template<typename MAT>
typedef CMatrixRowAccessor<MAT> mrpt::math::CMatrixRowAccessor< MAT >::mrpt_autotype

Definition at line 833 of file CMatrixViews.h.

Definition at line 843 of file CMatrixViews.h.

template<typename MAT>
typedef MAT::value_type mrpt::math::CMatrixRowAccessor< MAT >::value_type

Definition at line 832 of file CMatrixViews.h.


Constructor & Destructor Documentation

template<typename MAT>
mrpt::math::CMatrixRowAccessor< MAT >::CMatrixRowAccessor ( MAT &  mat,
size_t  rowIdx 
) [inline]

Definition at line 837 of file CMatrixViews.h.

References ASSERT_.

template<typename MAT>
mrpt::math::CMatrixRowAccessor< MAT >::CMatrixRowAccessor (  )  [inline]

Definition at line 838 of file CMatrixViews.h.


Member Function Documentation

template<typename MAT>
mrpt_autotype& mrpt::math::CMatrixRowAccessor< MAT >::Abs (  )  [inline]

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
void mrpt::math::CMatrixRowAccessor< MAT >::adjustRange ( const value_type  min_val,
const value_type  max_val 
) [inline]
Parameters:
max_val Normalize all the elements such as they are in the given range

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
template<class F >
mrpt_autotype& mrpt::math::CMatrixRowAccessor< MAT >::applyToAllElements ( value_type(*)(value_type)  function  )  [inline]

Applies a generic operation "T func(T val)" to all the elements.

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
iterator mrpt::math::CMatrixRowAccessor< MAT >::begin (  )  [inline]

Definition at line 845 of file CMatrixViews.h.

template<typename MAT>
const_iterator mrpt::math::CMatrixRowAccessor< MAT >::begin (  )  const [inline]

Definition at line 848 of file CMatrixViews.h.

template<typename MAT>
template<class CONTAINER2 >
size_t mrpt::math::CMatrixRowAccessor< MAT >::countCommonElements ( const CONTAINER2 &  b  )  const [inline]

Counts the number of elements that appear in both containers (comparison through the == operator).

It is assumed that no repeated elements appear within each of the containers.

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
size_t mrpt::math::CMatrixRowAccessor< MAT >::countNonZero (  )  const [inline]

Count how many elements in a container are non-zero.

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
template<class CONTAINEROUT >
CONTAINEROUT mrpt::math::CMatrixRowAccessor< MAT >::cumsum (  )  const [inline]

Cumsum of all the elements, returning a container of the given type, for example: CMatrixDouble m = mat.cumsum<CMatrixDouble>();

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
template<class CONTAINEROUT >
void mrpt::math::CMatrixRowAccessor< MAT >::cumsum ( CONTAINEROUT &  out  )  const [inline]

Cumsum of all the elements, saving in an output container

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
iterator mrpt::math::CMatrixRowAccessor< MAT >::end (  )  [inline]

Definition at line 851 of file CMatrixViews.h.

References mrpt::math::CMatrixColumnAccessor< MAT >::m_mat.

template<typename MAT>
const_iterator mrpt::math::CMatrixRowAccessor< MAT >::end (  )  const [inline]

Definition at line 854 of file CMatrixViews.h.

References mrpt::math::CMatrixColumnAccessor< MAT >::m_mat.

template<typename MAT>
mrpt_autotype& mrpt::math::CMatrixRowAccessor< MAT >::Exp (  )  [inline]

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
void mrpt::math::CMatrixRowAccessor< MAT >::fill ( const value_type &  val  )  [inline]

Fill all the elements with a given value

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
std::vector<double> mrpt::math::CMatrixRowAccessor< MAT >::histogram ( double  limit_min,
double  limit_max,
size_t  number_bins,
bool  do_normalization = false 
) const [inline]

Computes the normalized or normal histogram of a sequence of numbers given the number of bins and the limits.

In any case this is a "linear" histogram, i.e. for matrices, all the elements are taken as if they were a plain sequence, not taking into account they were in columns or rows.

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
mrpt_autotype& mrpt::math::CMatrixRowAccessor< MAT >::Log (  )  [inline]

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
value_type mrpt::math::CMatrixRowAccessor< MAT >::maximum ( size_t *  maxIndex = NULL  )  const [inline]

Finds the maximum value (and the corresponding zero-based index).

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
value_type mrpt::math::CMatrixRowAccessor< MAT >::mean (  )  const [inline]

Return the mean of the container (for matrices, as if it were a vector with all its elements).

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
void mrpt::math::CMatrixRowAccessor< MAT >::meanAndStd ( double &  out_mean,
double &  out_std,
bool  unbiased = true 
) [inline]

Return the mean and standard deviation of all the elements in the container.

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
value_type mrpt::math::CMatrixRowAccessor< MAT >::minimum ( size_t *  minIndex = NULL  )  const [inline]

Finds the minimum value (and the corresponding zero-based index).

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
void mrpt::math::CMatrixRowAccessor< MAT >::minimum_maximum ( value_type &  out_min,
value_type &  out_max,
size_t *  minIndex = NULL,
size_t *  maxIndex = NULL 
) const [inline]

Minimum and maximum of a vector at once

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
value_type mrpt::math::CMatrixRowAccessor< MAT >::norm (  )  const [inline]

Return the norm of the container (for matrices, as if it were a vector with all its elements).

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
value_type mrpt::math::CMatrixRowAccessor< MAT >::norm_inf ( size_t *  maxIndex = NULL  )  const [inline]

Compute the norm-infinite of a vector ($f[ ||{v}||_ $f]), ie the maximum absolute value of the elements.

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
void mrpt::math::CMatrixRowAccessor< MAT >::normalize ( const value_type  min_val = 0,
const value_type  max_val = 1 
) [inline]
Parameters:
max_val Normalize all the elements such as they are in the given range

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
value_type& mrpt::math::CMatrixRowAccessor< MAT >::operator[] ( const size_t  i  )  [inline]

Definition at line 839 of file CMatrixViews.h.

References mrpt::math::CMatrixColumnAccessor< MAT >::m_mat.

template<typename MAT>
value_type mrpt::math::CMatrixRowAccessor< MAT >::operator[] ( const size_t  i  )  const [inline]

Definition at line 840 of file CMatrixViews.h.

References mrpt::math::CMatrixColumnAccessor< MAT >::m_mat.

template<typename MAT>
reverse_iterator mrpt::math::CMatrixRowAccessor< MAT >::rbegin (  )  [inline]

Definition at line 857 of file CMatrixViews.h.

References mrpt::math::CMatrixColumnAccessor< MAT >::m_mat.

template<typename MAT>
const_reverse_iterator mrpt::math::CMatrixRowAccessor< MAT >::rbegin (  )  const [inline]

Definition at line 860 of file CMatrixViews.h.

References mrpt::math::CMatrixColumnAccessor< MAT >::m_mat.

template<typename MAT>
reverse_iterator mrpt::math::CMatrixRowAccessor< MAT >::rend (  )  [inline]

Definition at line 863 of file CMatrixViews.h.

template<typename MAT>
const_reverse_iterator mrpt::math::CMatrixRowAccessor< MAT >::rend (  )  const [inline]

Definition at line 866 of file CMatrixViews.h.

template<typename MAT>
void mrpt::math::CMatrixRowAccessor< MAT >::resize ( size_t  N  )  [inline]

Definition at line 872 of file CMatrixViews.h.

References mrpt::math::CMatrixColumnAccessor< MAT >::size().

template<typename MAT>
size_t mrpt::math::CMatrixRowAccessor< MAT >::size (  )  const [inline]

Definition at line 869 of file CMatrixViews.h.

References mrpt::math::CMatrixColumnAccessor< MAT >::m_mat.

template<typename MAT>
mrpt_autotype& mrpt::math::CMatrixRowAccessor< MAT >::Sqrt (  )  [inline]

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
mrpt_autotype& mrpt::math::CMatrixRowAccessor< MAT >::Square (  )  [inline]

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
value_type mrpt::math::CMatrixRowAccessor< MAT >::squareNorm (  )  const [inline]

Return the square norm of the container (for matrices, as if it were a vector with all its elements).

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
double mrpt::math::CMatrixRowAccessor< MAT >::std ( bool  unbiased = true  )  const [inline]

Return the standard deviation of all the elements in the container.

Definition at line 836 of file CMatrixViews.h.

template<typename MAT>
value_type mrpt::math::CMatrixRowAccessor< MAT >::sumAll (  )  const [inline]

Sum all the elements

Definition at line 836 of file CMatrixViews.h.


Member Data Documentation

template<typename MAT>
MAT* mrpt::math::CMatrixRowAccessor< MAT >::m_mat [protected]

Definition at line 829 of file CMatrixViews.h.

template<typename MAT>
size_t mrpt::math::CMatrixRowAccessor< MAT >::m_rowInd [protected]

Definition at line 830 of file CMatrixViews.h.




Page generated by Doxygen 1.7.1 for MRPT 0.8.1 SVN:exported at Sun Sep 19 14:53:45 UTC 2010