STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D > Class Template Reference

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

#include <STK_Stat_Bivariate.h>

Public Member Functions
	Bivariate (ITContainer< TContainer1D > const &X, ITContainer< 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< TContainer1D >	xStat_
	Statistics of the X variable.
Univariate< 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 ITContainer and contain elements of type TYPE.

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

Definition at line 55 of file STK_Stat_Bivariate.h.

Constructor & Destructor Documentation

Bivariate() [1/2]

template<class XTYPE , class YTYPE , class TContainer1D >

STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::Bivariate ( ITContainer< TContainer1D > const &  X, ITContainer< TContainer1D > const &  Y  )

inline

Default constructor.

Compute the univariate statistics of the two variables.

Parameters

X	the first variable
Y	the second variable

Definition at line 69 of file STK_Stat_Bivariate.h.

             : xStat_(X)
             , yStat_(Y)
    {}

Bivariate() [2/2]

template<class XTYPE , class YTYPE , class TContainer1D >

STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::Bivariate ( const Bivariate< XTYPE, YTYPE, TContainer1D > &  stat )

inline

Copy constructor.

Parameters

stat	the statistics to copy

Definition at line 79 of file STK_Stat_Bivariate.h.

              : xStat_(stat.xStat_)
              , yStat_(stat.yStat_)
    { ;}

~Bivariate()

template<class XTYPE , class YTYPE , class TContainer1D >

virtual STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::~Bivariate ( )

inlinevirtual

virtual destructor.

Definition at line 85 of file STK_Stat_Bivariate.h.

{ ;}

Member Function Documentation

operator=()

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

stat	the statistics to copy

Returns

this object

Definition at line 91 of file STK_Stat_Bivariate.h.

    {
      xStat_ = stat.xStat_;
      yStat_ = stat.yStat_;
      return *this;
    }

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

setData()

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

X	the first variable
Y	the second variable

Definition at line 102 of file STK_Stat_Bivariate.h.

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

References STK::IRunnerSupervised< YArray_, XArray_, Weights_ >::setData(), STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::xStat_, and STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::yStat_.

xStat()

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 109 of file STK_Stat_Bivariate.h.

{return xStat_;}

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

yStat()

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 111 of file STK_Stat_Bivariate.h.

{return yStat_;}

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

Member Data Documentation

xStat_

template<class XTYPE , class YTYPE , class TContainer1D >

Univariate< TContainer1D> STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::xStat_

protected

Statistics of the X variable.

Definition at line 59 of file STK_Stat_Bivariate.h.

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

yStat_

template<class XTYPE , class YTYPE , class TContainer1D >

Univariate< TContainer1D> STK::Stat::Bivariate< XTYPE, YTYPE, TContainer1D >::yStat_

protected

Statistics of the Y variable.

Definition at line 61 of file STK_Stat_Bivariate.h.

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

---

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

• STK_Stat_Bivariate.h