Random module¶

nest.random.hl_api_random.exponential(beta=1.0)¶

Draws samples from an exponential distribution.

Parameters:: beta (float, optional) – Scale parameter the distribution. Default value is 1.0.
Returns:: Object yielding values drawn from the distribution.
Return type:: Parameter

nest.random.hl_api_random.lognormal(mean=0.0, std=1.0)¶

Draws samples from a log-normal distribution.

Parameters:

mean (float, optional) – Mean value of the underlying normal distribution. Default value is 0.
std (float, optional) – Standard deviation of the underlying normal distribution. Default value is 1.0.

Returns:

Object yielding values drawn from the distribution.

Return type:

Parameter

nest.random.hl_api_random.normal(mean=0.0, std=1.0)¶

Draws samples from a normal distribution.

Parameters:

mean (float, optional) – Mean of the distribution. Default value is 0.
std (float, optional) – Standard deviation of the distribution. Default value is 1.0.

Returns:

Object yielding values drawn from the distribution.

Return type:

Parameter

nest.random.hl_api_random.uniform(min=0.0, max=1.0)¶

Draws samples from a uniform distribution.

Samples are distributed uniformly in [min, max) (includes min, but excludes max).

Note

See this documentation for details on the effect of time discretization on delays drawn from a uniform distribution.

Parameters:

min (float, optional) – Lower boundary of the sample interval. Default value is 0.
max (float, optional) – Upper boundary of the sample interval. Default value is 1.0.

Returns:

Object yielding values drawn from the distribution.

Return type:

Parameter

nest.random.hl_api_random.uniform_int(max)¶

Draws integer samples from a uniform distribution.

Samples are distributed uniformly in [0, max) (includes 0, but excludes max).