STK::Stat::Univariate< TYPE, TContainer1D > Class Template Reference
[The Sub-project STatistiK::StatDesc]

Computation of the univariate Statistics of a Variable. More...

#include <STK_Stat_Univariate.h>

List of all members.

Public Member Functions
	Univariate (const TContainer1D &V=TContainer1D())
	Univariate (const Univariate &stat)
virtual	~Univariate ()
Univariate &	operator= (const Univariate &stat)
Univariate &	setVariable (const TContainer1D &V)
const Integer	getN () const
const Integer	getNobs () const
const Integer	getNmiss () const
Protected Attributes
Integer	n_
	Number of observations.
Integer	nobs_
	Number of Available observations.
Integer	nmiss_
	Number of missing observations.

---

Detailed Description

template<class TYPE, class TContainer1D>
class STK::Stat::Univariate< TYPE, TContainer1D >

The template parameter TContainer1D is the type of container used for storing the data : It should derive from ITContainer1D and contain elements of type TYPE.

The template parameter TYPE is the Type of the data to analyze.

Definition at line 69 of file STK_Stat_Univariate.h.

---

Constructor & Destructor Documentation

template<class TYPE , class TContainer1D >

STK::Stat::Univariate< TYPE, TContainer1D >::Univariate

(

const TContainer1D &

V = TContainer1D()

)

[inline]

Default Ctor. Compute the number of available observations and of missing observations of the variable V.

Parameters:

V

variable to parse

Definition at line 83 of file STK_Stat_Univariate.h.

References STK::Stat::Univariate< TYPE, TContainer1D >::nmiss_, and STK::Stat::Univariate< TYPE, TContainer1D >::nobs_.

              : n_(V.size())
              , nobs_(V.size())
              , nmiss_(0)
    {
      // loop over all observations 
      for (Integer i=V.last(); i>=V.first(); --i)
        // not finite ?
        if (!Arithmetic<TYPE>::isFinite(V[i]))
        {
          nobs_--;         // decrease nobs_
          nmiss_++;        // increase nmiss_
        }
     }

template<class TYPE , class TContainer1D >

STK::Stat::Univariate< TYPE, TContainer1D >::Univariate

(

const Univariate< TYPE, TContainer1D > &

stat

)

[inline]

Copy Ctor.

Parameters:

stat

the statistics to copy

Definition at line 101 of file STK_Stat_Univariate.h.

              : n_(stat.n_)
              , nobs_(stat.nobs_)
              , nmiss_(stat.nmiss_)
    { ;}

template<class TYPE , class TContainer1D >

virtual STK::Stat::Univariate< TYPE, TContainer1D >::~Univariate

(

)

[inline, virtual]

virtual Dtor.

Definition at line 109 of file STK_Stat_Univariate.h.

{ ;}

---

Member Function Documentation

template<class TYPE , class TContainer1D >

Univariate& STK::Stat::Univariate< TYPE, TContainer1D >::operator=

(

const Univariate< TYPE, TContainer1D > &

stat

)

[inline]

Operator = : overwrite the Univariate with stat.

Definition at line 114 of file STK_Stat_Univariate.h.

References STK::Stat::Univariate< TYPE, TContainer1D >::n_, STK::Stat::Univariate< TYPE, TContainer1D >::nmiss_, and STK::Stat::Univariate< TYPE, TContainer1D >::nobs_.

    {
      n_     = stat.n_;
      nobs_  = stat.nobs_;
      nmiss_ = stat.nmiss_;
      
      return *this;
    }

template<class TYPE , class TContainer1D >

Univariate& STK::Stat::Univariate< TYPE, TContainer1D >::setVariable

(

const TContainer1D &

V

)

[inline]

set a new Variable.

Definition at line 126 of file STK_Stat_Univariate.h.

References STK::Stat::Univariate< TYPE, TContainer1D >::n_, STK::Stat::Univariate< TYPE, TContainer1D >::nmiss_, and STK::Stat::Univariate< TYPE, TContainer1D >::nobs_.

    {
      n_     = V.size();
      nobs_  = V.size();
      nmiss_ = 0;
      // loop over all observations 
      for (Integer i=V.last(); i>=V.first(); i--)
        if (!Arithmetic<TYPE>::isFinite(V[i])) // not finite ?
        {
          nobs_--;         // decrease nobs_
          nmiss_++;        // increase nmiss_
        }

      return *this;
    }

