Main MRPT website > C++ reference
MRPT logo

mrpt::mrpt_base_vector< _TYPE > Struct Template Reference

Numeric vectors compatible with mrpt/math/ops_containers.h:. More...

#include <mrpt/utils/types.h>

Inheritance diagram for mrpt::mrpt_base_vector< _TYPE >:
Inheritance graph
[legend]
Collaboration diagram for mrpt::mrpt_base_vector< _TYPE >:
Collaboration graph
[legend]

List of all members.

Classes

struct  mrpt_container

Public Types

typedef mrpt_base_vector< _TYPE > mrpt_autotype

Public Member Functions

 mrpt_base_vector ()
 mrpt_base_vector (const std::vector< _TYPE > &o)
mrpt_base_vector< _TYPE > & operator= (const std::vector< _TYPE > &o)
 mrpt_base_vector (size_t N)
 mrpt_base_vector (size_t N, _TYPE val)
template<typename ITERATOR >
 mrpt_base_vector (const ITERATOR &b, const ITERATOR &e)
Methods common to all containers



size_t countNonZero () const
void fill (const _TYPE &val)
_TYPE maximum (size_t *maxIndex=NULL) const
_TYPE minimum (size_t *minIndex=NULL) const
void minimum_maximum (_TYPE &out_min, _TYPE &out_max, size_t *minIndex=NULL, size_t *maxIndex=NULL) const
_TYPE norm_inf (size_t *maxIndex=NULL) const
_TYPE sumAll () const
template<typename RET_TYPE >
RET_TYPE sumAllRetType () 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
std::vector< double > histogram (double limit_min, double limit_max, size_t number_bins, bool do_normalization=false) const
template<class F >
mrpt_autotypeapplyToAllElements (_TYPE(*function)(_TYPE))
mrpt_autotypeSqrt ()
mrpt_autotypeAbs ()
mrpt_autotypeSquare ()
mrpt_autotypeExp ()
mrpt_autotypeLog ()
_TYPE squareNorm () const
_TYPE norm () const
double mean () const
void adjustRange (const _TYPE min_val, const _TYPE max_val)
void normalize (const _TYPE min_val=0, const _TYPE max_val=1)
double std (bool unbiased=true) const
void meanAndStd (double &out_mean, double &out_std, bool unbiased=true)

Detailed Description

template<typename _TYPE>
struct mrpt::mrpt_base_vector< _TYPE >

Numeric vectors compatible with mrpt/math/ops_containers.h:.

Definition at line 166 of file types.h.


Member Typedef Documentation

template<typename _TYPE>
typedef mrpt_base_vector<_TYPE> mrpt::mrpt_base_vector< _TYPE >::mrpt_autotype

Definition at line 174 of file types.h.


Constructor & Destructor Documentation

template<typename _TYPE>
mrpt::mrpt_base_vector< _TYPE >::mrpt_base_vector (  )  [inline]

Definition at line 168 of file types.h.

template<typename _TYPE>
mrpt::mrpt_base_vector< _TYPE >::mrpt_base_vector ( const std::vector< _TYPE > &  o  )  [inline]

Definition at line 169 of file types.h.

template<typename _TYPE>
mrpt::mrpt_base_vector< _TYPE >::mrpt_base_vector ( size_t  N  )  [inline]

Definition at line 171 of file types.h.

template<typename _TYPE>
mrpt::mrpt_base_vector< _TYPE >::mrpt_base_vector ( size_t  N,
_TYPE  val 
) [inline]

Definition at line 172 of file types.h.

template<typename _TYPE>
template<typename ITERATOR >
mrpt::mrpt_base_vector< _TYPE >::mrpt_base_vector ( const ITERATOR &  b,
const ITERATOR &  e 
) [inline]

Definition at line 173 of file types.h.


Member Function Documentation

template<typename _TYPE>
mrpt_autotype& mrpt::mrpt_base_vector< _TYPE >::Abs (  )  [inline]

Definition at line 177 of file types.h.

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

Definition at line 177 of file types.h.

template<typename _TYPE>
template<class F >
mrpt_autotype& mrpt::mrpt_base_vector< _TYPE >::applyToAllElements ( _TYPE(*)(_TYPE)  function  )  [inline]

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

