gridpp::StartedBoxCox Class Reference

#include <gridpp.h>

Inheritance diagram for gridpp::StartedBoxCox:

Public Member Functions
vec	backward (const vec &input) const
	Backward transform a 1D vector. More...
vec2	backward (const vec2 &input) const
	Backward transform a 2D vector. More...
vec3	backward (const vec3 &input) const
	Backward transform a 3D vector. More...
virtual float	backward (float value) const
float	backward (float value) const
vec	forward (const vec &input) const
	Forward transform a 1D vector. More...
vec2	forward (const vec2 &input) const
	Forward transform a 2D vector. More...
vec3	forward (const vec3 &input) const
	Forward transform a 3D vector. More...
virtual float	forward (float value) const
float	forward (float value) const
	StartedBoxCox (float threshold, float scaling_factor)
	Initialize started Box-Cox transform. More...
Public Member Functions inherited from gridpp::Transform
vec	backward (const vec &input) const
	Backward transform a 1D vector. More...
vec2	backward (const vec2 &input) const
	Backward transform a 2D vector. More...
vec3	backward (const vec3 &input) const
	Backward transform a 3D vector. More...
vec	forward (const vec &input) const
	Forward transform a 1D vector. More...
vec2	forward (const vec2 &input) const
	Forward transform a 2D vector. More...
vec3	forward (const vec3 &input) const
	Forward transform a 3D vector. More...

Detailed Description

Started Box-Cox transformation.

No transformation between 0 and scaling_factor, then Box-Cox (like) transformation with parameter equal to threshold

Constructor & Destructor Documentation

StartedBoxCox()

gridpp::StartedBoxCox::StartedBoxCox	(	float	threshold,
		float	scaling_factor
	)

Initialize started Box-Cox transform.

Parameters

threshold

started Box-Cox parameter

Member Function Documentation

backward() [1/5]

vec gridpp::Transform::backward

Backward transform a 1D vector.

Parameters

input

1D vector of transformed values

Returns

1D vector of original values

backward() [2/5]

vec2 gridpp::Transform::backward

Backward transform a 2D vector.

Parameters

input

2D vector of transformed values

Returns

2D vector of original values

backward() [3/5]

vec3 gridpp::Transform::backward

Backward transform a 3D vector.

Parameters

input

3D vector of transformed values

Returns

3D vector of original values

backward() [4/5]

float gridpp::Transform::backward

backward() [5/5]

float gridpp::StartedBoxCox::backward ( float  value ) const

virtual

Reimplemented from gridpp::Transform.

forward() [1/5]

vec gridpp::Transform::forward

Forward transform a 1D vector.

Parameters

input

1D vector

Returns

1D vector of transformed values

forward() [2/5]

vec2 gridpp::Transform::forward

Forward transform a 2D vector.

Parameters

input

2D vector

Returns

2D vector of transformed values

forward() [3/5]

vec3 gridpp::Transform::forward

Forward transform a 3D vector.

Parameters

input

3D vector

Returns

3D vector of transformed values

forward() [4/5]

float gridpp::Transform::forward

forward() [5/5]

float gridpp::StartedBoxCox::forward ( float  value ) const

virtual

Reimplemented from gridpp::Transform.

---

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

• /home/thomasn/repos/gridpp/include/gridpp.h
• /home/thomasn/repos/gridpp/src/api/transform.cpp