STK++ 0.9.13
|
@ More...
#include <STK_IAAModel.h>
Public Member Functions | |
~IAAModel () | |
destructor. | |
Array const & | workData () const |
Reducer *const & | p_reducer () const |
Regressor *const & | p_regressor () const |
Array *const & | p_reduced () const |
Array *const & | p_predicted () const |
Array *const & | p_residuals () const |
int | dim () const |
bool | isCentered () const |
bool | isStandardized () const |
PointX const & | mean () const |
PointX const & | std () const |
void | setDimension (int const &dim) |
void | setWorkData (Array &workData) |
void | setReducer (Reducer *p_reducer) |
void | setRegressor (Regressor *p_regressor) |
void | freeReducer () |
delete the reducer set to this model by the method setReducer . | |
void | freeRegressor () |
delete the regressor set to this model by the method setRegressor . | |
void | center () |
center the data set workData_. | |
void | center (VectorX const &weights) |
weighted centering of the data set. | |
void | standardize () |
standardize the data set. | |
void | standardize (VectorX const &weights) |
weighted standardization the data set. | |
void | reductionStep () |
compute the reduction of the data set and store the result in the p_reduced_ container. | |
void | reductionStep (VectorX const &weights) |
compute the weighted dimension reduction of the data set and store the result in the p_reduced_ container. | |
void | regressionStep () |
compute the regression of the original data set and set the results in p_predicted and p_residuals . | |
void | regressionStep (VectorX const &weights) |
compute the weighted regression of the original data set using the reduced data set as predictor and set the results in p_predicted and p_residuals . | |
void | uncenterResults () |
uncenter the predicted data set. | |
void | unstandardizeResults () |
unstandardize the predicted data set and the residuals. | |
Protected Member Functions | |
IAAModel (Array *p_workData) | |
Constructor. | |
IAAModel (Array &workData) | |
Constructor. | |
Protected Attributes | |
Regressor * | p_regressor_ |
pointer on the regression method. | |
Reducer * | p_reducer_ |
pointer on the reeducer. | |
Array * | p_workData_ |
Array of the local data set. | |
Array * | p_reduced_ |
Array of the reduced data set : the data set is shared with p_reducer and set when the regression method is call. | |
Array * | p_predicted_ |
Array of the predicted data set: the data set is shared with p_regressor and set when the regression method is call. | |
Array * | p_residuals_ |
Array of the residuals: the data set is shared with p_regressor and set when the regression method is call. | |
Private Types | |
typedef IRegression< Array, Array, VectorX > | Regressor |
regression type | |
typedef IReducer< Array, VectorX > | Reducer |
reducer type | |
Private Attributes | |
int | dim_ |
The dimension of the AA Model. | |
PointX | mean_ |
vector of the means of the input data set. | |
PointX | std_ |
vector of the standard deviation of the input data set. | |
bool | isCentered_ |
a boolean true if the working data set is centered, false otherwise. | |
bool | isStandardized_ |
a boolean true if the working data set is standardized, false otherwise | |
@
Interface base class for all Auto-Associative models.
A function Projecttion'' or the
Reduction'') is a map from
The IAAModel class is an abstract base class for all these AAM and a factory method that propose some tools that can be used in derived classes. End user can have to set a reducer and a regressor in order to implement this interface.
Definition at line 71 of file STK_IAAModel.h.
|
private |
reducer type
Definition at line 77 of file STK_IAAModel.h.
|
private |
regression type
Definition at line 75 of file STK_IAAModel.h.
|
protected |
Constructor.
p_workData | A pointer on the the working data set |
Definition at line 203 of file STK_IAAModel.h.
|
protected |
Constructor.
workData | the working data set |
Definition at line 218 of file STK_IAAModel.h.
STK::IAAModel< Array >::~IAAModel | ( | ) |
void STK::IAAModel< Array >::center | ( | ) |
center the data set workData_.
Definition at line 282 of file STK_IAAModel.h.
References STK::Stat::center(), STKRUNTIME_ERROR_NO_ARG, and STK::Stat::uncenter().
void STK::IAAModel< Array >::center | ( | VectorX const & | weights | ) |
weighted centering of the data set.
weights | the weights of the samples |
Definition at line 300 of file STK_IAAModel.h.
References STK::Stat::center(), STKRUNTIME_ERROR_NO_ARG, and STK::Stat::uncenter().
|
inline |
Definition at line 104 of file STK_IAAModel.h.
References STK::IAAModel< Array >::dim_.
void STK::IAAModel< Array >::freeReducer | ( | ) |
delete the reducer set to this model by the method setReducer
.
delete the reducer allocated set to this model.
Definition at line 267 of file STK_IAAModel.h.
void STK::IAAModel< Array >::freeRegressor | ( | ) |
delete the regressor set to this model by the method setRegressor
.
delete the regressor allocated to this model.
Definition at line 274 of file STK_IAAModel.h.
|
inline |
true
if the data set is centered, false
otherwise Definition at line 106 of file STK_IAAModel.h.
References STK::IAAModel< Array >::isCentered_.
|
inline |
true
if the data set is standardized, false
otherwise Definition at line 108 of file STK_IAAModel.h.
References STK::IAAModel< Array >::isStandardized_.
|
inline |
Definition at line 110 of file STK_IAAModel.h.
References STK::IAAModel< Array >::mean_.
|
inline |
Definition at line 100 of file STK_IAAModel.h.
References STK::IAAModel< Array >::p_predicted_.
|
inline |
Definition at line 98 of file STK_IAAModel.h.
References STK::IAAModel< Array >::p_reduced_.
|
inline |
Definition at line 94 of file STK_IAAModel.h.
References STK::IAAModel< Array >::p_reducer_.
|
inline |
Definition at line 96 of file STK_IAAModel.h.
References STK::IAAModel< Array >::p_regressor_.
|
inline |
Definition at line 102 of file STK_IAAModel.h.
References STK::IAAModel< Array >::p_residuals_.
void STK::IAAModel< Array >::reductionStep | ( | ) |
compute the reduction of the data set and store the result in the p_reduced_
container.
The reducer p_reducer have to be set.
Definition at line 357 of file STK_IAAModel.h.
References STKRUNTIME_ERROR_NO_ARG.
void STK::IAAModel< Array >::reductionStep | ( | VectorX const & | weights | ) |
compute the weighted dimension reduction of the data set and store the result in the p_reduced_
container.
Definition at line 372 of file STK_IAAModel.h.
References STKRUNTIME_ERROR_NO_ARG.
void STK::IAAModel< Array >::regressionStep | ( | ) |
compute the regression of the original data set and set the results in p_predicted
and p_residuals
.
Definition at line 387 of file STK_IAAModel.h.
References STKRUNTIME_ERROR_NO_ARG.
void STK::IAAModel< Array >::regressionStep | ( | VectorX const & | weights | ) |
compute the weighted regression of the original data set using the reduced data set as predictor and set the results in p_predicted
and p_residuals
.
Definition at line 401 of file STK_IAAModel.h.
References STKRUNTIME_ERROR_NO_ARG.
void STK::IAAModel< Array >::setDimension | ( | int const & | dim | ) |
void STK::IAAModel< Array >::setReducer | ( | Reducer * | p_reducer | ) |
p_reducer | a pointer on the reduction dimension method to use |
Definition at line 256 of file STK_IAAModel.h.
void STK::IAAModel< Array >::setRegressor | ( | Regressor * | p_regressor | ) |
p_regressor | a pointer on the regression method to use |
Definition at line 262 of file STK_IAAModel.h.
void STK::IAAModel< Array >::setWorkData | ( | Array & | workData | ) |
workData | the working data set to treat |
Definition at line 246 of file STK_IAAModel.h.
Referenced by STK::GaussianAAModel< Array >::setWorkData().
void STK::IAAModel< Array >::standardize | ( | ) |
standardize the data set.
Definition at line 319 of file STK_IAAModel.h.
References STK::Stat::standardize(), STKRUNTIME_ERROR_NO_ARG, and STK::Stat::unstandardize().
void STK::IAAModel< Array >::standardize | ( | VectorX const & | weights | ) |
weighted standardization the data set.
weights | the weights of the samples |
Definition at line 337 of file STK_IAAModel.h.
References STK::Stat::standardize(), STKRUNTIME_ERROR_NO_ARG, and STK::Stat::unstandardize().
|
inline |
Definition at line 112 of file STK_IAAModel.h.
References STK::IAAModel< Array >::std_.
void STK::IAAModel< Array >::uncenterResults | ( | ) |
uncenter the predicted data set.
This will invalidate the results of p_regressor_.
Definition at line 415 of file STK_IAAModel.h.
References STKRUNTIME_ERROR_NO_ARG, and STK::Stat::uncenter().
void STK::IAAModel< Array >::unstandardizeResults | ( | ) |
unstandardize the predicted data set and the residuals.
This will invalidate the results of p_regressor_.
Definition at line 425 of file STK_IAAModel.h.
References STKRUNTIME_ERROR_NO_ARG, and STK::Stat::unstandardize().
|
inline |
Definition at line 92 of file STK_IAAModel.h.
References STK::IAAModel< Array >::p_workData_.
|
private |
The dimension of the AA Model.
Definition at line 186 of file STK_IAAModel.h.
Referenced by STK::IAAModel< Array >::dim().
|
private |
a boolean true
if the working data set is centered, false
otherwise.
Definition at line 193 of file STK_IAAModel.h.
Referenced by STK::IAAModel< Array >::isCentered().
|
private |
a boolean true
if the working data set is standardized, false
otherwise
Definition at line 196 of file STK_IAAModel.h.
Referenced by STK::IAAModel< Array >::isStandardized().
|
private |
vector of the means of the input data set.
Definition at line 188 of file STK_IAAModel.h.
Referenced by STK::IAAModel< Array >::mean().
|
protected |
Array of the predicted data set: the data set is shared with p_regressor
and set when the regression
method is call.
Definition at line 178 of file STK_IAAModel.h.
Referenced by STK::IAAModel< Array >::p_predicted().
|
protected |
Array of the reduced data set : the data set is shared with p_reducer
and set when the regression
method is call.
Definition at line 175 of file STK_IAAModel.h.
Referenced by STK::IAAModel< Array >::p_reduced().
|
protected |
pointer on the reeducer.
The dimension reduction method will be chosen in the derived class.
Definition at line 169 of file STK_IAAModel.h.
Referenced by STK::IAAModel< Array >::p_reducer().
|
protected |
pointer on the regression method.
The regression method will be chosen in the derived class.
Definition at line 165 of file STK_IAAModel.h.
Referenced by STK::LinearAAModel< Array >::LinearAAModel(), STK::LinearAAModel< Array >::LinearAAModel(), and STK::IAAModel< Array >::p_regressor().
|
protected |
Array of the residuals: the data set is shared with p_regressor
and set when the regression
method is call.
Definition at line 182 of file STK_IAAModel.h.
Referenced by STK::IAAModel< Array >::p_residuals().
|
protected |
Array of the local data set.
Definition at line 171 of file STK_IAAModel.h.
Referenced by STK::IAAModel< Array >::workData().
|
private |
vector of the standard deviation of the input data set.
Definition at line 190 of file STK_IAAModel.h.
Referenced by STK::IAAModel< Array >::std().