Packages

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

Select

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TWindex
  2. Serializable
  3. SingleOut
  4. SomeOut
  5. Lazy
  6. GE
  7. UGenSource
  8. Expander
  9. Lazy
  10. Product
  11. Equals
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. 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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  8. lazy val hashCode: Int
    Definition Classes
    UGenSource → AnyRef → Any
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. def makeUGen(_args: Vec[UGenIn]): UGenInLike
    Attributes
    protected
    Definition Classes
    TWindexUGenSource
  11. def makeUGens: UGenInLike

    Abstract method which must be implemented by creating the actual UGens during expansion.

    Abstract method which must be implemented by creating the actual UGens during expansion. This method is at most called once during graph expansion

    returns

    the expanded object (depending on the type parameter U)

    Attributes
    protected
    Definition Classes
    TWindexExpander
  12. final def name: String
    Definition Classes
    UGenSource
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. val normalize: GE
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. val prob: GE
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. val rate: Rate
    Definition Classes
    TWindexGE
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. val trig: GE
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from SingleOut

Inherited from SomeOut

Inherited from GE.Lazy

Inherited from GE

Inherited from UGenSource[UGenInLike]

Inherited from Expander[UGenInLike]

Inherited from Lazy

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped