FloatSignalSource (BandM signal & music)

All Superinterfaces:

CompilableDataFlow, FloatSupplier, SignalSource<Float>, Supplier<Float>

All Known Subinterfaces:

FloatVariable

All Known Implementing Classes:

Apdsr, BoundedFloatAdder, ClockedFloatSignalSource, DataLineSource, FloatAdder, FloatBoundedQuantization.Variable, FloatClockedSignalSource, FloatDelay, FloatLinearOscillator, FloatOscillator, FloatPfg, FloatResonator, FloatRingBuffer, FloatSamplePlayer, FloatSlopeLimiter, FloatTableOscillator, FloatTwoTablesOscillator, SigSequencer.FloatColumn

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
```
@FunctionalInterface
public interface FloatSignalSource
extends SignalSource<Float>, FloatSupplier, CompilableDataFlow
```
Common interface for all objects that emit a signal of type float. The current value of the signal can be observed in real time, by invoking getAsFloat().

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`FloatSignalSource.CompilableFloatBinaryOperator`
`static class`	`FloatSignalSource.FloatAddOperator`
`static class`	`FloatSignalSource.FloatDivOperator`
`static class`	`FloatSignalSource.FloatMultOperator`
`static class`	`FloatSignalSource.FloatSubOperator`

Nested classes/interfaces inherited from interface eu.bandm.sig.adlib.SignalSource
SignalSource.AddOperator, SignalSource.CompilableBinaryOperator, SignalSource.Constant<A>, SignalSource.DivOperator, SignalSource.MultOperator, SignalSource.SubOperator

Field Summary

