Skip to content

Function gen_random_normal

function gen_random_normal(const random_state &, T, T) base

template <typename T, index_t Dims = 1>
KFR_FUNCTION expression_random_normal<T, Dims> gen_random_normal(const random_state& state, T sigma = 1,
                                                                 T mu = 0)

Creates an expression that produces normally distributed values using a copied state.

Template parameters
T Value type of the generated samples.
Dims Number of dimensions of the expression.
Parameters
state Random generator state to copy into the expression.
sigma Standard deviation of the distribution.
mu Mean of the distribution.
Returns
Expression generating values from N(mu, sigma^2).

Fully qualified name: kfr::gen_random_normal(const random_state &, T, T)

Declared at base/random.hpp:377

Function gen_random_normal

function gen_random_normal(std::reference_wrapper<random_state>, T, T) base

template <typename T, index_t Dims = 1>
KFR_FUNCTION expression_random_normal<T, Dims, true> gen_random_normal(
    std::reference_wrapper<random_state> state, T sigma = 1, T mu = 0)

Creates an expression that produces normally distributed values using a referenced state.

Use std::ref(state) to select this overload.

Template parameters
T Value type of the generated samples.
Dims Number of dimensions of the expression.
Parameters
state Reference wrapper to the random generator state.
sigma Standard deviation of the distribution.
mu Mean of the distribution.
Returns
Expression generating values from N(mu, sigma^2).

Fully qualified name: kfr::gen_random_normal(std::reference_wrapper<random_state>, T, T)

Declared at base/random.hpp:396

Function gen_random_normal

function gen_random_normal(T, T) base

template <typename T, index_t Dims = 1>
KFR_FUNCTION expression_random_normal<T, Dims> gen_random_normal(T sigma = 1, T mu = 0)

Creates an expression that produces normally distributed values seeded from the cycle counter.

Template parameters
T Value type of the generated samples.
Dims Number of dimensions of the expression.
Parameters
sigma Standard deviation of the distribution.
mu Mean of the distribution.
Returns
Expression generating values from N(mu, sigma^2).

Fully qualified name: kfr::gen_random_normal(T, T)

Declared at base/random.hpp:413

This file was generated by cxxdox, a C++ documentation generator based on MkDocs Material and libclang.