STK++ 1.0
Public Member Functions | Protected Attributes

STK::Stat::Univariate< TYPE, TContainer1D > Class Template Reference
The descriptive statistics sub-project.

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

#include <STK_Stat_Univariate.h>

List of all members.

Public Member Functions

 Univariate (ITContainer1D< TYPE, TContainer1D > const &V)
 Default constructor Compute the number of available observations and of missing observations of the variable V.
 Univariate (Univariate const &stat)
 Copy constructor.
virtual ~Univariate ()
 virtual destructor.
Univariate & operator= (Univariate const &stat)
 Operator = : overwrite the Univariate with stat.
void setData (TContainer1D const &V)
 set a new Variable.
Integer const & nbSamples () const
 get the number of observations
Integer const & nbAvailableObs () const
 get the number of available samples (not missing)
Integer const & nbMissingSamples () const
 get the number of missing samples

Protected Attributes

Integer nbSamples_
 Number of observations.
Integer nobs_
 Number of Available observations.
Integer nbMiss_
 Number of missing observations.

Detailed Description

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

Computation of the univariate Statistics of a Variable.

This is a base class that should be specialized or sub-classed. 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 57 of file STK_Stat_Univariate.h.

Constructor & Destructor Documentation

template<class TYPE, class TContainer1D>
STK::Stat::Univariate< TYPE, TContainer1D >::Univariate ( ITContainer1D< TYPE, TContainer1D > const &  V) [inline]

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

Parameters:
Vvariable to parse

Definition at line 65 of file STK_Stat_Univariate.h.

              : nbSamples_(V.size())
              , nobs_(V.size())
              , nbMiss_(0)
    {
      // loop over all observations 
      for (Integer i=V.last(); i>=V.first(); --i)
        // not finite ?
        if (!Arithmetic<TYPE>::isFinite(V[i]))
        {
          nobs_--;         // decrease nbAvailableObs_
          nbMiss_++;        // increase nbMissingObs_
        }
     }
template<class TYPE, class TContainer1D>
STK::Stat::Univariate< TYPE, TContainer1D >::Univariate ( Univariate< TYPE, TContainer1D > const &  stat) [inline]

Copy constructor.

Parameters:
statthe statistics to copy

Definition at line 83 of file STK_Stat_Univariate.h.

              : nbSamples_(stat.n_)
              , nobs_(stat.nobs_)
              , nbMiss_(stat.nbMiss_)
    { ;}
template<class TYPE, class TContainer1D>
virtual STK::Stat::Univariate< TYPE, TContainer1D >::~Univariate ( ) [inline, virtual]

virtual destructor.

Definition at line 90 of file STK_Stat_Univariate.h.

{ ;}

Member Function Documentation

template<class TYPE, class TContainer1D>
Univariate& STK::Stat::Univariate< TYPE, TContainer1D >::operator= ( Univariate< TYPE, TContainer1D > const &  stat) [inline]

Operator = : overwrite the Univariate with stat.

Parameters:
statthe Univariate object to copy
Returns:
this object

Definition at line 96 of file STK_Stat_Univariate.h.

    {
      nbSamples_     = stat.n_;
      nobs_  = stat.nobs_;
      nbMiss_ = stat.nbMiss_;
      return *this;
    }
template<class TYPE, class TContainer1D>
void STK::Stat::Univariate< TYPE, TContainer1D >::setData ( TContainer1D const &  V) [inline]

set a new Variable.

Parameters:
Vvariable to parse

Definition at line 107 of file STK_Stat_Univariate.h.

Referenced by STK::Stat::Bivariate< Real, Real, TContainer1D >::setData(), and STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::setData().

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

      return *this;
    }
template<class TYPE, class TContainer1D>
Integer const& STK::Stat::Univariate< TYPE, TContainer1D >::nbSamples ( ) const [inline]

get the number of observations

Returns:
the number of samples

Definition at line 126 of file STK_Stat_Univariate.h.

{return nbSamples_;}
template<class TYPE, class TContainer1D>
Integer const& STK::Stat::Univariate< TYPE, TContainer1D >::nbAvailableObs ( ) const [inline]

get the number of available samples (not missing)

Returns:
the number of available samples

Definition at line 130 of file STK_Stat_Univariate.h.

{return nobs_;}
template<class TYPE, class TContainer1D>
Integer const& STK::Stat::Univariate< TYPE, TContainer1D >::nbMissingSamples ( ) const [inline]

get the number of missing samples

Returns:
the number of missing values

Definition at line 134 of file STK_Stat_Univariate.h.

{return nbMiss_;}

Member Data Documentation

template<class TYPE, class TContainer1D>
Integer STK::Stat::Univariate< TYPE, TContainer1D >::nbSamples_ [protected]

Number of observations.

Definition at line 137 of file STK_Stat_Univariate.h.

Referenced by STK::Stat::Univariate< Real, TContainer1D >::nbSamples(), STK::Stat::Univariate< YTYPE, TContainer1D >::nbSamples(), STK::Stat::Univariate< Real, TContainer1D >::operator=(), STK::Stat::Univariate< YTYPE, TContainer1D >::operator=(), STK::Stat::Univariate< Real, TContainer1D >::setData(), and STK::Stat::Univariate< YTYPE, TContainer1D >::setData().

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

Number of Available observations.

Definition at line 138 of file STK_Stat_Univariate.h.

Referenced by STK::Stat::Univariate< YTYPE, TContainer1D >::nbAvailableObs(), STK::Stat::Univariate< YTYPE, TContainer1D >::operator=(), STK::Stat::Univariate< YTYPE, TContainer1D >::setData(), and STK::Stat::Univariate< YTYPE, TContainer1D >::Univariate().

template<class TYPE, class TContainer1D>
Integer STK::Stat::Univariate< TYPE, TContainer1D >::nbMiss_ [protected]

Number of missing observations.

Definition at line 139 of file STK_Stat_Univariate.h.

Referenced by STK::Stat::Univariate< Real, TContainer1D >::initializeVariable(), STK::Stat::Univariate< Real, TContainer1D >::initializeVariableAndWeights(), STK::Stat::Univariate< Real, TContainer1D >::nbMissingSamples(), STK::Stat::Univariate< YTYPE, TContainer1D >::nbMissingSamples(), STK::Stat::Univariate< Real, TContainer1D >::operator=(), STK::Stat::Univariate< YTYPE, TContainer1D >::operator=(), STK::Stat::Univariate< Real, TContainer1D >::setData(), STK::Stat::Univariate< YTYPE, TContainer1D >::setData(), and STK::Stat::Univariate< YTYPE, TContainer1D >::Univariate().

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