Fields
Modifier and Type	Field and Description
`static FloatUnaryOperator`	`abs`
`static FloatBinaryOperator`	`add`
`static FloatUnaryOperator`	`clip`
`static FloatUnaryOperator`	`cos`
`static FloatBinaryOperator`	`div`
`static float`	`E`
`static FloatUnaryOperator`	`exp`
`static FloatUnaryOperator`	`log`
`static float`	`LOG2`
`static Method`	`metaGetAsFloat`
`static FloatBinaryOperator`	`mult`
`static FloatUnaryOperator`	`neg`
`static float`	`PI`
`static FloatUnaryOperator`	`sin`
`static FloatUnaryOperator`	`sqrt`
`static float`	`SQRT2`
`static FloatUnaryOperator`	`square`
`static FloatBinaryOperator`	`sub`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default FloatSignalSource`	`add(FloatSignalSource other)`
`default FloatSignalSource`	`check(String where, float min, float max)`
`static float`	`clip(float x)`
`default FloatClockedSignalSource`	`clocked(Realtime... slaves)` Creates a wrapper that emits clocked snapshots of values of the signal emitted by this object.
`default <V,L> void`	`compileDataFlow(CompilationContext<V,L> context)`
`static FloatSignalSource`	`constant(float value)` Creates an object that emits a constant signal.
`default FloatSignalSource`	`div(FloatSignalSource other)`
`default Float`	`get()` Deprecated. The default implementation boxes every value of type `float` into an object of class `Float`.
`float`	`getAsFloat()` Returns the current value of the signal.
`default BooleanSignalSource`	`guard(FloatPredicate pred)`
`default Realtime`	`logger(String name)` Creates a proxy that reacts to clock events by printing the signal value emitted by this object.
`default Realtime`	`logger(String name, PrintStream out)` Creates a proxy that reacts to clock events by printing the signal value emitted by this object.
`static FloatUnaryOperator`	`lowerLogSpread(float halfValue, float maxValue)` A function that maps the interval [0, 1] logarithmically to some interval of the form [±∞, a].
`default FloatSignalSource`	`map(FloatUnaryOperator op)` Creates a wrapper that emits a signal obtained by applying a given function to the current value of the signal emitted by this object.
`default FloatSignalSource`	`mult(FloatSignalSource other)`
`static FloatSignalSource[]`	`project(float... array)`
`static FloatSignalSource`	`project(float[] array, int index)` Creates a signal source that yields the current value of a specified array element.
`static float`	`project(float value, float min, float max, float outmin, float outmax)` Projects the position of the input value between min and max to the same position between outmin and outmax.
`default FloatSignalSource`	`sub(FloatSignalSource other)`
`static FloatUnaryOperator`	`upperLogSpread(float minValue, float halfValue)` A function that maps the interval [0, 1] logarithmically to some interval of the form [a, ±∞].
`default FloatSignalSource`	`zipWith(FloatBinaryOperator op, FloatSignalSource other)` Creates a wrapper that emits a signal obtained by applying a given function to the current values of the signals emitted by this object and another object.
`default FloatSignalSource`	`zipWith(FloatTernaryOperator op, FloatSignalSource second, FloatSignalSource third)`

- Field Detail
  - PI
```
static final float PI
```
    See Also:
    
    Constant Field Values
  - LOG2
```
static final float LOG2
```
  - E
```
static final float E
```
    See Also:
    
    Constant Field Values
  - SQRT2
```
static final float SQRT2
```
  - neg
```
static final FloatUnaryOperator neg
```
  - abs
```
static final FloatUnaryOperator abs
```
  - square
```
static final FloatUnaryOperator square
```
  - sqrt
```
static final FloatUnaryOperator sqrt
```
  - sin
```
static final FloatUnaryOperator sin
```
  - cos
```
static final FloatUnaryOperator cos
```
  - exp
```
static final FloatUnaryOperator exp
```
  - log
```
static final FloatUnaryOperator log
```
  - clip
```
static final FloatUnaryOperator clip
```
  - add
```
static final FloatBinaryOperator add
```
  - sub
```
static final FloatBinaryOperator sub
```
  - mult
```
static final FloatBinaryOperator mult
```
  - div
```
static final FloatBinaryOperator div
```
  - metaGetAsFloat
```
static final Method metaGetAsFloat
```
- Method Detail
  - getAsFloat
```
float getAsFloat()
```
    Returns the current value of the signal.
    Any implementation of this method should be stateless; its invocation should not have any side effect on the emitter or the observer, except for real time passing until its completion.
    
    Specified by:
    
    getAsFloat in interface FloatSupplier
    
    Returns:
    
    the current value of the signal.
  - get
```
@Deprecated
default Float get()
```
    Deprecated. The default implementation boxes every value of type float into an object of class Float.
    
    Returns the current value of the signal.
    
    Specified by:
    
    get in interface SignalSource<Float>
    
    Specified by:
    
    get in interface Supplier<Float>
  - constant
```
static FloatSignalSource constant(float value)
```
    Creates an object that emits a constant signal.
    
    Specified by:
    
    constant in interface SignalSource<Float>
    
    Parameters:
    
    value - the desired signal value.
    
    Returns:
    
    an object that emits a signal constantly having the value value.
  - clocked
```
default FloatClockedSignalSource clocked(Realtime... slaves)
```
    Creates a wrapper that emits clocked snapshots of values of the signal emitted by this object. A snapshot is observed at each clock event that the wrapper reacts to, and the snapshot value is held until the next event. The emitted value before the first clock event is unspecified.
    
    Returns:
    
    a wrapper that emits a signal that has the value observed by this.getAsFloat() at the immediately preceding clock event.
  - map
```
default FloatSignalSource map(FloatUnaryOperator op)
```
    Creates a wrapper that emits a signal obtained by applying a given function to the current value of the signal emitted by this object.
    The function value is computed each time the result signal is observed. If the invocation of the function is costly or otherwise time-sensitive, it is recommended to protect it with a clocked(eu.bandm.sig.adlib.Realtime...) wrapper, and trigger computations by explicit clock events.
    
    Parameters:
    
    op - the function to apply to each value.
    
    Returns:
    
    a wrapper that emits a signal that has the value op.applyAsFloat(this.getAsFloat()).
    
    Throws:
    
    IllegalArgumentException - if op == null.
  - guard
```
default BooleanSignalSource guard(FloatPredicate pred)
```
  - zipWith
```
default FloatSignalSource zipWith(FloatBinaryOperator op,
                                  FloatSignalSource other)
