Cosan::StandardScaler< NumericType > Class Template Reference

#include <standardScaler.h>

Inheritance diagram for Cosan::StandardScaler< NumericType >:

Public Member Functions
	StandardScaler ()=default
	StandardScaler (CosanRawData< NumericType > &RD)
CosanRowVector< NumericType >	GetMean () const
CosanRowVector< NumericType >	GetStd () const
void	fit (CosanRawData< NumericType > &RD)
void	fit (const CosanMatrix< NumericType > &X) override
CosanMatrix< NumericType >	transform (const CosanMatrix< NumericType > &X) override
CosanMatrix< NumericType >	InvTransform (const CosanMatrix< NumericType > &X)
Public Member Functions inherited from Cosan::Preprocessor< NumericType >
	Preprocessor ()
virtual	~Preprocessor ()=default
Public Member Functions inherited from Cosan::CosanBO
	CosanBO ()
	Default constructor. More...
virtual const std::string	GetName () const
	Get the name of the objects. More...

Private Attributes
CosanRowVector< NumericType >	mean
CosanRowVector< NumericType >	std

Detailed Description

template<Numeric NumericType>
class Cosan::StandardScaler< NumericType >

Standardize features by removing the mean and scaling to unit variance

Definition at line 11 of file standardScaler.h.

Constructor & Destructor Documentation

StandardScaler() [1/2]

template<Numeric NumericType>

Cosan::StandardScaler< NumericType >::StandardScaler ( )

default

StandardScaler() [2/2]

template<Numeric NumericType>

Cosan::StandardScaler< NumericType >::StandardScaler ( CosanRawData< NumericType > &  RD )

inline

Definition at line 19 of file standardScaler.h.

                                                     :Preprocessor<NumericType>(){
            this->fit(RD);
        }

Member Function Documentation

fit() [1/2]

template<Numeric NumericType>

void Cosan::StandardScaler< NumericType >::fit ( const CosanMatrix< NumericType > &  X )

inlineoverridevirtual

Reimplemented from Cosan::Preprocessor< NumericType >.

Definition at line 28 of file standardScaler.h.

                                                               {
            fmt::print("*********************************\n");
            fmt::print("Begin standardizing data \n");
            this->mean = X.colwise().mean();
            this->std = ((X.rowwise() - this->mean).array().pow(2).colwise().sum() / X.rows()).sqrt();
            if ((this->std.array()==0).any()==true){
                std::cout<<"Error!"<<std::endl;
                for (gsl::index  idx = 0;idx<this->std.size();idx++ ){
                    if (this->std[idx]==0){
                        std::cout<<"Column "<<idx<<" has identical values!"<<std::endl;
                    }
                }
                throw std::invalid_argument(
                        "Check your column! Some column has identical values!"
                );
            }
 
            fmt::print("End of standardizing data. One may transform or reverse-transform by .transform(),.InvTransform() function. \n");
            fmt::print("*********************************\n");
        };

fit() [2/2]

template<Numeric NumericType>

void Cosan::StandardScaler< NumericType >::fit ( CosanRawData< NumericType > &  RD )

inline

Definition at line 24 of file standardScaler.h.

                                               {
            fit(RD.GetInput());
            RD.UpdateData(transform(RD.GetInput()));
        }

GetMean()

template<Numeric NumericType>

CosanRowVector<NumericType> Cosan::StandardScaler< NumericType >::GetMean ( ) const

inline

Definition at line 22 of file standardScaler.h.

{return this->mean;}

GetStd()

template<Numeric NumericType>

CosanRowVector<NumericType> Cosan::StandardScaler< NumericType >::GetStd ( ) const

inline

Definition at line 23 of file standardScaler.h.

{return this->std;}

InvTransform()

template<Numeric NumericType>

CosanMatrix<NumericType> Cosan::StandardScaler< NumericType >::InvTransform ( const CosanMatrix< NumericType > &  X )

inline

Definition at line 52 of file standardScaler.h.

                                                                                  {
            return (X.array().rowwise()*(this->std.array())).array().rowwise()+this->mean.array();
        };

transform()

template<Numeric NumericType>

CosanMatrix<NumericType> Cosan::StandardScaler< NumericType >::transform ( const CosanMatrix< NumericType > &  X )

inlineoverridevirtual

Reimplemented from Cosan::Preprocessor< NumericType >.

Definition at line 48 of file standardScaler.h.

                                                                                       {
            return (X.rowwise() - this->mean).array().rowwise() / this->std.array();
        };

Member Data Documentation

mean

template<Numeric NumericType>

CosanRowVector<NumericType> Cosan::StandardScaler< NumericType >::mean

private

Definition at line 56 of file standardScaler.h.

std

template<Numeric NumericType>

CosanRowVector<NumericType> Cosan::StandardScaler< NumericType >::std

private

Definition at line 57 of file standardScaler.h.

---

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

• cosan/preprocessing/standardScaler.h