cmp::scaler::DummyScaler Class Reference

A pass-through scaler that leaves input data unchanged. More...

#include <scaler.h>

Inheritance diagram for cmp::scaler::DummyScaler:

Collaboration diagram for cmp::scaler::DummyScaler:

Public Member Functions
	DummyScaler ()=default
	Default constructor.
	DummyScaler (const DummyScaler &other)=default
	DummyScaler (DummyScaler &&other)=default
	~DummyScaler ()=default
DummyScaler &	operator= (const DummyScaler &other)=default
DummyScaler &	operator= (DummyScaler &&other)=default
Eigen::VectorXd	transform (const Eigen::Ref< const Eigen::VectorXd > &data) const override
	Transforms the input data from physical space to the scaled latent space.
Eigen::VectorXd	inverseTransform (const Eigen::Ref< const Eigen::VectorXd > &data) const override
	Reconstructs the data from the scaled latent space back to physical space.
Eigen::VectorXd	getIntercept () const override
	Retrieves the intercept vector \( \mu \) used in the transformation.
Eigen::MatrixXd	getScale () const override
	Retrieves the scaling matrix \( S \) used in the transformation.
void	fit (const Eigen::Ref< const Eigen::MatrixXd > &data) override
	Learns the scaling parameters (e.g., mean, variance) from the training data.
Eigen::MatrixXd	fit_transform (const Eigen::Ref< const Eigen::MatrixXd > &data) override
	Fits the scaling parameters to the data and subsequently transforms the data.
void	setDim (size_t dim)
	Explicitly sets the data dimensionality.

Private Attributes
size_t	dim_
	The dimensionality \( d \) of the data vectors.

Detailed Description

A pass-through scaler that leaves input data unchanged.

Mathematical Formulation

The transformation is the identity function mapping \( \mathbb{R}^d \to \mathbb{R}^d \):

\[ T(x) = x \]

\[ T^{-1}(y) = y \]

The intercept \( \mu \) is the zero vector, and the scale \( S \) is the identity matrix \( I \).

Constructor & Destructor Documentation

DummyScaler() [1/3]

cmp::scaler::DummyScaler::DummyScaler ( )

default

Default constructor.

DummyScaler() [2/3]

cmp::scaler::DummyScaler::DummyScaler ( const DummyScaler &  other )

default

DummyScaler() [3/3]

cmp::scaler::DummyScaler::DummyScaler ( DummyScaler &&  other )

default

~DummyScaler()

cmp::scaler::DummyScaler::~DummyScaler ( )

default

Member Function Documentation

fit()

void cmp::scaler::DummyScaler::fit ( const Eigen::Ref< const Eigen::MatrixXd > &  data )

inlineoverridevirtual

Learns the scaling parameters (e.g., mean, variance) from the training data.

Parameters

data	A matrix \( X \in \mathbb{R}^{n \times d} \) of training samples.

Implements cmp::scaler::Scaler.

fit_transform()

Eigen::MatrixXd cmp::scaler::DummyScaler::fit_transform ( const Eigen::Ref< const Eigen::MatrixXd > &  data )

inlineoverridevirtual

Fits the scaling parameters to the data and subsequently transforms the data.

Parameters

data	A matrix \( X \in \mathbb{R}^{n \times d} \) of training samples.

Returns

The transformed dataset matrix \( Y \).

Implements cmp::scaler::Scaler.

getIntercept()

Eigen::VectorXd cmp::scaler::DummyScaler::getIntercept ( ) const

inlineoverridevirtual

Retrieves the intercept vector \( \mu \) used in the transformation.

Returns

The intercept vector.

Implements cmp::scaler::Scaler.

getScale()

Eigen::MatrixXd cmp::scaler::DummyScaler::getScale ( ) const

inlineoverridevirtual

Retrieves the scaling matrix \( S \) used in the transformation.

Returns

The scaling matrix.

Implements cmp::scaler::Scaler.

inverseTransform()

Eigen::VectorXd cmp::scaler::DummyScaler::inverseTransform ( const Eigen::Ref< const Eigen::VectorXd > &  data ) const

inlineoverridevirtual

Reconstructs the data from the scaled latent space back to physical space.

Parameters

data	A column vector \( y \) in the scaled space.

Returns

The unscaled physical data vector \( x \).

Implements cmp::scaler::Scaler.

operator=() [1/2]

DummyScaler & cmp::scaler::DummyScaler::operator= ( const DummyScaler &  other )

default

operator=() [2/2]

DummyScaler & cmp::scaler::DummyScaler::operator= ( DummyScaler &&  other )

default

setDim()

void cmp::scaler::DummyScaler::setDim ( size_t  dim )

inline

Explicitly sets the data dimensionality.

Parameters

dim	The dimension \( d \).

transform()

Eigen::VectorXd cmp::scaler::DummyScaler::transform ( const Eigen::Ref< const Eigen::VectorXd > &  data ) const

inlineoverridevirtual

Transforms the input data from physical space to the scaled latent space.

Parameters

data	A column vector \( x \) representing a single data point in physical space.

Returns

The scaled data vector \( y \).

Implements cmp::scaler::Scaler.

Member Data Documentation

dim_

size_t cmp::scaler::DummyScaler::dim_

private

The dimensionality \( d \) of the data vectors.

---

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

• include/scaler.h