final case class TWindex(rate: Rate, trig: GE, prob: GE, normalize: GE = 0) extends SingleOut with Product with Serializable
A UGen providing a probability-weighted index into a sequence upon receiving a trigger.
When triggered, returns a random index value based the values of the channels
of the prob
argument functioning as probabilities. The index is zero based,
hence goes from 0
to prob.numOutputs - 1
.
By default the sequence of probabilities should sum to 1.0, however for
convenience, this can be achieved by the ugen when the normalize
flag is set
to 1 (less efficient).
- trig
the trigger used to calculate a new index. a trigger occurs when passing from non-positive to positive
- prob
a multi-channel graph element, where the output channels correspond to to the probabilities of their respective indices being chosen.
- normalize
0
if the seq argument already sums up to 1.0 and thus doesn't need normalization,1
if the sum is not guaranteed to be 1.0 and thus the ugen is asked to provide the normalization.
- See also
- Alphabetic
- By Inheritance
- TWindex
- Serializable
- SingleOut
- SomeOut
- Lazy
- GE
- UGenSource
- Expander
- Lazy
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new TWindex(rate: Rate, trig: GE, prob: GE, normalize: GE = 0)
- trig
the trigger used to calculate a new index. a trigger occurs when passing from non-positive to positive
- prob
a multi-channel graph element, where the output channels correspond to to the probabilities of their respective indices being chosen.
- normalize
0
if the seq argument already sums up to 1.0 and thus doesn't need normalization,1
if the sum is not guaranteed to be 1.0 and thus the ugen is asked to provide the normalization.