IntSignalSource (BandM signal & music)

All Superinterfaces:

AbstractSignalSource, CompilableDataFlow, IntSupplier

All Known Subinterfaces:

EnumClockedSignalSource<E>, EnumSignalSource<E>, IntClockedSignalSource

All Known Implementing Classes:

CompilableEnumStoredSignalSource, CompilableIntStoredSignalSource, EnumDelay, EnumSignalSourceChooser, EnumStoredSignalSource, IntClockedSignalSource.AbstractRandom, IntDelay, IntMultiDelay, IntSignalPort, IntSignalSourceChooser, IntSignalSourceChooser.OfEnum, IntSignalSourceChooser.OfEnumInt, IntSignalSourceChooser.OfInt, IntStoredSignalSource

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 IntSignalSource
extends AbstractSignalSource, IntSupplier
```
Interface of a signal (time-dependent value) source of primitive type int.
This basic interface is neutral with respect to whether values may change at arbitrary times or synchronously with respect to a clock, and to whether values are computed on the fly when demanded, or stored when available and then just retrieved.

See Also:

IntClockedSignalSource

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default IntSignalSource`	`abs()` Returns a new signal source whose value is the absolute of the value of this signal source.
`default IntSignalSource`	`add(IntSignalSource other)` Returns a new signal source whose value is the sum of the simultaneous values of this and another signal source.
`static IntSignalSource`	`choose(BooleanSignalSource condition, IntSignalSource inTrue, IntSignalSource inFalse)` Returns a new signal source whose value is that of either of two given type-compatible signal sources, depending on the current value of a condition signal source.
`static <E extends Enum<E>> IntSignalSource`	`choose(EnumSignalSource<E> selector, EnumMap<E,? extends IntSignalSource> cases)` Returns a new signal source whose value is selected dynamically from a range of cases indexed by `enum` values.
`static <E extends Enum<E>> IntSignalSource`	`choose(EnumSignalSource<E> selector, IntSignalSource... cases)` Returns a new signal source whose value is selected dynamically from a range of cases indexed by `enum` values.
`static <E extends Enum<E>> IntSignalSource`	`choose(SignalSource<E> selector, EnumMap<E,? extends IntSignalSource> cases)` Returns a new signal source whose value is selected dynamically from a range of cases indexed by `enum` values.
`static IntClockedSignalSource`	`clock(IntSignalSource output, Process... processes)`
`default Consumer<CompilationContext>`	`compileDataFlow()` Returns a code generator for outputting the value of this entity.
`default void`	`compileMainSignalSource(CompilationContext context)`
`static IntSignalSource`	`constant(int value)` Returns a signal source whose value is constant (never changes).
`default IntClockedSignalSource`	`delayed(int... initialValues)` Returns a new signal source that mirror the values of this signal source delayed by a given number of clock ticks.
`default IntClockedSignalSource`	`delayed(int initialValue)` Returns a new signal source that mirrors the values of this signal source delayed by one clock tick.
`static IntClockedSignalSource`	`delayedFeedback(Function<? super IntClockedSignalSource,? extends IntSignalSource> loop, int... initialValues)`
`static IntClockedSignalSource`	`delayedFeedback(Function<? super IntClockedSignalSource,? extends IntSignalSource> loop, int initialValue)` Returns a new signal source that receives its own delayed output as input.
`default IntSignalSource`	`divide(IntSignalSource other)` Returns a new signal source whose value is the quotient of the simultaneous values of this and another signal source.
`default BooleanSignalSource`	`equal(IntSignalSource other)` Returns a new signal source whose value is `true` iff the value of this signal source is equal to the simultaneous value of another signal source.
`int`	`getAsInt()` Returns the current value of this signal source.
`default Optional<Integer>`	`getConstantAsInt()` Returns the constant value of this signal source, if applicable.
`default Class<?>`	`getValueClass()` Returns the type of values produced by this entity.
`default BooleanSignalSource`	`greaterOrEqual(IntSignalSource other)` Returns a new signal source whose value is `true` iff the value of this signal source is greater than or equal to the simultaneous value of another signal source.
`default BooleanSignalSource`	`greaterThan(IntSignalSource other)` Returns a new signal source whose value is `true` iff the value of this signal source is greater than the simultaneous value of another signal source.
`default BooleanSignalSource`	`guard(IntPredicate pred)` Returns a boolean signal source whose values are derived from the values of this signal source by applying a unary predicate.
`default boolean`	`hasConstantAsInt()` Checks whether this signal source has a constant value.
`default IntClockedSignalSource`	`invariant()`
`default BooleanSignalSource`	`lessOrEqual(IntSignalSource other)` Returns a new signal source whose value is `true` iff the value of this signal source is less than or equal to the simultaneous value of another signal source.
`default BooleanSignalSource`	`lessThan(IntSignalSource other)` Returns a new signal source whose value is `true` iff the value of this signal source is less than the simultaneous value of another signal source.
`default IntSignalSource`	`map(IntUnaryOperator op)` Returns a signal source whose values are derived from the values of this signal source by applying a unary function.
`default IntSignalSource`	`max(IntSignalSource other)` Returns a new signal source whose value is the maximum of the simultaneous values of this and another signal source.
`default IntSignalSource`	`min(IntSignalSource other)` Returns a new signal source whose value is the minimum of the simultaneous values of this and another signal source.
`default IntSignalSource`	`modulo(IntSignalSource other)` Returns a new signal source whose value is the division remainder of the simultaneous values of this and another signal source.
`default IntSignalSource`	`multiply(IntSignalSource other)` Returns a new signal source whose value is the product of the simultaneous values of this and another signal source.
`default IntSignalSource`	`negate()` Returns a new signal source whose value is the negative of the value of this signal source.
`default BooleanSignalSource`	`negative()` Returns a new signal source whose value is `true` iff the value of this signal source is a negative number.
`default BooleanSignalSource`	`nonEqual(IntSignalSource other)` Returns a new signal source whose value is `true` iff the value of this signal source is not equal to the simultaneous value of another signal source.
`default BooleanSignalSource`	`nonnegative()` Returns a new signal source whose value is `true` iff the value of this signal source is a nonnegative number.
`default BooleanSignalSource`	`nonpositive()` Returns a new signal source whose value is `true` iff the value of this signal source is a nonpositive number.
`default BooleanSignalSource`	`nonzero()` Returns a new signal source whose value is `true` iff the value of this signal source is not the number zero.
`default BooleanSignalSource`	`positive()` Returns a new signal source whose value is `true` iff the value of this signal source is a positive number.
`default IntClockedSignalSource`	`power(BinaryOperator<IntSignalSource> op, long n)`
`default Process`	`probe(Object key)` Returns a realtime event that, when fired, notifies the concerned observer of the current value of this signal source.
`default void`	`publishStoredValueVariable(CompilationContext context)`
`default BooleanSignalSource`	`relateWith(IntBiPredicate pred, IntSignalSource other)` Returns a boolean signal source whose values are derived from the simultaneous values of this and another signal source by applying a binary predicate.
`default IntClockedSignalSource`	`sampleAndHold(BooleanSignalSource hold, int initialValue)` Returns a new clocked signal source whose value at each clock tick is either the current value of this signal source (sample mode), or its own value at the previous clock tick (hold mode), depending on the current value of a given boolean signal source.
`default IntClockedSignalSource`	`stored()` Returns a new signal source that stores snapshot values of this signal source driven by a clock.
`default IntSignalSource`	`subtract(IntSignalSource other)` Returns a new signal source whose value is the difference of the simultaneous values of this and another signal source.
`default BooleanSignalSource`	`zero()` Returns a new signal source whose value is `true` iff the value of this signal source is the number zero.
`default IntSignalSource`	`zipWith(IntBinaryOperator op, IntSignalSource other)` Returns a signal source whose values are derived from the simultaneous values of this and another signal source by applying a binary function.

