Computation of the Factors of a 1D Container. More...

#include <STK_Stat_Factor.h>

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

Public Types
typedef IRunnerWithData< Array >	Base

typedef hidden::Traits< Array >::Row	RowVector

typedef hidden::Traits< Array >::Col	ColVector

typedef Array::Type	Type

typedef std::map< Type, int >	EncodingMap

typedef std::map< int, Type >	DecodingMap

Public Member Functions
	Factor ()
	Default Constructor.

	Factor (Array const &data)
	Constructor.

	Factor (Array const *p_data)
	Constructor.

	Factor (Factor const &f)
	copy constructor.

virtual	~Factor ()
	virtual destructor.

virtual Factor *	clone () const
	clone pattern

CVectorXi const &	asInteger () const

Array2DVector< Type > const &	levels () const

VectorXi const &	counts () const

int const &	firstLevel () const

int const &	nbLevels () const

EncodingMap const &	encoder () const

DecodingMap const &	decoder () const

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

virtual bool	run ()
	run the estimation of the Factor 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
CVectorXi	asInteger_
	vector with the levels in an integer format

int	firstLevel_
	first level

int	nbLevels_
	Number of levels of each variables.

Array2DVector< Type >	levels_
	vector with the levels

VectorXi	counts_
	Array with the counts of each factor.

EncodingMap	encoder_
	encoder of the levels

DecodingMap	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::Factor< Array >

Computation of the Factors of a 1D Container.

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

Definition at line 54 of file STK_Stat_Factor.h.

Member Typedef Documentation

◆ Base

template<class Array >

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

Definition at line 57 of file STK_Stat_Factor.h.

◆ ColVector

template<class Array >

typedef hidden::Traits<Array>::Col STK::Stat::Factor< Array >::ColVector

Definition at line 59 of file STK_Stat_Factor.h.

◆ DecodingMap

template<class Array >

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

Definition at line 63 of file STK_Stat_Factor.h.

◆ EncodingMap

template<class Array >

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

Definition at line 62 of file STK_Stat_Factor.h.

◆ RowVector

template<class Array >

typedef hidden::Traits<Array>::Row STK::Stat::Factor< Array >::RowVector

Definition at line 58 of file STK_Stat_Factor.h.

◆ Type

template<class Array >

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

Definition at line 60 of file STK_Stat_Factor.h.

Constructor & Destructor Documentation

◆ Factor() [1/4]

template<class Array >

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

Default Constructor.

Definition at line 129 of file STK_Stat_Factor.h.

129 : Base(), asInteger_(), firstLevel_(baseIdx), nbLevels_()

130 , levels_(), counts_(), encoder_() {}

STK::Stat::Factor::nbLevels_

int nbLevels_

Number of levels of each variables.

Definition STK_Stat_Factor.h:114

STK::Stat::Factor::asInteger_

CVectorXi asInteger_

vector with the levels in an integer format

Definition STK_Stat_Factor.h:110

STK::Stat::Factor::counts_

VectorXi counts_

Array with the counts of each factor.

Definition STK_Stat_Factor.h:118

STK::Stat::Factor::Base

IRunnerWithData< Array > Base

Definition STK_Stat_Factor.h:57

STK::Stat::Factor::encoder_

EncodingMap encoder_

encoder of the levels

Definition STK_Stat_Factor.h:120

STK::Stat::Factor::levels_

Array2DVector< Type > levels_

vector with the levels

Definition STK_Stat_Factor.h:116

STK::Stat::Factor::firstLevel_

int firstLevel_

first level

Definition STK_Stat_Factor.h:112

STK::baseIdx

const int baseIdx

base index of the containers created in STK++.

Definition STK_Constants.h:63

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

◆ Factor() [2/4]

template<class Array >

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

Constructor.

Parameters

data	a reference on the data set

Definition at line 133 of file STK_Stat_Factor.h.

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

◆ Factor() [3/4]

template<class Array >

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

Constructor.

Parameters

p_data a pointer on the data set

Definition at line 147 of file STK_Stat_Factor.h.

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

References STK::Stat::Factor< Array >::asInteger_, STK::Stat::Factor< Array >::nbLevels_, STK::Stat::Factor< Array >::p_data_, and STK::ICArray< Derived >::resize().

◆ Factor() [4/4]