```
    Creates a wrapper that emits a signal obtained by applying a given function to the current values of the signals emitted by this object and another object.
    The function value is computed each time the result signal is observed. If the invocation of the function is costly or otherwise time-sensitive, it is recommended to protect it with a clocked(eu.bandm.sig.adlib.Realtime...) wrapper, and trigger computations by explicit clock events.
    
    Parameters:
    
    op - the function to apply to each value.
    
    other - the emitter of the other signal.
    
    Returns:
    
    a wrapper that emits a signal that has the value op.applyAsFloat(this.getAsFloat(), other.getAsFloat()).
    
    Throws:
    
    IllegalArgumentException - if op == null or other == null.
  - zipWith
```
default FloatSignalSource zipWith(FloatTernaryOperator op,
                                  FloatSignalSource second,
                                  FloatSignalSource third)
```
  - check
```
default FloatSignalSource check(String where,
                                float min,
                                float max)
```
  - clip
```
static float clip(float x)
```
  - logger
```
default Realtime logger(String name)
```
    Creates a proxy that reacts to clock events by printing the signal value emitted by this object.
    
    Parameters:
    
    name - the name to associate with the current signal value in logging output, or null for anonymous output.
    
    See Also:
    
    FloatClockedSignalSource.logged(String)
  - logger
```
default Realtime logger(String name,
                        PrintStream out)
```
    Creates a proxy that reacts to clock events by printing the signal value emitted by this object.
    
    Parameters:
    
    name - the name to associate with the current signal value in logging output, or null for anonymous output.
    
    out - the output stream to use for logging.
    
    Throws:
    
    IllegalArgumentException - if out == null.
    
    See Also:
    
    logger(String, PrintStream)
  - project
```
static float project(float value,
                     float min,
                     float max,
                     float outmin,
                     float outmax)
```
    Projects the position of the input value between min and max to the same position between outmin and outmax.
  - upperLogSpread
```
static FloatUnaryOperator upperLogSpread(float minValue,
                                         float halfValue)
```
    A function that maps the interval [0, 1] logarithmically to some interval of the form [a, ±∞].
    
    Parameters:
    
    minValue - the function value at 0.
    
    halfValue - the function value at 0.5.
  - lowerLogSpread
```
static FloatUnaryOperator lowerLogSpread(float halfValue,
                                         float maxValue)
```
    A function that maps the interval [0, 1] logarithmically to some interval of the form [±∞, a].
    
    Parameters:
    
    halfValue - the function value at 0.5.
    
    maxValue - the function value at 1.
  - compileDataFlow
```
default <V,L> void compileDataFlow(CompilationContext<V,L> context)
```
    Specified by:
    
    compileDataFlow in interface CompilableDataFlow
  - project
```
static FloatSignalSource project(float[] array,
                                 int index)
```
    Creates a signal source that yields the current value of a specified array element. The value of the signal changes instantly whenever the array element is overwritten.
    
    Parameters:
    
    array - the array containing the element
    
    index - the index of the element
    
    Returns:
    
    a signal source that always has the current value of the specified element, namely array[index]
    
    Throws:
    
    IllegalArgumentException - if array == null, or index is out of range
  - project
```
static FloatSignalSource[] project(float... array)
```
  - add
```
default FloatSignalSource add(FloatSignalSource other)
```
  - sub
```
default FloatSignalSource sub(FloatSignalSource other)
```
  - mult
```
default FloatSignalSource mult(FloatSignalSource other)
```
  - div
```
default FloatSignalSource div(FloatSignalSource other)
```

Interface FloatSignalSource

Nested Class Summary

Nested classes/interfaces inherited from interface eu.bandm.sig.adlib.SignalSource

Field Summary

Method Summary

Field Detail

PI

LOG2

E

SQRT2

neg

abs

square

sqrt

sin

cos

exp

log

clip

add

sub

mult

div

metaGetAsFloat

Method Detail

getAsFloat

get

constant

clocked

map

guard

zipWith

zipWith

check

clip

logger

logger

project

upperLogSpread

lowerLogSpread

compileDataFlow

project

project

add

sub

mult

div