Skip to content

Commit

Permalink
Add hint for generating unchanging random value
Browse files Browse the repository at this point in the history
  • Loading branch information
ideoforms committed Oct 30, 2024
1 parent 0d5e4ff commit 83b44d8
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
1 change: 1 addition & 0 deletions source/include/signalflow/node/stochastic/random-choice.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
1 change: 1 addition & 0 deletions source/include/signalflow/node/stochastic/random-coin.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
1 change: 1 addition & 0 deletions source/include/signalflow/node/stochastic/random-uniform.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down

0 comments on commit 83b44d8

Please sign in to comment.