anna::Average< T > Class Template Reference

#include <Average.hpp>

Public Member Functions
	Average (const char *name, const char *measure=NULL)
bool	isEmpty () const
bool	isZero () const
int	size () const
T	getAccumulator () const
T	value () const
void	clear ()
void	setValue (const T &value, const unsigned int _n)
	operator T () const
Average< T > &	operator= (const T value)
Average< T > &	operator= (const Average< T > &other)
Average< T > &	operator+= (const T &v)
Average< T > &	operator-= (const T v)
std::string	asString () const

Detailed Description

template<class T>
class anna::Average< T >

Template para calcular la media de una sucesion de valores numericos.

Internamente trabaja con Microsegundos porque los métodos que los proporcionan son más eficientes.

Constructor & Destructor Documentation

Average()

template<class T>

anna::Average< T >::Average ( const char *  name, const char *  measure = NULL  )

inline

Constructor.

Parameters

name	Nombre logico de esta instancia.
measure	Unidad de medida. Solo se usa a efecto de salida de datos.

                                                        :
    a_name(name), a_accumulator(0), a_n(0), a_measure(measure) {;}

Member Function Documentation

asString()

template<class T>

std::string anna::Average< T >::asString ( void  ) const

inline

Devuelve una cadena con la informacion referente a esta clase.

Returns

Una cadena con la informacion referente a esta clase.

  {
    std::string msg(a_name);
    msg += " { Accumulate: ";
    msg += functions::asString(a_accumulator);

    if(a_measure != NULL)
      msg += " " + std::string(a_measure);

    msg += functions::asString(" | N: %u | avg: ", a_n);
    msg += functions::asString(value());

    if(a_measure != NULL)
      msg += " " + std::string(a_measure);

    return msg += " }";
  }

clear()

template<class T>

void anna::Average< T >::clear ( )

inline

Inicializa el valor de la media.

{  a_accumulator = 0; a_n = 0; }

getAccumulator()

template<class T>

T anna::Average< T >::getAccumulator ( ) const

inline

Devuelve el valor acumulado.

Returns

el valor acumulado.

{ return a_accumulator; }

isEmpty()

template<class T>

bool anna::Average< T >::isEmpty ( ) const

inline

Devuelve el indicador de validez de esta media.

Returns

true Si la media no tiene ningun valor o false en caso contrario.

{ return (a_n == 0); }

isZero()

template<class T>

bool anna::Average< T >::isZero ( ) const

inline

Devuelve true si el valor de la media es cero, bien por no tener valores o bien porque todos ellos eran cero.

Returns

true el valor de la media es cero o false en otro caso.

{ return a_n == 0 || a_accumulator == 0; }

operator T()

template<class T>

anna::Average< T >::operator T ( ) const

inline

Devuelve la media de la sucesion de valores numericos asociados a esta.

Returns

La media de la sucesion de valores numericos asociados a esta.

Warning

Antes de invocar a este operador hay que verificar que isEmpty devuelve false.

{ return value(); }

operator+=()

template<class T>

Average<T>& anna::Average< T >::operator+= ( const T &  v )

inline

Incrementa la media con el valor recibido.

Parameters

v	Valor con el que incrementar la media.

Returns

La referencia a esta instancia.

  {
    const T backup(a_accumulator);

    if((a_accumulator += v) < backup) {
      a_accumulator = v;
      a_n = 1;
    } else
      a_n ++;

    return *this;
  }

operator-=()

template<class T>

Average<T>& anna::Average< T >::operator-= ( const T  v )

inline

Decrementa la media con el valor recibido.

Parameters

v	Valor con el que incrementar la media.

Returns

La referencia a esta instancia.

  {
    if(a_accumulator > v && a_n > 1) {
      a_accumulator -= v;
      a_n --;
    } else {
      a_accumulator = 0;
      a_n = 0;
    }

    return *this;
  }

operator=() [1/2]

template<class T>

Average<T>& anna::Average< T >::operator= ( const T  value )

inline

Inicializa el valor de esta media.

Parameters

value

Valor con el que iniciar la media.

Returns

La referencia a esta instancia.

  {
    a_accumulator = value;
    a_n = 1;
    return *this;
  }

operator=() [2/2]

template<class T>

Average<T>& anna::Average< T >::operator= ( const Average< T > &  other )

inline

Contructor copia.

Parameters

other

Objeto del que obtener los valores.

Returns

La referencia a esta instancia.

  {
    a_accumulator = other.a_accumulator;
    a_n = other.a_n;
    return *this;
  }

setValue()

template<class T>

void anna::Average< T >::setValue ( const T &  value, const unsigned int  _n  )

inline

Establece manualmente el valor de la estadística.

Parameters

value	Valor que tomará el acumulador de este instancia.
_n	valor que tomará el conteador de esta instancia.

                                                       {
    a_accumulator = value;
    a_n = _n;
  }

size()

template<class T>

int anna::Average< T >::size ( ) const

inline

Devuelve el numero de elementos de contiene la media.

Returns

el numero de elementos de contiene la media.

{ return a_n; }

value()

template<class T>

T anna::Average< T >::value ( ) const

inline

Devuelve la media de la sucesion de valores numericos asociados a esta.

Returns

La media de la sucesion de valores numericos asociados a esta.

Warning

Antes de invocar a este operador hay que verificar que isEmpty devuelve false.

{ return (isEmpty() == true) ? T(0) : (a_accumulator / a_n);  }

---

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

• /tmp/anna/include/anna/core/util/Average.hpp