Methods inherited from interface eu.bandm.sig.adlib2.compile.CompilableDataFlow
compileDataFlowTo, hasDataFlowIO

- Method Detail
  - getAsInt
```
int getAsInt()
```
    Returns the current value of this signal source.
    The value may be either computed on demand, or retrieved from storage.
    Implementations of this method should have no side effect.
    
    Specified by:
    
    getAsInt in interface IntSupplier
    
    Returns:
    
    the current value of this signal source
  - getValueClass
```
default Class<?> getValueClass()
```
    Returns the type of values produced by this entity.
    For signals of primitive value type, the result will be the corresponding pseudoclass.
    This implementation returns the primitive pseudoclass int.class.
    
    Specified by:
    
    getValueClass in interface CompilableDataFlow
    
    Returns:
    
    the type of signal values that this entity produces
    
    See Also:
    
    Class.isPrimitive()
  - getConstantAsInt
```
default Optional<Integer> getConstantAsInt()
```
    Returns the constant value of this signal source, if applicable.
    
    Returns:
    
    an Optional containing the value of this signal source if it is constant, or Optional.empty() otherwise.
  - hasConstantAsInt
```
default boolean hasConstantAsInt()
```
    Checks whether this signal source has a constant value.
    
    Returns:
    
    true iff the value of this signal source does not change over time
  - compileDataFlow
