STK++ 1.0
Public Member Functions | Protected Attributes
STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D > Class Template Reference
The descriptive statistics sub-project.

Computation of the bivariate Statistics of two Variables. More...

#include <STK_Stat_Bivariate.h>

Collaboration diagram for STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 Bivariate (ITContainer1D< XTYPE, TContainer1D > const &X, ITContainer1D< YTYPE, TContainer1D > const &Y)
 Default constructor.
 Bivariate (const Bivariate &stat)
 Copy constructor.
virtual ~Bivariate ()
 virtual destructor.
Bivariate & operator= (const Bivariate &stat)
 Operator = : overwrite the Bivariate with stat.
void setData (TContainer1D const &X, TContainer1D const &Y)
 set a new data sets
Univariate< XTYPE, TContainer1D > xStat () const
 get statistics of the first variable
Univariate< YTYPE, TContainer1D > yStat () const
 get statistics of the second variable

Protected Attributes

Univariate< XTYPE, TContainer1D > xStat_
 Statistics of the X variable.
Univariate< YTYPE, TContainer1D > yStat_
 Statistics of the Y variable.

Detailed Description

template<class XTYPE, class YTYPE, class TContainer1D>
class STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >

Computation of the bivariate Statistics of two Variables.

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_Bivariate.h.

Constructor & Destructor Documentation

template<class XTYPE , class YTYPE , class TContainer1D >
STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::Bivariate ( ITContainer1D< XTYPE, TContainer1D > const &  X,
ITContainer1D< YTYPE, TContainer1D > const &  Y 
) [inline]

Default constructor.

Compute the univariate statistics of the two variables.

Parameters:
Xthe first variable
Ythe second variable

Definition at line 71 of file STK_Stat_Bivariate.h.

             : xStat_(X)
             , yStat_(Y)
    {}
template<class XTYPE , class YTYPE , class TContainer1D >
STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::Bivariate ( const Bivariate< XTYPE, YTYPE, TContainer1D > &  stat) [inline]

Copy constructor.

Parameters:
statthe statistics to copy

Definition at line 81 of file STK_Stat_Bivariate.h.

              : xStat_(stat.xStat_)
              , yStat_(stat.yStat_)
    { ;}
template<class XTYPE , class YTYPE , class TContainer1D >
virtual STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::~Bivariate ( ) [inline, virtual]

virtual destructor.

Definition at line 87 of file STK_Stat_Bivariate.h.

{ ;}

Member Function Documentation

template<class XTYPE , class YTYPE , class TContainer1D >
Bivariate& STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::operator= ( const Bivariate< XTYPE, YTYPE, TContainer1D > &  stat) [inline]

Operator = : overwrite the Bivariate with stat.

Parameters:
statthe statistics to copy
Returns:
this object

Definition at line 93 of file STK_Stat_Bivariate.h.

References STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::xStat_, and STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::yStat_.

    {
      xStat_ = stat.xStat_;
      yStat_ = stat.yStat_;
      return *this;
    }
template<class XTYPE , class YTYPE , class TContainer1D >
void STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::setData ( TContainer1D const &  X,
TContainer1D const &  Y 
) [inline]

set a new data sets

Parameters:
Xthe first variable
Ythe second variable

Definition at line 104 of file STK_Stat_Bivariate.h.

References STK::Stat::Univariate< TYPE, TContainer1D >::setData(), STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::xStat_, and STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::yStat_.

    {
      xStat_.setData(X);
      yStat_.setData(Y);
    }

Here is the call graph for this function:

template<class XTYPE , class YTYPE , class TContainer1D >
Univariate<XTYPE, TContainer1D> STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::xStat ( ) const [inline]

get statistics of the first variable

Definition at line 111 of file STK_Stat_Bivariate.h.

References STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::xStat_.

{return xStat_;}
template<class XTYPE , class YTYPE , class TContainer1D >
Univariate<YTYPE, TContainer1D> STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::yStat ( ) const [inline]

get statistics of the second variable

Definition at line 113 of file STK_Stat_Bivariate.h.

References STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::yStat_.

{return yStat_;}

Member Data Documentation

template<class XTYPE , class YTYPE , class TContainer1D >
Univariate<XTYPE, TContainer1D> STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::xStat_ [protected]

Statistics of the X variable.

Definition at line 61 of file STK_Stat_Bivariate.h.

Referenced by STK::Stat::Bivariate< Real, Real, TContainer1D >::compCovariance(), STK::Stat::Bivariate< Real, Real, TContainer1D >::compWeightedCovariance(), STK::Stat::Bivariate< Real, Real, TContainer1D >::operator=(), STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::operator=(), STK::Stat::Bivariate< Real, Real, TContainer1D >::setData(), STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::setData(), STK::Stat::Bivariate< Real, Real, TContainer1D >::xStat(), and STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::xStat().

template<class XTYPE , class YTYPE , class TContainer1D >
Univariate<YTYPE, TContainer1D> STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::yStat_ [protected]

Statistics of the Y variable.

Definition at line 63 of file STK_Stat_Bivariate.h.

Referenced by STK::Stat::Bivariate< Real, Real, TContainer1D >::compCovariance(), STK::Stat::Bivariate< Real, Real, TContainer1D >::compWeightedCovariance(), STK::Stat::Bivariate< Real, Real, TContainer1D >::operator=(), STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::operator=(), STK::Stat::Bivariate< Real, Real, TContainer1D >::setData(), STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::setData(), STK::Stat::Bivariate< Real, Real, TContainer1D >::yStat(), and STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::yStat().

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