STK++: STK::Index Class Reference

An Index is a criteria to maximize in order to find one or many axis of projection in an Auto-Associative model (AAM). More...

#include <STK_Index.h>

Inherited by STK::LocalVariance.

List of all members.

Public Member Functions
virtual	~Index ()
virtual void	setData (Matrix const *p_data)
virtual void	run (Integer const &nbAxis=1)=0
virtual void	run (Vector const *weights, Integer const &nbAxis=1)=0
Matrix const &	data () const
Matrix const *	p_data () const
Vector const &	weights () const
Integer const &	nbAxis () const
Vector const &	indexValues () const
Matrix const &	axis () const
Protected Member Functions
	Index ()
Protected Attributes
Matrix const *	p_data_
Vector const *	p_weights_
Integer	nbAxis_
Vector	index_values_
Matrix	axis_

Detailed Description

An Index is a criteria to maximize in order to find one or many axis of projection in an Auto-Associative model (AAM).

The class receive a matrix in input of size (n,p).

n is the number of individuals,
p is the number of variables. The observations can be weighted.

The data set have to be notified to this object using the virtual method setData(data).

The class compute the optimal axis using the virtual method run(nbAxis) (not weighted observations) or run(weights, nbAxis) (weighted observations).

Definition at line 62 of file STK_Index.h.

Constructor & Destructor Documentation

STK::Index::Index ( ) [protected]

Constructor.

Definition at line 47 of file STK_Index.cpp.

             : p_data_(0), p_weights_(0)
{;}

STK::Index::~Index ( ) [virtual]

virtual destructor

Definition at line 60 of file STK_Index.cpp.

{;}

Member Function Documentation

void STK::Index::setData ( Matrix const * p_data ) [virtual]

Set the data set the index should use. The expected behavior of this method is to initialize all the components of the object needed by the run method.

Parameters:

p_data

The data set to handle

Reimplemented in STK::LocalVariance.

Definition at line 53 of file STK_Index.cpp.

References p_data_.

{
  p_data_ = p_data;
}

virtual void STK::Index::run ( Integer const & nbAxis = 1 ) [pure virtual]

Compute the Index.

Parameters:

nbAxis

number of Axis to compute

Implemented in STK::LocalVariance.

virtual void STK::Index::run	(	Vector const *	weights,
		Integer const &	nbAxis = `1`
	)			`[pure virtual]`

Compute the weighted index.

Parameters:

	weights	the weights to used
	nbAxis	number of Axis to compute

Implemented in STK::LocalVariance.

Matrix const& STK::Index::data ( ) const [inline]

get the data set

Returns:: a constant reference Matrix of the data set

Definition at line 101 of file STK_Index.h.

References p_data_.

{ return *p_data_; }

Matrix const* STK::Index::p_data ( ) const [inline]

get a pointer on the data set

Returns:: a constant pointer on the data set

Definition at line 106 of file STK_Index.h.

References p_data_.

{ return p_data_; }

Vector const& STK::Index::weights ( ) const [inline]

get the weights

Returns:: a constant reference Vector of the weights.

Definition at line 112 of file STK_Index.h.

References p_weights_.

{ return *p_weights_; }

Integer const& STK::Index::nbAxis ( ) const [inline]

get the number of axis.

Returns:: The number of axis computed or to compute

Definition at line 118 of file STK_Index.h.

References nbAxis_.

{ return nbAxis_;}

Vector const& STK::Index::indexValues ( ) const [inline]

get the values of the index

Returns:: a constant reference Vector of the value of the Index

Definition at line 124 of file STK_Index.h.

References index_values_.

{ return index_values_; }

Matrix const& STK::Index::axis ( ) const [inline]

get the axis

Returns:: a constant reference Matrix of the axis

Definition at line 129 of file STK_Index.h.

References axis_.

Referenced by STK::SemiLinearAAModelMixture::MStep().

{ return axis_; }

Member Data Documentation

Matrix const* STK::Index::p_data_ [protected]

The input data set. This is a pointer on constant data.

Definition at line 66 of file STK_Index.h.

Referenced by STK::LocalVariance::computeAxis(), STK::LocalVariance::computeCovarianceMatrices(), STK::LocalVariance::computeWeightedCovarianceMatrices(), data(), STK::LocalVariance::minimalDistance(), p_data(), STK::LocalVariance::prim(), STK::LocalVariance::setData(), and setData().

Vector const* STK::Index::p_weights_ [protected]

The input weights of the individuals. This is a pointer on constant data.

Definition at line 70 of file STK_Index.h.

Referenced by STK::LocalVariance::computeWeightedCovarianceMatrices(), STK::LocalVariance::run(), and weights().

Integer STK::Index::nbAxis_ [protected]

number of axis

Definition at line 133 of file STK_Index.h.

Referenced by STK::LocalVariance::computeAxis(), nbAxis(), and STK::LocalVariance::run().

Vector STK::Index::index_values_ [protected]

The values of the index for each axis.

Definition at line 136 of file STK_Index.h.

Referenced by STK::LocalVariance::computeAxis(), and indexValues().

Matrix STK::Index::axis_ [protected]

The computed axis.

Definition at line 138 of file STK_Index.h.

Referenced by axis(), and STK::LocalVariance::computeAxis().

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