saturate

class Saturate

#include <saturate.h>

This class is used to saturate an output variable.

Public Functions

Saturate()

The constructor initialies the random number generator used for the walks

Saturate(int64_t size)

class constructor

~Saturate()

The destructor is a placeholder for one that might do something

void setBounds(Eigen::MatrixXd bounds)

sets upper and lower bounds for each state

Parameters:

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

Eigen::VectorXd saturate(Eigen::VectorXd unsaturatedStates)

@brief This method should be used as the standard way to saturate an output. It will also be utilized by

other utilities

Parameters:

unsaturatedStates – a vector of the unsaturated states

Returns:

saturatedStates

Private Members

int64_t numStates

Saturates the given unsaturated states.

Param unsaturated:

States, a vector of the unsaturated states

Return:

saturatedStates &#8212; Number of states to generate noise for

Eigen::MatrixXd stateBounds

&#8212; one row for each state. lower bounds in left column, upper in right column