Computation of the MultiFactors of a 2D Container. More...

#include <STK_Stat_MultiFactor.h>

Inheritance diagram for STK::Stat::MultiFactor< Array >:

Public Types
typedef IRunnerWithData< Array >	Base

typedef Array::Type	Type

typedef std::map< Type, int >	EncodingMap

typedef std::map< int, Type >	DecodingMap

typedef CArrayPoint< EncodingMap >	Encoder

typedef CArrayPoint< DecodingMap >	Decoder

Public Member Functions
	MultiFactor ()
	Default Constructor.

	MultiFactor (Array const &data)
	Constructor.

	MultiFactor (Array const *p_data)
	Constructor.

	MultiFactor (MultiFactor const &f)
	copy constructor.

virtual	~MultiFactor ()
	virtual destructor.

virtual MultiFactor *	clone () const
	clone pattern

CArrayXXi const &	asInteger () const

CArrayPoint< Array2DVector< Type > > const &	levels () const

CArrayPoint< VectorXi > const &	counts () const

int const &	firstLevel () const

CPointXi const &	nbLevels () const

Encoder const &	encoder () const

Decoder const &	decoder () const

void	setFirstLevel (int firstLevel)
	set the value of the first level

virtual bool	run ()
	run the estimation of the MultiFactor statistics.

Public Member Functions inherited from STK::IRunnerWithData< Array >
Array const *	p_data () const
	get the data set

virtual void	setData (Array const *p_data)
	Set the data set.

virtual void	setData (Array const &data)
	Set the data set.

Public Member Functions inherited from STK::IRunnerBase
String const &	error () const
	get the last error message.

Public Attributes
Array const *	p_data_
	A pointer on the original data set.

Protected Member Functions
virtual void	update ()
	udpating method in case we set a new data set

Protected Member Functions inherited from STK::IRunnerWithData< Array >
	IRunnerWithData ()
	default constructor.

	IRunnerWithData (Array const *const p_data)
	constructor with a pointer on the constant data set

	IRunnerWithData (Array const &data)
	constructor with a constant reference on the data set

	IRunnerWithData (IRunnerWithData const &runner)
	copy constructor

	~IRunnerWithData ()
	destructor

Protected Member Functions inherited from STK::IRunnerBase
	IRunnerBase ()
	default constructor

	IRunnerBase (IRunnerBase const &runner)
	copy constructor

virtual	~IRunnerBase ()
	destructor

Protected Attributes
CArrayXXi	asInteger_
	Array of the data size with the levels of each variables in an integer format.

int	firstLevel_
	first level number

CPointXi	nbLevels_
	Number of levels of each variables.

CArrayPoint< Array2DVector< Type > >	levels_
	Array with the levels of each variables.

CArrayPoint< VectorXi >	counts_
	Array with the counts of each factor.

Encoder	encoder_
	encoder of the levels

Decoder	decoder_
	decoder of the levels

Protected Attributes inherited from STK::IRunnerWithData< Array >
Array const *	p_data_
	A pointer on the original data set.

Protected Attributes inherited from STK::IRunnerBase
String	msg_error_
	String with the last error message.

bool	hasRun_
	`true` if run has been used, `false` otherwise

Detailed Description

template<class Array>
class STK::Stat::MultiFactor< Array >

Computation of the MultiFactors of a 2D Container.

The class MultiFactor is a factory class for computing the factors of an array. The values can be of any type. the Coding is performed from the previous type in integer. The mapping is stored and preserved in an array of map array.

Definition at line 57 of file STK_Stat_MultiFactor.h.

Member Typedef Documentation

◆ Base

template<class Array >

typedef IRunnerWithData<Array> STK::Stat::MultiFactor< Array >::Base

Definition at line 60 of file STK_Stat_MultiFactor.h.

◆ Decoder

template<class Array >

typedef CArrayPoint<DecodingMap> STK::Stat::MultiFactor< Array >::Decoder

Definition at line 67 of file STK_Stat_MultiFactor.h.

◆ DecodingMap

template<class Array >

typedef std::map<int, Type> STK::Stat::MultiFactor< Array >::DecodingMap

Definition at line 64 of file STK_Stat_MultiFactor.h.

◆ Encoder

template<class Array >

typedef CArrayPoint<EncodingMap> STK::Stat::MultiFactor< Array >::Encoder

Definition at line 66 of file STK_Stat_MultiFactor.h.

◆ EncodingMap

template<class Array >

typedef std::map<Type, int> STK::Stat::MultiFactor< Array >::EncodingMap

Definition at line 63 of file STK_Stat_MultiFactor.h.

◆ Type

template<class Array >

typedef Array::Type STK::Stat::MultiFactor< Array >::Type

Definition at line 61 of file STK_Stat_MultiFactor.h.

Constructor & Destructor Documentation

◆ MultiFactor() [1/4]

template<class Array >

STK::Stat::MultiFactor< Array >::MultiFactor ( )

Default Constructor.

Definition at line 133 of file STK_Stat_MultiFactor.h.

133 : Base(), asInteger_(), firstLevel_(baseIdx)

134 , nbLevels_(), levels_(), counts_(), encoder_() {}

