MRPT logo
Classes | Public Types | Private Attributes

mrpt::math::CVectorRowWrapper< VEC > Class Template Reference

#include <mrpt/math/CMatrixViews.h>

Inheritance diagram for mrpt::math::CVectorRowWrapper< VEC >:
Inheritance graph
[legend]
Collaboration diagram for mrpt::math::CVectorRowWrapper< VEC >:
Collaboration graph
[legend]

List of all members.

Classes

struct  mrpt_container

Public Types

enum  dummy_enum { mrpt_matrix_type_ncols = -1, mrpt_matrix_type_nrows = -1 }
typedef CVectorRowWrapper< VEC > mrpt_autotype

Public Member Functions

Methods common to all containers

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)
Methods common to all matrices

mrpt_autotype operator+ ()
mrpt_autotype operator- () const
mrpt_autotype & operator+= (const value_type n)
mrpt_autotype & operator-= (const value_type n)
mrpt_autotype & operator*= (const value_type n)
mrpt_autotype & operator/= (const value_type n)

Private Attributes

VEC & vec

Detailed Description

template<typename VEC>
class mrpt::math::CVectorRowWrapper< VEC >

Definition at line 1043 of file CMatrixViews.h.


Member Typedef Documentation

template<typename VEC >
typedef CVectorRowWrapper<VEC> mrpt::math::CVectorRowWrapper< VEC >::mrpt_autotype

Definition at line 1047 of file CMatrixViews.h.


Member Enumeration Documentation

template<typename VEC >
enum mrpt::math::CVectorRowWrapper::dummy_enum
Enumerator:
mrpt_matrix_type_ncols 
mrpt_matrix_type_nrows 

Definition at line 1050 of file CMatrixViews.h.


Member Function Documentation

template<typename VEC >
mrpt_autotype& mrpt::math::CVectorRowWrapper< VEC >::Abs (  )  [inline]

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
void mrpt::math::CVectorRowWrapper< VEC >::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 1052 of file CMatrixViews.h.

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

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

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
template<class CONTAINER2 >
size_t mrpt::math::CVectorRowWrapper< VEC >::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 1052 of file CMatrixViews.h.

template<typename VEC >
size_t mrpt::math::CVectorRowWrapper< VEC >::countNonZero (  )  const [inline]

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

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
template<class CONTAINEROUT >
CONTAINEROUT mrpt::math::CVectorRowWrapper< VEC >::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 1052 of file CMatrixViews.h.

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

Cumsum of all the elements, saving in an output container

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
mrpt_autotype& mrpt::math::CVectorRowWrapper< VEC >::Exp (  )  [inline]

Definition at line 1052 of file CMatrixViews.h.

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

Fill all the elements with a given value

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
std::vector<double> mrpt::math::CVectorRowWrapper< VEC >::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 1052 of file CMatrixViews.h.

template<typename VEC >
mrpt_autotype& mrpt::math::CVectorRowWrapper< VEC >::Log (  )  [inline]

Definition at line 1052 of file CMatrixViews.h.

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

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

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
value_type mrpt::math::CVectorRowWrapper< VEC >::mean (  )  const [inline]

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

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
void mrpt::math::CVectorRowWrapper< VEC >::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 1052 of file CMatrixViews.h.

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

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

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
void mrpt::math::CVectorRowWrapper< VEC >::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 1052 of file CMatrixViews.h.

template<typename VEC >
value_type mrpt::math::CVectorRowWrapper< VEC >::norm (  )  const [inline]

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

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
value_type mrpt::math::CVectorRowWrapper< VEC >::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 1052 of file CMatrixViews.h.

template<typename VEC >
void mrpt::math::CVectorRowWrapper< VEC >::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 1052 of file CMatrixViews.h.

template<typename VEC >
mrpt_autotype& mrpt::math::CVectorRowWrapper< VEC >::operator*= ( const value_type  n  )  [inline]
Parameters:
n Multiply by scalar

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
mrpt_autotype mrpt::math::CVectorRowWrapper< VEC >::operator+ (  )  [inline]

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
mrpt_autotype& mrpt::math::CVectorRowWrapper< VEC >::operator+= ( const value_type  n  )  [inline]
Parameters:
n Sum a scalar

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
mrpt_autotype mrpt::math::CVectorRowWrapper< VEC >::operator- (  )  const [inline]

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
mrpt_autotype& mrpt::math::CVectorRowWrapper< VEC >::operator-= ( const value_type  n  )  [inline]
Parameters:
n Substract a scalar

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
mrpt_autotype& mrpt::math::CVectorRowWrapper< VEC >::operator/= ( const value_type  n  )  [inline]
Parameters:
n Divide by scalar

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
mrpt_autotype& mrpt::math::CVectorRowWrapper< VEC >::Sqrt (  )  [inline]

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
mrpt_autotype& mrpt::math::CVectorRowWrapper< VEC >::Square (  )  [inline]

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
value_type mrpt::math::CVectorRowWrapper< VEC >::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 1052 of file CMatrixViews.h.

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

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

Definition at line 1052 of file CMatrixViews.h.

template<typename VEC >
value_type mrpt::math::CVectorRowWrapper< VEC >::sumAll (  )  const [inline]

Sum all the elements

Definition at line 1052 of file CMatrixViews.h.


Member Data Documentation

template<typename VEC >
VEC& mrpt::math::CVectorRowWrapper< VEC >::vec [private]

Definition at line 1045 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