ultra::src::standard_scaler Class Reference

#include <standard_scaler.h>

Classes
struct	column_stats
struct	options

Public Member Functions
	standard_scaler (options) noexcept
void	fit (const dataframe &)
void	transform (dataframe &) const
double	inverse_transform_target (double) const
bool	is_fitted () const noexcept
bool	is_valid () const noexcept

Detailed Description

Standardises numerical columns of a dataframe to zero mean and unit variance.

Constructor & Destructor Documentation

standard_scaler()

ultra::src::standard_scaler::standard_scaler ( options opt )

explicitnoexcept

Constructs a standard scaler.

Parameters

[in]

opt

scaler options

Member Function Documentation

fit()

void ultra::src::standard_scaler::fit

(

const dataframe &

df

)

Computes mean and standard deviation from a reference dataset.

Parameters

[in]

df

reference dataframe

inverse_transform_target()

double ultra::src::standard_scaler::inverse_transform_target ( double norm_y ) const

nodiscard

Inverts a standardised target value to its original scale.

Parameters

[in]

norm_y

standardised target value

Returns

value in original units

is_valid()

bool ultra::src::standard_scaler::is_valid ( ) const

nodiscardnoexcept

Returns

true if the object passes the internal consistency check

transform()

void ultra::src::standard_scaler::transform

(

dataframe &

df

)

const

Applies standardisation in-place to a dataframe.

Parameters

[in,out]

df

dataframe to transform

---

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

• standard_scaler.h
• standard_scaler.cc