STK::Stat::MultiFactor::counts_

CArrayPoint< VectorXi > counts_

Array with the counts of each factor.

Definition STK_Stat_MultiFactor.h:122

STK::Stat::MultiFactor::levels_

CArrayPoint< Array2DVector< Type > > levels_

Array with the levels of each variables.

Definition STK_Stat_MultiFactor.h:120

STK::Stat::MultiFactor::Base

IRunnerWithData< Array > Base

Definition STK_Stat_MultiFactor.h:60

STK::Stat::MultiFactor::encoder_

Encoder encoder_

encoder of the levels

Definition STK_Stat_MultiFactor.h:124

STK::Stat::MultiFactor::firstLevel_

int firstLevel_

first level number

Definition STK_Stat_MultiFactor.h:116

STK::Stat::MultiFactor::nbLevels_

CPointXi nbLevels_

Number of levels of each variables.

Definition STK_Stat_MultiFactor.h:118

STK::Stat::MultiFactor::asInteger_

CArrayXXi asInteger_

Array of the data size with the levels of each variables in an integer format.

Definition STK_Stat_MultiFactor.h:114

STK::baseIdx

const int baseIdx

base index of the containers created in STK++.

Definition STK_Constants.h:63

Referenced by STK::Stat::MultiFactor< Array >::clone().

◆ MultiFactor() [2/4]

template<class Array >

STK::Stat::MultiFactor< Array >::MultiFactor ( Array const & data )

Constructor.

Parameters

data	a reference on the data set

Definition at line 137 of file STK_Stat_MultiFactor.h.

                                                 : Base(data)
                               , asInteger_(p_data_->rows(),p_data_->cols())
                               , firstLevel_(baseIdx)
                               , nbLevels_(p_data_->cols(), 0)
                               , levels_(p_data_->cols())
                               , counts_(p_data_->cols())
                               , encoder_(p_data_->cols())
                               , decoder_(p_data_->cols())
{}

◆ MultiFactor() [3/4]

template<class Array >

STK::Stat::MultiFactor< Array >::MultiFactor ( Array const * p_data )

Constructor.

Parameters

p_data a pointer on the data set

Definition at line 151 of file STK_Stat_MultiFactor.h.

                                                   : Base(p_data)
                               , asInteger_()
                               , firstLevel_(baseIdx)
                               , nbLevels_()
                               , levels_()
                               , encoder_()
                               , decoder_()
{
  if (p_data_)
  {
    asInteger_.resize(p_data_->rows(),p_data_->cols());
    nbLevels_.resize(p_data_->cols()).setValue(0);
    levels_.resize(p_data_->cols());
    counts_.resize(p_data_->cols());
    encoder_.resize(p_data_->cols());
    decoder_.resize(p_data_->cols());
  }
}

References STK::Stat::MultiFactor< Array >::asInteger_, STK::Stat::MultiFactor< Array >::counts_, STK::Stat::MultiFactor< Array >::decoder_, STK::Stat::MultiFactor< Array >::encoder_, STK::Stat::MultiFactor< Array >::levels_, STK::Stat::MultiFactor< Array >::nbLevels_, STK::Stat::MultiFactor< Array >::p_data_, and STK::ICArray< Derived >::resize().

◆ MultiFactor() [4/4]

template<class Array >

STK::Stat::MultiFactor< Array >::MultiFactor ( MultiFactor< Array > const & f )

copy constructor.

Parameters

f	the MultiFactor to copy

Definition at line 171 of file STK_Stat_MultiFactor.h.

                                                    : Base(f), asInteger_(f.asInteger_)
                               , firstLevel_(baseIdx), nbLevels_(f.nbLevels_)
                               , levels_(f.levels_), counts_(f.counts_)
                               , encoder_(f.encoder_)
                               , decoder_(f.decoder_)
{}

◆ ~MultiFactor()

template<class Array >

virtual STK::Stat::MultiFactor< Array >::~MultiFactor ( )

inlinevirtual

virtual destructor.

Definition at line 86 of file STK_Stat_MultiFactor.h.

86{}

Member Function Documentation

◆ asInteger()

template<class Array >

CArrayXXi const & STK::Stat::MultiFactor< Array >::asInteger ( ) const

inline

Returns: array with the factors encoded as integers

Definition at line 92 of file STK_Stat_MultiFactor.h.

92{ return asInteger_;}

References STK::Stat::MultiFactor< Array >::asInteger_.

Referenced by main().

◆ clone()

template<class Array >

virtual MultiFactor * STK::Stat::MultiFactor< Array >::clone ( ) const

inlinevirtual

clone pattern

Definition at line 89 of file STK_Stat_MultiFactor.h.

89{ return new MultiFactor(*this);}

STK::Stat::MultiFactor::MultiFactor

MultiFactor()

Default Constructor.

Definition STK_Stat_MultiFactor.h:133

References STK::Stat::MultiFactor< Array >::MultiFactor().

◆ counts()

template<class Array >

CArrayPoint< VectorXi > const & STK::Stat::MultiFactor< Array >::counts ( ) const

inline

Returns: array with for each variables the counts of the levels

