Class Saturater

Namespace

NominalSystems.Maths

Assembly

NominalSystems.Maths.dll

This module is used to apply a saturation on a set of data

---

public class Saturater

Inheritance

object

Saturater

Constructors

Saturater(int)

Constructor with a specific size

public Saturater(int size)

Parameters

size int

The size of the saturator

Methods

Saturate(Vector)

Saturates the given unsaturated states

public Vector Saturate(Vector unsaturatedStates)

Parameters

unsaturatedStates Vector

A vector of the unsaturated states

Returns

Vector

Saturated States

Saturate(Vector2)

Saturates the given unsaturated states

public Vector2 Saturate(Vector2 unsaturatedStates)

Parameters

unsaturatedStates Vector2

A vector of the unsaturated states

Returns

Vector2

Saturated States

Saturate(Vector3)

Saturates the given unsaturated states

public Vector3 Saturate(Vector3 unsaturatedStates)

Parameters

unsaturatedStates Vector3

A vector of the unsaturated states

Returns

Vector3

Saturated States

Saturate(Vector4)

Saturates the given unsaturated states

public Vector4 Saturate(Vector4 unsaturatedStates)

Parameters

unsaturatedStates Vector4

A vector of the unsaturated states

Returns

Vector4

Saturated States

Saturate(double)

Saturates the given unsaturated state

public double Saturate(double a)

Parameters

a double

A unsaturated state

Returns

double

Saturated State

SetBounds(Matrix)

Sets upper and lower bounds for each state

public void SetBounds(Matrix bounds)

Parameters

bounds Matrix

One row for each state. lower bounds in left column, upper in right column