```
default Consumer<CompilationContext> compileDataFlow()
```
    Returns a code generator for outputting the value of this entity.
    This implementation generates code to invoke this.getAsInt().
    
    Specified by:
    
    compileDataFlow in interface CompilableDataFlow
  - constant
```
static IntSignalSource constant(int value)
```
    Returns a signal source whose value is constant (never changes).
    
    Parameters:
    
    value - the value of the new signal source
    
    Returns:
    
    a signal source that always has the given value
  - map
```
default IntSignalSource map(IntUnaryOperator op)
```
    Returns a signal source whose values are derived from the values of this signal source by applying a unary function.
    The implementation yields a signal source that computes the derived value by applying the given function every time its getAsInt() method is invoked. If the computation is costly and the value reused often, it may be convenient to compute and store the value proactively driven by a clock.
    
    Parameters:
    
    op - the function to apply to each value
    
    See Also:
    
    stored()
  - zipWith
```
default IntSignalSource zipWith(IntBinaryOperator op,
                                IntSignalSource other)
```
    Returns a signal source whose values are derived from the simultaneous values of this and another signal source by applying a binary function.
    The implementation yields a signal source that computes the derived value by applying the given function every time its getAsInt() method is invoked. If the computation is costly and the value reused often, it may be convenient to compute the value proactively driven by a clock.
    
    Parameters:
    
    op - the function to apply to each pair of values
    
    other - the other signal source to consider
    
    See Also:
    
    stored()
  - guard
```
default BooleanSignalSource guard(IntPredicate pred)
```
    Returns a boolean signal source whose values are derived from the values of this signal source by applying a unary predicate.
    The implementation yields a signal source that computes the derived value by applying the given predicate every time its getAsInt() method is invoked. If the computation is costly and the value reused often, it may be convenient to compute the value proactively driven by a clock.
    
    Parameters:
    
    pred - the predicate to apply to each value
    
    See Also:
    
    stored()
  - relateWith
```
default BooleanSignalSource relateWith(IntBiPredicate pred,
                                       IntSignalSource other)
```
    Returns a boolean signal source whose values are derived from the simultaneous values of this and another signal source by applying a binary predicate.
    The implementation yields a signal source that computes the derived value by applying the given predicate every time its getAsInt() method is invoked. If the computation is costly and the value reused often, it may be convenient to compute the value proactively driven by a clock.
    
    Parameters:
    
    pred - the predicate to apply to each value
    
    other - the other signal source to consider
    
    See Also:
    
    stored()
  - clock
```
@Undocumented
static IntClockedSignalSource clock(IntSignalSource output,
                                                  Process... processes)
```
  - invariant
```
@Undocumented
default IntClockedSignalSource invariant()
```
  - stored
```
default IntClockedSignalSource stored()
```
    Returns a new signal source that stores snapshot values of this signal source driven by a clock.
    The getAsInt() method of the returned signal source is guaranteed to be extremely fast, both in interpreted and compiled mode. The computational effort of the underlying signal source is instead spent on the Process.step(RealtimeContext) method of the returned signal source, to be invoked at each clock tick.
    If the underlying signal source is constant, the value is forwarded when the Process.init() method of the returned signal source is invoked, where as its implementation of Process.step(RealtimeContext) does nothing.
    
    Returns:
    
    a new signal source that takes value snapshots of this signal source.
  - delayed
