Math module

nest.math.hl_api_math.cos(parameter)

Calculate the cosine of the parameter

Parameters:

parameter (Parameter) – Input Parameter.

Returns:

Object representing the cosine of the parameter.

Return type:

Parameter

nest.math.hl_api_math.exp(parameter)

Calculate the exponential of the parameter

Parameters:

parameter (Parameter) – Input Parameter.

Returns:

Object representing the exponential of the parameter.

Return type:

Parameter

nest.math.hl_api_math.max(parameter, value)

Yields the largest value of the value of a parameter and a given value

Parameters:

• parameter (Parameter) – Input Parameter.

• value (float) – Value to compare against.

Returns:

Object yielding the largest value.

Return type:

Parameter

nest.math.hl_api_math.min(parameter, value)

Yields the smallest value of the value of a parameter and a given value

Parameters:

• parameter (Parameter) – Input Parameter.

• value (float) – Value to compare against.

Returns:

Object yielding the smallest value.

Return type:

Parameter

nest.math.hl_api_math.redraw(parameter, min, max)

Redraws the value of the parameter if it is outside of the given limits

Both min and max values are included in the limit. If the number of redraws exceeds 1000, an error is thrown.

Parameters:

• parameter (Parameter) – Input Parameter.

• min (float) – Lower bound of the value.

• max (float) – Upper bound of the value.

Returns:

Object redrawing the parameter until it can yield a value within the given limits.

Return type:

Parameter

nest.math.hl_api_math.sin(parameter)

Calculate the sine of the parameter

Parameters:

parameter (Parameter) – Input Parameter.

Returns:

Object representing the sine of the parameter.

Return type:

Parameter