eu.bandm.sig.adlib

Class FloatClockedSignalSource

java.lang.Object

eu.bandm.sig.adlib.FloatClockedSignalSource

All Implemented Interfaces:

CompilableControlFlow, CompilableDataFlow, FloatSignalSource, FloatSupplier, Realtime, SignalSource<Float>, Runnable, Supplier<Float>

Direct Known Subclasses:

Apdsr, DataLineSource, FloatDelay, FloatOscillator, FloatPfg, FloatResonator, FloatRingBuffer, FloatSamplePlayer, FloatSlopeLimiter, FloatTwoTablesOscillator

public abstract class FloatClockedSignalSource
extends Object
implements FloatSignalSource, SignalSource<Float>, Realtime

Abstract base class for objects that emit a signal of type float, which attains new values only at clock events.

Note that object creation is not a clock event; whether instances of this class have a meaningful signal value depends on the particular subclass.

Subclasses must implement the method Realtime.run(), which should set the field out to a new value.

ATTENTION: This implements SignalSource, which defines the method get() for the boxed result. But it is not a subclass of ClockedSignalSource, because this would also add a boxed field named , which is not useful for the fast and dedicated way of operation.

Nested Class Summary

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

FloatSignalSource.CompilableFloatBinaryOperator, FloatSignalSource.FloatAddOperator, FloatSignalSource.FloatDivOperator, FloatSignalSource.FloatMultOperator, 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
protected float	out The current value.

Fields inherited from interface eu.bandm.sig.adlib.FloatSignalSource

abs, add, clip, cos, div, E, exp, log, LOG2, metaGetAsFloat, mult, neg, PI, sin, sqrt, SQRT2, square, sub

Fields inherited from interface eu.bandm.sig.adlib.Realtime

DEFAULT_AFAP_INTERRUPT_LATENCY, DEFAULT_SLEEP_TIME_MS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FloatClockedSignalSource() Creates a new instance with no specified initial value.
protected	FloatClockedSignalSource(float init) Creates a new instance with the given initial value.

Method Summary

Modifier and Type	Method and Description
FloatClockedSignalSource	delayedBy(int length) Creates a wrapper that emits the same sequence of values as this object, but delayed by the given number of clock events.
FloatClockedSignalSource	delayedWith(float... initialValues) Creates a wrapper that emits the same sequence of values as this object, but delayed by a given number of clock events, prepending the given initial values.
protected <V,L> void	doCompileDataFlow(CompilationContext<V,L> context)
Float	get() Deprecated.
float	getAsFloat() Returns the current value of the signal.
static FloatClockedSignalSource	iterate(FloatUnaryOperator op, float initial)
Realtime	logged(String name) Creates a wrapper that emits the same signal values as this object, but produces a logging output as side effect on each clock event.
Realtime	logged(String name, PrintStream out) Creates a wrapper that emits the same signal values as this object, but produces a logging output as side effect on each clock event.
static FloatClockedSignalSource	random(ToFloatFunction<Random> fun)
static FloatClockedSignalSource	randomNormal()
static FloatClockedSignalSource	randomUniform()
static FloatClockedSignalSource	repeat(float... table) Creates an object that emits a given sequence of values, proceeding cyclically at each clock event.
static FloatClockedSignalSource	slide(float sampleFreq, float duration) Creates an object that emits a signal rising at clock events in equal steps from 0 to 1, with a given slope.
static FloatClockedSignalSource	suppliedBy(float init, FloatSupplier step)
static FloatClockedSignalSource	suppliedBy(FloatSupplier supplier)
FloatClockedSignalSource	switchOver(int countdown, FloatClockedSignalSource next)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface eu.bandm.sig.adlib.FloatSignalSource

add, check, clip, clocked, compileDataFlow, constant, div, guard, logger, logger, lowerLogSpread, map, mult, project, project, project, sub, upperLogSpread, zipWith, zipWith

Methods inherited from interface eu.bandm.sig.adlib.Realtime

adHoc, afap, afap, andThen, asAsynchronousSwingEvent, compileControlFlow, every, every, frequently, frequently, frequently, run, sequence, times, times

Field Detail

out

protected float out

The current value.

Constructor Detail

FloatClockedSignalSource

protected FloatClockedSignalSource()

Creates a new instance with no specified initial value.

FloatClockedSignalSource

protected FloatClockedSignalSource(float init)

Creates a new instance with the given initial value.

Parameters:

init - the initial value.

Method Detail

getAsFloat

public final 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 FloatSignalSource

Specified by:

getAsFloat in interface FloatSupplier

Returns:

the current value of out.

get

@Deprecated
public final Float get()

Deprecated.

Returns the current value of the signal.

Specified by:

get in interface FloatSignalSource

Specified by:

get in interface SignalSource<Float>

Specified by:

get in interface Supplier<Float>

Returns:

the current value of out.

suppliedBy

public static FloatClockedSignalSource suppliedBy(FloatSupplier supplier)

suppliedBy

public static FloatClockedSignalSource suppliedBy(float init,
                                                  FloatSupplier step)

delayedBy

public FloatClockedSignalSource delayedBy(int length)

Creates a wrapper that emits the same sequence of values as this object, but delayed by the given number of clock events. The prepended initial values are not specified.

Parameters:

length - the number of clock events to delay each signal value.

Returns:

a wrapper that emits the same sequence of values as this object, delayed by (length) clock events.

Throws:

IllegalArgumentException - if length < 0.

delayedWith

public FloatClockedSignalSource delayedWith(float... initialValues)

Creates a wrapper that emits the same sequence of values as this object, but delayed by a given number of clock events, prepending the given initial values.

Parameters:

initial - the number of clock events to delay each signal value.

Returns:

a wrapper that emits the same sequence of values as this object, but with initialValues prepended.

Throws:

IllegalArgumentException - if initialValues == null.

logged

public Realtime logged(String name)

Creates a wrapper that emits the same signal values as this object, but produces a logging output as side effect on each clock event.

Parameters:

name - the name to associate with the current signal value in logging output, or null for anonymous output.

See Also:

FloatSignalSource.logger(String)

logged

public Realtime logged(String name,
                       PrintStream out)

Creates a wrapper that emits the same signal values as this object, but produces a logging output as side effect on each clock event.

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:

FloatSignalSource.logger(String, PrintStream)

repeat

public static FloatClockedSignalSource repeat(float... table)

Creates an object that emits a given sequence of values, proceeding cyclically at each clock event.

Parameters:

table - an array of the values to attain cyclically

Returns:

an object that attains the value table[(n - 1) % table.length] at the n-th clock event.

iterate

public static FloatClockedSignalSource iterate(FloatUnaryOperator op,
                                               float initial)

slide

public static FloatClockedSignalSource slide(float sampleFreq,
                                             float duration)

Creates an object that emits a signal rising at clock events in equal steps from 0 to 1, with a given slope.

Parameters:

sampleFreq - the number of clock events per time unit.

duration - the length of the rise in time units.

Returns:

an object that emits a signal that is 0 at the first clock event, rises to 1 in (duration * sampleFreq) steps, and remains 1 afterwards.

switchOver

public FloatClockedSignalSource switchOver(int countdown,
                                           FloatClockedSignalSource next)

doCompileDataFlow

protected final <V,L> void doCompileDataFlow(CompilationContext<V,L> context)

random

public static FloatClockedSignalSource random(ToFloatFunction<Random> fun)

randomUniform

public static FloatClockedSignalSource randomUniform()

randomNormal

public static FloatClockedSignalSource randomNormal()