```
default IntClockedSignalSource delayed(int initialValue)
```
    Returns a new signal source that mirrors the values of this signal source delayed by one clock tick.
    
    Parameters:
    
    initialValue - the initial value to output for the first clock tick
  - delayed
```
default IntClockedSignalSource delayed(int... initialValues)
```
    Returns a new signal source that mirror the values of this signal source delayed by a given number of clock ticks.
    The length of the delay in clock ticks is specified implicitly by the number of initial values.
    
    Parameters:
    
    initialValues - the initial values to output for the first clock ticks
  - delayedFeedback
```
static IntClockedSignalSource delayedFeedback(Function<? super IntClockedSignalSource,? extends IntSignalSource> loop,
                                              int initialValue)
```
    Returns a new signal source that receives its own delayed output as input.
    The circular data flow is constructed by specifying a function that receives as its argument a delayed signal source that will be fed back from the source that it returns. The passed function is applied exactly once.
    The output signal source is used both internally for the delayed feedback, and possibly externally by a consumer. Hence its value is stored implicitly in an intermediate variable in order to avoid duplicate computations.
    
    Parameters:
    
    loop - the function that creates the output signal source, given its delayed feedback
    
    initialValue - the initial value of the delayed feedback
  - delayedFeedback
```
@SafeVarargs
static IntClockedSignalSource delayedFeedback(Function<? super IntClockedSignalSource,? extends IntSignalSource> loop,
                                                           int... initialValues)
```
  - probe
```
default Process probe(Object key)
```
    Returns a realtime event that, when fired, notifies the concerned observer of the current value of this signal source.
    
    Parameters:
    
    key - the key to associate the value of this signal source with
    
    See Also:
    
    RealtimeContext.getSignalProbe()
  - choose
```
static IntSignalSource choose(BooleanSignalSource condition,
                              IntSignalSource inTrue,
                              IntSignalSource inFalse)
```
    Returns a new signal source whose value is that of either of two given type-compatible signal sources, depending on the current value of a condition signal source.
    At any point in time, choose(condition, x, y).getAsInt() == (this.getAsInt() ? x : y).getAsInt() holds.
    
    Parameters:
    
    condition - the condition signal source
    
    inTrue - the signal source to consider when the value of the condition signal source is true
    
    inFalse - the signal source to consider when the value of the condition signal source is false
  - negate
```
default IntSignalSource negate()
```
    Returns a new signal source whose value is the negative of the value of this signal source.
    For a signal source that = this.negate(), at any point in time, that.getAsInt() == -this.getAsInt() holds.
  - add
```
default IntSignalSource add(IntSignalSource other)
```
    Returns a new signal source whose value is the sum of the simultaneous values of this and another signal source.
    At any point in time, this.add(other).getAsInt() == this.getAsInt() + other.getAsInt() holds.
    
    Parameters:
    
    other - the other signal source to consider
  - multiply
```
default IntSignalSource multiply(IntSignalSource other)
```
    Returns a new signal source whose value is the product of the simultaneous values of this and another signal source.
    At any point in time, this.multiply(other).getAsInt() == this.getAsInt() * other.getAsInt() holds.
    
    Parameters:
    
    other - the other signal source to consider
  - subtract
```
default IntSignalSource subtract(IntSignalSource other)
```
    Returns a new signal source whose value is the difference of the simultaneous values of this and another signal source.
    At any point in time, this.subtract(other).getAsInt() == this.getAsInt() - other.getAsInt() holds.
    
    Parameters:
    
    other - the other signal source to consider
  - divide
```
default IntSignalSource divide(IntSignalSource other)
```
    Returns a new signal source whose value is the quotient of the simultaneous values of this and another signal source.
    At any point in time, this.divide(other).getAsInt() == this.getAsInt() / other.getAsInt() holds.
    
    Parameters:
    
    other - the other signal source to consider
  - modulo