Definition at line 96 of file STK_Stat_MultiFactor.h.

96{return counts_;}

References STK::Stat::MultiFactor< Array >::counts_.

Referenced by main().

◆ decoder()

template<class Array >

Decoder const & STK::Stat::MultiFactor< Array >::decoder ( ) const

inline

Returns: array with the encoding maps factor to int

Definition at line 104 of file STK_Stat_MultiFactor.h.

104{ return decoder_;}

References STK::Stat::MultiFactor< Array >::decoder_.

◆ encoder()

template<class Array >

Encoder const & STK::Stat::MultiFactor< Array >::encoder ( ) const

inline

Returns: array with the encoding maps factor to int

Definition at line 102 of file STK_Stat_MultiFactor.h.

102{ return encoder_;}

References STK::Stat::MultiFactor< Array >::encoder_.

◆ firstLevel()

template<class Array >

int const & STK::Stat::MultiFactor< Array >::firstLevel ( ) const

inline

Returns: the value of the first level

Definition at line 98 of file STK_Stat_MultiFactor.h.

98{ return firstLevel_;}

References STK::Stat::MultiFactor< Array >::firstLevel_.

Referenced by STK::Stat::MultiFactor< Array >::setFirstLevel().

◆ levels()

template<class Array >

CArrayPoint< Array2DVector< Type > > const & STK::Stat::MultiFactor< Array >::levels ( ) const

inline

Returns: array with for each variables the levels

Definition at line 94 of file STK_Stat_MultiFactor.h.

94{return levels_;}

References STK::Stat::MultiFactor< Array >::levels_.

Referenced by main().

◆ nbLevels()

template<class Array >

CPointXi const & STK::Stat::MultiFactor< Array >::nbLevels ( ) const

inline

Returns: array with for each variables the number of levels

Definition at line 100 of file STK_Stat_MultiFactor.h.

100{ return nbLevels_;}

References STK::Stat::MultiFactor< Array >::nbLevels_.

Referenced by main().

◆ run()

template<class Array >

bool STK::Stat::MultiFactor< Array >::run ( )

virtual

run the estimation of the MultiFactor statistics.

Implements STK::IRunnerBase.

Definition at line 202 of file STK_Stat_MultiFactor.h.

{
  if (!p_data_)
  { this->msg_error_ = STKERROR_NO_ARG(MultiFactorArray::run,data is not set);
    return false;
  }
  try
  {
    for (int j=p_data_->beginCols(); j< p_data_->endCols(); ++j)
    {
      for (int i=p_data_->beginRows(); i< p_data_->endRows(); ++i)
      {
        // find coding
        Type idData = p_data_->elt(i,j);
        typename EncodingMap::const_iterator it = encoder_[j].find(idData);
        if (it != encoder_[j].end())
        { // levels already exist, just update the integer and counts array
          asInteger_(i,j) = it->second;
          counts_[j][it->second]++;
        }
        else
        { // find a new level to add
          // create a new level and set it
          int lev = firstLevel_ + nbLevels_[j];
          asInteger_(i,j) = lev;
          encoder_[j].insert(std::pair<Type, int>(idData, lev));
          decoder_[j].insert(std::pair<int, Type>(lev, idData));
          levels_[j].push_back(idData);
          counts_[j].push_back(1); // start counting for this new level
          ++nbLevels_[j];
        }
      }
    }
  }
  catch (Exception const& error)
  {
    this->msg_error_ += _T("Error in MultiFactor::run():\nWhat: ");
    this->msg_error_ += error.error();
    return false;
  }
  // no error
  return true;
}

References _T, STK::Exception::error(), and STKERROR_NO_ARG.

Referenced by main().

◆ setFirstLevel()

template<class Array >

void STK::Stat::MultiFactor< Array >::setFirstLevel ( int firstLevel )

inline

set the value of the first level

Definition at line 107 of file STK_Stat_MultiFactor.h.

107{ firstLevel_ = firstLevel;}

STK::Stat::MultiFactor::firstLevel

int const & firstLevel() const

Definition STK_Stat_MultiFactor.h:98

References STK::Stat::MultiFactor< Array >::firstLevel(), and STK::Stat::MultiFactor< Array >::firstLevel_.

◆ update()

template<class Array >

void STK::Stat::MultiFactor< Array >::update ( )

protectedvirtual

udpating method in case we set a new data set

Reimplemented from STK::IRunnerBase.

Definition at line 179 of file STK_Stat_MultiFactor.h.

{
   // if there is no data there is nothing to update
   if (p_data_)
   {
     asInteger_.resize(p_data_->rows(),p_data_->cols());
     firstLevel_ = baseIdx;
     nbLevels_.resize(p_data_->cols()).setValue(0);
     for(int j=encoder_.begin(); j<std::min(encoder_.end(), p_data_->cols().end()); ++j)
     {
       levels_[j].clear();
       counts_[j].clear();
       encoder_[j].clear();
       decoder_[j].clear();
     }
     levels_.resize(p_data_->cols());
     counts_.resize(p_data_->cols());
     encoder_.resize(p_data_->cols());
     decoder_.resize(p_data_->cols());
   }
}