STK_Stat_Bivariate.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 statistics for two variables.
 * Author:   Serge Iovleff, serge.iovleff@stkpp.org
 **/

#ifndef STK_STAT_BIVARIATE_H
#define STK_STAT_BIVARIATE_H

#include "../../Sdk/include/STK_ITContainer1D.h"

#include "../include/STK_Stat_Univariate.h"

namespace STK
{
namespace Stat
{

template < class XTYPE, class YTYPE, class TContainer1D >
class Bivariate
{
  protected:
    Univariate<XTYPE, TContainer1D>    xStat_;
    Univariate<YTYPE, TContainer1D>    yStat_;

  public:
    Bivariate( ITContainer1D<XTYPE, TContainer1D> const& X
             , ITContainer1D<YTYPE, TContainer1D> const& Y
             )
             : xStat_(X)
             , yStat_(Y)
    {}

    Bivariate( const Bivariate& stat)
              : xStat_(stat.xStat_)
              , yStat_(stat.yStat_)
    { ;}
    
    virtual ~Bivariate() { ;}
  
    Bivariate& operator=( const Bivariate& stat)
    {
      xStat_ = stat.xStat_;
      yStat_ = stat.yStat_;
      return *this;
    }

    void setData( TContainer1D const& X,  TContainer1D const& Y)
    {
      xStat_.setData(X);
      yStat_.setData(Y);
    }

    inline Univariate<XTYPE, TContainer1D> xStat() const {return xStat_;}
    inline Univariate<YTYPE, TContainer1D> yStat() const {return yStat_;}
 };
  
  
}  // namespace Stat

}  // namespace STK

#endif /*STK_STAT_BIVARIATE_H*/