template<class Array >

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

copy constructor.

Parameters

f	the Factor to copy

Definition at line 164 of file STK_Stat_Factor.h.

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

◆ ~Factor()

template<class Array >

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

inlinevirtual

virtual destructor.

Definition at line 82 of file STK_Stat_Factor.h.

82{}

Member Function Documentation

◆ asInteger()

template<class Array >

CVectorXi const & STK::Stat::Factor< Array >::asInteger ( ) const

inline

Returns: vector with the factors encoded as integers

Definition at line 88 of file STK_Stat_Factor.h.

88{ return asInteger_;}

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

Referenced by main().

◆ clone()

template<class Array >

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

inlinevirtual

clone pattern

Definition at line 85 of file STK_Stat_Factor.h.

85{ return new Factor(*this);}

STK::Stat::Factor::Factor

Factor()

Default Constructor.

Definition STK_Stat_Factor.h:129

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

◆ counts()

template<class Array >

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

inline

Returns: vector with the counts of each level

Definition at line 92 of file STK_Stat_Factor.h.

92{return counts_;}

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

Referenced by main().

◆ decoder()

template<class Array >

DecodingMap const & STK::Stat::Factor< Array >::decoder ( ) const

inline

Returns: decoding maps factor from int -> Type

Definition at line 100 of file STK_Stat_Factor.h.

100{ return decoder_;}

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

◆ encoder()

template<class Array >

EncodingMap const & STK::Stat::Factor< Array >::encoder ( ) const

inline

Returns: encoding maps factor from Type -> int

Definition at line 98 of file STK_Stat_Factor.h.

98{ return encoder_;}

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

◆ firstLevel()

template<class Array >

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

inline

Returns: the value of the first level

Definition at line 94 of file STK_Stat_Factor.h.

94{ return firstLevel_;}

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

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

◆ levels()

template<class Array >

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

inline

Returns: vector with the levels

Definition at line 90 of file STK_Stat_Factor.h.

90{return levels_;}

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

Referenced by main().

◆ nbLevels()

template<class Array >

int const & STK::Stat::Factor< Array >::nbLevels ( ) const

inline

Returns: number of levels

Definition at line 96 of file STK_Stat_Factor.h.

96{ return nbLevels_;}

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

Referenced by main().

◆ run()

template<class Array >

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

virtual

run the estimation of the Factor statistics.

Implements STK::IRunnerBase.

Definition at line 188 of file STK_Stat_Factor.h.

{
  if (!p_data_)
  { this->msg_error_ = STKERROR_NO_ARG(FactorArray::run,data is not set);
    return false;
  }
  try
  {
    for (int i=p_data_->begin(); i< p_data_->end(); ++i)
    {
      // find coding
      Type idData = p_data_->elt(i);
      typename EncodingMap::const_iterator it = encoder_.find(idData);
      if (it != encoder_.end()) // levels already exist, just update the levels array
      { asInteger_[i] = it->second;
        counts_[it->second]++;  // add one to this level
      }
      else // find a new level to add
      {
        // create a new level and set it
        int lev = firstLevel_ + nbLevels_;
        asInteger_[i] = lev;
        encoder_.insert(std::pair<Type, int>(idData, lev));
        decoder_.insert(std::pair<int, Type>(lev, idData));
        levels_.push_back(idData);
        counts_.push_back(1); // start counting for this new level
        nbLevels_++;
      }
    }
  }
  catch (Exception const& error)
  {
    this->msg_error_ += _T("Error in Factor::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::Factor< Array >::setFirstLevel ( int firstLevel )

inline

set the value of the first level

Definition at line 103 of file STK_Stat_Factor.h.

103{ firstLevel_ = firstLevel;}

STK::Stat::Factor::firstLevel

int const & firstLevel() const

Definition STK_Stat_Factor.h:94

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

◆ update()

template<class Array >

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

protectedvirtual

udpating method in case we set a new data set

Reimplemented from STK::IRunnerBase.

Definition at line 172 of file STK_Stat_Factor.h.

{
   // if there is no data there is nothing to update
   if (p_data_)
   {
     asInteger_.resize(p_data_->rows());
     firstLevel_ = baseIdx;
     nbLevels_=0;
     levels_.clear();
     counts_.clear();
     encoder_.clear();
     decoder_.clear();
   }
}