```
default IntSignalSource modulo(IntSignalSource other)
```
    Returns a new signal source whose value is the division remainder of the simultaneous values of this and another signal source.
    At any point in time, this.modulo(other).getAsInt() == this.getAsInt() % other.getAsInt() holds.
    
    Parameters:
    
    other - the other signal source to consider
  - abs
```
default IntSignalSource abs()
```
    Returns a new signal source whose value is the absolute of the value of this signal source.
    At any point in time, this.abs().getAsInt() == Math.abs(this.getAsInt()) holds.
  - min
```
default IntSignalSource min(IntSignalSource other)
```
    Returns a new signal source whose value is the minimum of the simultaneous values of this and another signal source.
    At any point in time, this.min(other).getAsInt() == Math.min(this.getAsInt(), other.getAsInt()) holds.
    
    Parameters:
    
    other - the other signal source to consider
  - max
```
default IntSignalSource max(IntSignalSource other)
```
    Returns a new signal source whose value is the maximum of the simultaneous values of this and another signal source.
    At any point in time, this.max(other).getAsInt() == Math.max(this.getAsInt(), other.getAsInt()) holds.
    
    Parameters:
    
    other - the other signal source to consider
  - positive
```
default BooleanSignalSource positive()
```
    Returns a new signal source whose value is true iff the value of this signal source is a positive number.
    At any point in time, this.positive().getAsBoolean() == this.getAsInt() > 0 holds.
  - negative
```
default BooleanSignalSource negative()
```
    Returns a new signal source whose value is true iff the value of this signal source is a negative number.
    At any point in time, this.positive().getAsBoolean() == this.getAsInt() < 0 holds.
  - nonpositive
```
default BooleanSignalSource nonpositive()
```
    Returns a new signal source whose value is true iff the value of this signal source is a nonpositive number.
    At any point in time, this.positive().getAsBoolean() == this.getAsInt() <= 0 holds.
  - nonnegative
```
default BooleanSignalSource nonnegative()
```
    Returns a new signal source whose value is true iff the value of this signal source is a nonnegative number.
    At any point in time, this.positive().getAsBoolean() == this.getAsInt() >= 0 holds.
  - zero
```
default BooleanSignalSource zero()
```
    Returns a new signal source whose value is true iff the value of this signal source is the number zero.
    At any point in time, this.positive().getAsBoolean() == this.getAsInt() == 0 holds.
  - nonzero
```
default BooleanSignalSource nonzero()
```
    Returns a new signal source whose value is true iff the value of this signal source is not the number zero.
    At any point in time, this.positive().getAsBoolean() == this.getAsInt() != 0 holds.
  - lessThan
```
default BooleanSignalSource lessThan(IntSignalSource other)
```
    Returns a new signal source whose value is true iff the value of this signal source is less than the simultaneous value of another signal source.
    At any point in time, this.lessThan(other).getAsBoolean() == this.getAsInt() < other.getAsInt() holds.
    
    Parameters:
    
    other - the other signal source to consider
  - greaterThan
```
default BooleanSignalSource greaterThan(IntSignalSource other)
```
    Returns a new signal source whose value is true iff the value of this signal source is greater than the simultaneous value of another signal source.
    At any point in time, this.lessThan(other).getAsBoolean() == this.getAsInt() > other.getAsInt() holds.
    
    Parameters:
    
    other - the other signal source to consider
  - lessOrEqual
```
default BooleanSignalSource lessOrEqual(IntSignalSource other)
```
    Returns a new signal source whose value is true iff the value of this signal source is less than or equal to the simultaneous value of another signal source.
    At any point in time, this.lessOrEqua;(other).getAsBoolean() == this.getAsInt() <= other.getAsInt() holds.
    
    Parameters:
    
    other - the other signal source to consider
  - greaterOrEqual
```
default BooleanSignalSource greaterOrEqual(IntSignalSource other)
```
    Returns a new signal source whose value is true iff the value of this signal source is greater than or equal to the simultaneous value of another signal source.
    At any point in time, this.greaterOrEqual(other).getAsBoolean() == this.getAsInt() >= other.getAsInt() holds.
    
    Parameters:
    
    other - the other signal source to consider
  - equal