Definition at line 177 of file types.h.

template<typename _TYPE>
template<class CONTAINER2 >
size_t mrpt::mrpt_base_vector< _TYPE >::countCommonElements ( const CONTAINER2 &  b  )  const [inline]

Definition at line 177 of file types.h.

template<typename _TYPE>
size_t mrpt::mrpt_base_vector< _TYPE >::countNonZero (  )  const [inline]

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

Definition at line 177 of file types.h.

template<typename _TYPE>
template<class CONTAINEROUT >
CONTAINEROUT mrpt::mrpt_base_vector< _TYPE >::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 177 of file types.h.

template<typename _TYPE>
template<class CONTAINEROUT >
void mrpt::mrpt_base_vector< _TYPE >::cumsum ( CONTAINEROUT &  out  )  const [inline]

Cumsum of all the elements, saving in an output container

Definition at line 177 of file types.h.

template<typename _TYPE>
mrpt_autotype& mrpt::mrpt_base_vector< _TYPE >::Exp (  )  [inline]

Definition at line 177 of file types.h.

template<typename _TYPE>
void mrpt::mrpt_base_vector< _TYPE >::fill ( const _TYPE &  val  )  [inline]

Fill all the elements with a given value

Definition at line 177 of file types.h.

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

Definition at line 177 of file types.h.

template<typename _TYPE>
mrpt_autotype& mrpt::mrpt_base_vector< _TYPE >::Log (  )  [inline]

Definition at line 177 of file types.h.

template<typename _TYPE>
_TYPE mrpt::mrpt_base_vector< _TYPE >::maximum ( size_t *  maxIndex = NULL  )  const [inline]

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

Definition at line 177 of file types.h.

template<typename _TYPE>
double mrpt::mrpt_base_vector< _TYPE >::mean (  )  const [inline]

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

Definition at line 177 of file types.h.

template<typename _TYPE>
void mrpt::mrpt_base_vector< _TYPE >::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 177 of file types.h.

template<typename _TYPE>
_TYPE mrpt::mrpt_base_vector< _TYPE >::minimum ( size_t *  minIndex = NULL  )  const [inline]

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

Definition at line 177 of file types.h.

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

Minimum and maximum of a vector at once

Definition at line 177 of file types.h.

template<typename _TYPE>
_TYPE mrpt::mrpt_base_vector< _TYPE >::norm (  )  const [inline]

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

Definition at line 177 of file types.h.

template<typename _TYPE>
_TYPE mrpt::mrpt_base_vector< _TYPE >::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 177 of file types.h.

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

Definition at line 177 of file types.h.

template<typename _TYPE>
mrpt_base_vector<_TYPE>& mrpt::mrpt_base_vector< _TYPE >::operator= ( const std::vector< _TYPE > &  o  )  [inline]

Definition at line 170 of file types.h.

Referenced by mrpt::mrpt_base_vector< NUM >::operator=().

template<typename _TYPE>
mrpt_autotype& mrpt::mrpt_base_vector< _TYPE >::Sqrt (  )  [inline]

Definition at line 177 of file types.h.

template<typename _TYPE>
mrpt_autotype& mrpt::mrpt_base_vector< _TYPE >::Square (  )  [inline]

Definition at line 177 of file types.h.

template<typename _TYPE>
_TYPE mrpt::mrpt_base_vector< _TYPE >::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 177 of file types.h.

template<typename _TYPE>
double mrpt::mrpt_base_vector< _TYPE >::std ( bool  unbiased = true  )  const [inline]

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

Definition at line 177 of file types.h.

template<typename _TYPE>
_TYPE mrpt::mrpt_base_vector< _TYPE >::sumAll (  )  const [inline]

Sum all the elements, returning a value of the same type than the container

Definition at line 177 of file types.h.

template<typename _TYPE>
template<typename RET_TYPE >
RET_TYPE mrpt::mrpt_base_vector< _TYPE >::sumAllRetType (  )  const [inline]

Sum all the elements, returning a value of a custom type (this could be used to avoid overflow with containers of integers)

Definition at line 177 of file types.h.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



Page generated by Doxygen 1.6.1 for MRPT 0.9.0 SVN: at Mon Jun 7 06:47:58 UTC 2010