ScalingModel Class Reference

The model to save to disk. More...

Public Types

enum  ScalerTypes
{
  STANDARD_SCALER
,
  MIN_MAX_SCALER
,
  MEAN_NORMALIZATION
,
  MAX_ABS_SCALER
,
  PCA_WHITENING
,
  ZCA_WHITENING

}
 

Public Member Functions

 ScalingModel (const int minvalue=0, const int maxvalue=1, double epsilonvalue=0.00005)
 Create an object. More...

 
 ScalingModel (const ScalingModel &other)
 Copy constructor. More...

 
 ScalingModel (ScalingModel &&other)
 Move constructor. More...

 
 ~ScalingModel ()
 Clean up memory. More...

 
template
<
typename
MatType
>
void Fit (const MatType &input)
 
template
<
typename
MatType
>
void InverseTransform (const MatType &input, MatType &output)
 
ScalingModeloperator= (const ScalingModel &other)
 Copy assignment operator. More...

 
size_t ScalerType () const
 Get the Scaler type. More...

 
size_t & ScalerType ()
 Modify the Scaler type. More...

 
template
<
typename
Archive
>
void serialize (Archive &ar, const unsigned int)
 Serialize the model. More...

 
template
<
typename
MatType
>
void Transform (const MatType &input, MatType &output)
 Transform to scale features. More...

 

Detailed Description

The model to save to disk.

Definition at line 29 of file scaling_model.hpp.

Member Enumeration Documentation

◆ ScalerTypes

Enumerator
STANDARD_SCALER 
MIN_MAX_SCALER 
MEAN_NORMALIZATION 
MAX_ABS_SCALER 
PCA_WHITENING 
ZCA_WHITENING 

Definition at line 32 of file scaling_model.hpp.

Constructor & Destructor Documentation

◆ ScalingModel() [1/3]

ScalingModel ( const int  minvalue = 0,
const int  maxvalue = 1,
double  epsilonvalue = 0.00005 
)

Create an object.

◆ ScalingModel() [2/3]

ScalingModel ( const ScalingModel other)

Copy constructor.

◆ ScalingModel() [3/3]

ScalingModel ( ScalingModel &&  other)

Move constructor.

◆ ~ScalingModel()

Clean up memory.

Member Function Documentation

◆ Fit()

void Fit ( const MatType &  input)

◆ InverseTransform()

void InverseTransform ( const MatType &  input,
MatType &  output 
)

◆ operator=()

ScalingModel& operator= ( const ScalingModel other)

Copy assignment operator.

◆ ScalerType() [1/2]

size_t ScalerType ( ) const
inline

Get the Scaler type.

Definition at line 72 of file scaling_model.hpp.

◆ ScalerType() [2/2]

size_t& ScalerType ( )
inline

Modify the Scaler type.

Definition at line 74 of file scaling_model.hpp.

References ScalingModel::Fit(), ScalingModel::InverseTransform(), and ScalingModel::Transform().

◆ serialize()

void serialize ( Archive &  ar,
const unsigned  int 
)
inline

Serialize the model.

Definition at line 90 of file scaling_model.hpp.

◆ Transform()

void Transform ( const MatType &  input,
MatType &  output 
)

Transform to scale features.

Referenced by ScalingModel::ScalerType().


The documentation for this class was generated from the following file:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-3.2.1/src/mlpack/methods/preprocess/scaling_model.hpp