diff --git a/source/include/signalflow/node/stochastic/random-brownian.h b/source/include/signalflow/node/stochastic/random-brownian.h index fe466a95..5ec5c10e 100644 --- a/source/include/signalflow/node/stochastic/random-brownian.h +++ b/source/include/signalflow/node/stochastic/random-brownian.h @@ -8,6 +8,7 @@ namespace signalflow /**--------------------------------------------------------------------------------* * Outputs Brownian noise between min/max, with a mean change of delta between samples. * If a clock is passed, only generates a new value on a clock tick. + * To generate and hold an unchanging random value, pass clock=0. *---------------------------------------------------------------------------------*/ class RandomBrownian : public StochasticNode { diff --git a/source/include/signalflow/node/stochastic/random-choice.h b/source/include/signalflow/node/stochastic/random-choice.h index 633ebe62..0dd1b39e 100644 --- a/source/include/signalflow/node/stochastic/random-choice.h +++ b/source/include/signalflow/node/stochastic/random-choice.h @@ -8,6 +8,7 @@ namespace signalflow /**--------------------------------------------------------------------------------* * Pick a random value from the given array. * If a clock is passed, only picks a new value on a clock tick. + * To generate and hold an unchanging random value, pass clock=0. *---------------------------------------------------------------------------------*/ class RandomChoice : public StochasticNode { diff --git a/source/include/signalflow/node/stochastic/random-coin.h b/source/include/signalflow/node/stochastic/random-coin.h index d0b1977d..3247705d 100644 --- a/source/include/signalflow/node/stochastic/random-coin.h +++ b/source/include/signalflow/node/stochastic/random-coin.h @@ -8,6 +8,7 @@ namespace signalflow /**--------------------------------------------------------------------------------* * Flip a coin with the given probability. * If a clock is passed, only picks a new value on a clock tick. + * To generate and hold an unchanging random value, pass clock=0. *---------------------------------------------------------------------------------*/ class RandomCoin : public StochasticNode { diff --git a/source/include/signalflow/node/stochastic/random-exponential-dist.h b/source/include/signalflow/node/stochastic/random-exponential-dist.h index ca2eb438..384ab421 100644 --- a/source/include/signalflow/node/stochastic/random-exponential-dist.h +++ b/source/include/signalflow/node/stochastic/random-exponential-dist.h @@ -8,6 +8,7 @@ namespace signalflow /**--------------------------------------------------------------------------------* * Generate an random value following the exponential distribution. * If a clock is passed, only picks a new value on a clock tick. + * To generate and hold an unchanging random value, pass clock=0. *---------------------------------------------------------------------------------*/ class RandomExponentialDist : public StochasticNode { diff --git a/source/include/signalflow/node/stochastic/random-exponential.h b/source/include/signalflow/node/stochastic/random-exponential.h index c631bbd6..4d2dd3c2 100644 --- a/source/include/signalflow/node/stochastic/random-exponential.h +++ b/source/include/signalflow/node/stochastic/random-exponential.h @@ -8,6 +8,7 @@ namespace signalflow /**--------------------------------------------------------------------------------* * Generate an random exponential value between min/max. * If a clock is passed, only picks a new value on a clock tick. + * To generate and hold an unchanging random value, pass clock=0. *---------------------------------------------------------------------------------*/ class RandomExponential : public StochasticNode { diff --git a/source/include/signalflow/node/stochastic/random-gaussian.h b/source/include/signalflow/node/stochastic/random-gaussian.h index 0b563e54..13584ce9 100644 --- a/source/include/signalflow/node/stochastic/random-gaussian.h +++ b/source/include/signalflow/node/stochastic/random-gaussian.h @@ -8,6 +8,7 @@ namespace signalflow /**--------------------------------------------------------------------------------* * Generate an random Gaussian value, with given mean and sigma. * If a clock is passed, only picks a new value on a clock tick. + * To generate and hold an unchanging random value, pass clock=0. *---------------------------------------------------------------------------------*/ class RandomGaussian : public StochasticNode { diff --git a/source/include/signalflow/node/stochastic/random-uniform.h b/source/include/signalflow/node/stochastic/random-uniform.h index 3067cdde..1eba1bb0 100644 --- a/source/include/signalflow/node/stochastic/random-uniform.h +++ b/source/include/signalflow/node/stochastic/random-uniform.h @@ -8,6 +8,7 @@ namespace signalflow /**--------------------------------------------------------------------------------* * Generates a uniformly random value between min/max. * If a clock is passed, only picks a new value on a clock tick. + * To generate and hold an unchanging random value, pass clock=0. *---------------------------------------------------------------------------------*/ class RandomUniform : public StochasticNode {