```
default BooleanSignalSource equal(IntSignalSource other)
```
    Returns a new signal source whose value is true iff the value of this signal source is equal to the simultaneous value of another signal source.
    At any point in time, this.equal(other).getAsBoolean() == this.getAsInt() == other.getAsInt() holds.
    
    Parameters:
    
    other - the other signal source to consider
  - nonEqual
```
default BooleanSignalSource nonEqual(IntSignalSource other)
```
    Returns a new signal source whose value is true iff the value of this signal source is not equal to the simultaneous value of another signal source.
    At any point in time, this.nonEqual(other).getAsBoolean() == this.getAsInt() != other.getAsInt() holds.
    
    Parameters:
    
    other - the other signal source to consider
  - choose
```
static <E extends Enum<E>> IntSignalSource choose(SignalSource<E> selector,
                                                  EnumMap<E,? extends IntSignalSource> cases)
```
    Returns a new signal source whose value is selected dynamically from a range of cases indexed by enum values.
    At any point in time, choose(s, m).getAsInt() == m.get(s.get()).getAsInt() holds.
    The given map cases is assumed to be immutable and to contain an entry for every possible value of the enum type E.
    
    Type Parameters:
    
    E - the type of enum values
    
    Parameters:
    
    selector - the signal source that provides the enum value
    
    cases - a map of enum values to signal sources to select from
  - choose
```
static <E extends Enum<E>> IntSignalSource choose(EnumSignalSource<E> selector,
                                                  EnumMap<E,? extends IntSignalSource> cases)
```
    Returns a new signal source whose value is selected dynamically from a range of cases indexed by enum values.
    At any point in time, choose(s, m).getAsInt() == m.get(E.values()[s.getAsInt()]).getAsInt() holds.
    The given map cases is assumed to be immutable and to contain an entry for every possible value of the enum type E.
    
    Type Parameters:
    
    E - the type of enum values
    
    Parameters:
    
    selector - the signal source that provides the ordinal number of the enum value
    
    cases - a map of enum values to signal sources to select from
  - choose
```
@SafeVarargs
static <E extends Enum<E>> IntSignalSource choose(EnumSignalSource<E> selector,
                                                               IntSignalSource... cases)
```
    Returns a new signal source whose value is selected dynamically from a range of cases indexed by enum values.
    At any point in time, choose(s, a).getAsInt() == m[s.getAsInt()].getAsInt() holds.
    The given array cases is assumed to be immutable and to contain an element for every possible value of the enum type E.
    
    Type Parameters:
    
    E - the type of enum values
    
    Parameters:
    
    selector - the signal source that provides the enum value
    
    cases - an array signal sources to select from, in the definition order of enum elements
  - sampleAndHold
```
default IntClockedSignalSource sampleAndHold(BooleanSignalSource hold,
                                             int initialValue)
```
    Returns a new clocked signal source whose value at each clock tick is either the current value of this signal source (sample mode), or its own value at the previous clock tick (hold mode), depending on the current value of a given boolean signal source.
    
    Parameters:
    
    hold - a boolean signal source that, at each clock tick, selects hold mode if its value ist true, or sample mode if its value is false
    
    initialValue - the initial value to use if in hold mode at the first clock tick
  - power
```
@Undocumented
default IntClockedSignalSource power(BinaryOperator<IntSignalSource> op,
                                                   long n)
```
  - compileMainSignalSource
```
@Undocumented
default void compileMainSignalSource(CompilationContext context)
```
  - publishStoredValueVariable
```
@Undocumented
default void publishStoredValueVariable(CompilationContext context)
```

Interface IntSignalSource

Method Summary

Methods inherited from interface eu.bandm.sig.adlib2.compile.CompilableDataFlow

Method Detail

getAsInt

getValueClass

getConstantAsInt

hasConstantAsInt

compileDataFlow

constant

map

zipWith

guard

relateWith

clock

invariant

stored

delayed

delayed

delayedFeedback

delayedFeedback

probe

choose

negate

add

multiply

subtract

divide

modulo

abs

min

max

positive

negative

nonpositive

nonnegative

zero

nonzero

lessThan

greaterThan

lessOrEqual

greaterOrEqual

equal

nonEqual

choose

choose

choose

sampleAndHold

power

compileMainSignalSource

publishStoredValueVariable