STK_Stat_Univariate.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2011  Serge Iovleff

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this program; if not, write to the
    Free Software Foundation, Inc.,
    59 Temple Place,
    Suite 330,
    Boston, MA 02111-1307
    USA

    Contact : Serge.Iovleff@stkpp.org
*/

/*
 * Project:  stkpp::StatDesc
 * Purpose:  Compute elementary 1D statistics for all variables.
 * Author:   Serge Iovleff, serge.iovleff@stkpp.org
 **/

#ifndef STK_STAT_UNIVARIATE_H
#define STK_STAT_UNIVARIATE_H

#include "../../STKernel/include/STK_Integer.h"
#include "../../STKernel/include/STK_Real.h"

namespace STK
{
namespace Stat
{

template < class TYPE, class TContainer1D >
class Univariate
{
  public:
    Univariate( ITContainer1D<TYPE, TContainer1D> const& V )
              : 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_
        }
     }

    Univariate( Univariate const& stat)
              : nbSamples_(stat.n_)
              , nobs_(stat.nobs_)
              , nbMiss_(stat.nbMiss_)
    { ;}
    
    virtual ~Univariate() { ;}
  
    Univariate& operator=( Univariate const& stat)
    {
      nbSamples_     = stat.n_;
      nobs_  = stat.nobs_;
      nbMiss_ = stat.nbMiss_;
      return *this;
    }

    void setData( TContainer1D const& V)
    {
      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;
    }

    inline Integer const& nbSamples() const {return nbSamples_;}
    inline Integer const& nbAvailableObs() const {return nobs_;}
    inline Integer const& nbMissingSamples() const {return nbMiss_;}

  protected:
   Integer    nbSamples_;     
   Integer    nobs_;         
   Integer    nbMiss_;       
};
  
  
}  // namespace Stat

}  // namespace STK

#endif /*STK_STAT_UNIVARIATE_H*/