template<class TYPE , class TContainer1D >

const Integer STK::Stat::Univariate< TYPE, TContainer1D >::getN

(

)

const [inline]

Number of observations

Definition at line 145 of file STK_Stat_Univariate.h.

References STK::Stat::Univariate< TYPE, TContainer1D >::n_.

{return n_;}

template<class TYPE , class TContainer1D >

const Integer STK::Stat::Univariate< TYPE, TContainer1D >::getNobs

(

)

const [inline]

Number of available observations (not missing)

Definition at line 148 of file STK_Stat_Univariate.h.

References STK::Stat::Univariate< TYPE, TContainer1D >::nobs_.

{return nobs_;}

template<class TYPE , class TContainer1D >

const Integer STK::Stat::Univariate< TYPE, TContainer1D >::getNmiss

(

)

const [inline]

Number of missing observations

Definition at line 151 of file STK_Stat_Univariate.h.

References STK::Stat::Univariate< TYPE, TContainer1D >::nmiss_.

{return nmiss_;}

---

Member Data Documentation

template<class TYPE , class TContainer1D >

Integer STK::Stat::Univariate< TYPE, TContainer1D >::n_ [protected]

Definition at line 72 of file STK_Stat_Univariate.h.

Referenced by STK::Stat::Univariate< Real, TContainer1D >::getN(), STK::Stat::Univariate< TYPE, TContainer1D >::getN(), STK::Stat::Univariate< Real, TContainer1D >::operator=(), STK::Stat::Univariate< TYPE, TContainer1D >::operator=(), STK::Stat::Univariate< Real, TContainer1D >::setVariable(), and STK::Stat::Univariate< TYPE, TContainer1D >::setVariable().

template<class TYPE , class TContainer1D >

Integer STK::Stat::Univariate< TYPE, TContainer1D >::nobs_ [protected]

Definition at line 73 of file STK_Stat_Univariate.h.

Referenced by STK::Stat::Univariate< Real, TContainer1D >::compOrderStatistics(), STK::Stat::Univariate< Real, TContainer1D >::compQuantiles(), STK::Stat::Univariate< Real, TContainer1D >::compStatistics(), STK::Stat::Univariate< Real, TContainer1D >::compWeightedStatistics(), STK::Stat::Univariate< Real, TContainer1D >::getNobs(), STK::Stat::Univariate< TYPE, TContainer1D >::getNobs(), STK::Stat::Univariate< Real, TContainer1D >::initializeVariable(), STK::Stat::Univariate< Real, TContainer1D >::initializeVariableAndWeights(), STK::Stat::Univariate< Real, TContainer1D >::operator=(), STK::Stat::Univariate< TYPE, TContainer1D >::operator=(), STK::Stat::Univariate< Real, TContainer1D >::setVariable(), STK::Stat::Univariate< TYPE, TContainer1D >::setVariable(), and STK::Stat::Univariate< TYPE, TContainer1D >::Univariate().

template<class TYPE , class TContainer1D >

Integer STK::Stat::Univariate< TYPE, TContainer1D >::nmiss_ [protected]

Definition at line 74 of file STK_Stat_Univariate.h.

Referenced by STK::Stat::Univariate< Real, TContainer1D >::getNmiss(), STK::Stat::Univariate< TYPE, TContainer1D >::getNmiss(), STK::Stat::Univariate< Real, TContainer1D >::initializeVariable(), STK::Stat::Univariate< Real, TContainer1D >::initializeVariableAndWeights(), STK::Stat::Univariate< Real, TContainer1D >::operator=(), STK::Stat::Univariate< TYPE, TContainer1D >::operator=(), STK::Stat::Univariate< Real, TContainer1D >::setVariable(), STK::Stat::Univariate< TYPE, TContainer1D >::setVariable(), and STK::Stat::Univariate< TYPE, TContainer1D >::Univariate().

---

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

• STK_Stat_Univariate.h