Package eu.bandm.sig.adlib2

Interface DoubleSignalSource

All Superinterfaces:
AbstractSignalSource, CompilableDataFlow, DoubleSupplier
All Known Subinterfaces:
DoubleADSR, DoubleClockedSignalSource
All Known Implementing Classes:
CompilableDoubleStoredSignalSource, DoubleClockedSignalSource.AbstractRandom, DoubleDelay, DoubleEnvelope, DoubleFMOsci, DoubleFractionalDelay, DoubleMultiDelay, DoubleMux, DoubleOctaveRepeatingTabledTuning, DoubleOscillator, DoublePost, DoubleProcessMux, DoubleSaH, DoubleSequencerColumn, DoubleSignalArrayPort, DoubleSignalPort, DoubleSignalSourceChooser, DoubleSignalSourceChooser.OfEnum, DoubleSignalSourceChooser.OfEnumInt, DoubleSignalSourceChooser.OfInt, DoubleStoredSignalSource, DoubleTableOscillator, DoubleUpsamplingSignalSource
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 DoubleSignalSource extends AbstractSignalSource, DoubleSupplier
Interface of a signal (time-dependent value) source of primitive type double.

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:

  • Method Details

    • getAsDouble

      double getAsDouble()
      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:
      getAsDouble in interface DoubleSupplier
      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 double.class.

      Specified by:
      getValueClass in interface CompilableDataFlow
      Returns:
      the type of signal values that this entity produces
      See Also:

    • getConstantAsDouble

      default Optional<Double> getConstantAsDouble()
      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.

    • hasConstantAsDouble

      default boolean hasConstantAsDouble()
      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.getAsDouble().

      Specified by:
      compileDataFlow in interface CompilableDataFlow

    • constant

      static DoubleSignalSource constant(double 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 DoubleSignalSource map(DoubleUnaryOperator 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 getAsDouble() 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:

    • zipWith

      default DoubleSignalSource zipWith(DoubleBinaryOperator op, DoubleSignalSource 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 getAsDouble() 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:

    • guard

      default BooleanSignalSource guard(DoublePredicate 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 getAsDouble() 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:

    • relateWith

      default BooleanSignalSource relateWith(DoubleBiPredicate pred, DoubleSignalSource 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 getAsDouble() 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:

    • clock

      @Undocumented static DoubleClockedSignalSource clock(DoubleSignalSource output, Process... processes)

    • invariant

      @Undocumented default DoubleClockedSignalSource invariant()

    • stored

      default DoubleClockedSignalSource stored()
      Returns a new signal source that stores snapshot values of this signal source driven by a clock.

      The getAsDouble() 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() 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() does nothing.

      Returns:
      a new signal source that takes value snapshots of this signal source.

    • delayed

      default DoubleClockedSignalSource delayed(double 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 DoubleClockedSignalSource delayed(double... 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 DoubleClockedSignalSource delayedFeedback(Function<? super DoubleClockedSignalSource,? extends DoubleSignalSource> loop, double 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 DoubleClockedSignalSource delayedFeedback(Function<? super DoubleClockedSignalSource,? extends DoubleSignalSource> loop, double... 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:

    • choose

      static DoubleSignalSource choose(BooleanSignalSource condition, DoubleSignalSource inTrue, DoubleSignalSource 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.getAsDouble() ? 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

    • asInt

      @Undocumented default IntSignalSource asInt()

    • negate

      default DoubleSignalSource 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.getAsDouble() == -this.getAsDouble() holds.

    • add

      default DoubleSignalSource add(DoubleSignalSource 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).getAsDouble() == this.getAsDouble() + other.getAsDouble() holds.

      Parameters:
      other - the other signal source to consider

    • multiply

      default DoubleSignalSource multiply(DoubleSignalSource 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).getAsDouble() == this.getAsDouble() * other.getAsDouble() holds.

      Parameters:
      other - the other signal source to consider

    • subtract

      default DoubleSignalSource subtract(DoubleSignalSource 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).getAsDouble() == this.getAsDouble() - other.getAsDouble() holds.

      Parameters:
      other - the other signal source to consider

    • divide

      default DoubleSignalSource divide(DoubleSignalSource 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).getAsDouble() == this.getAsDouble() / other.getAsDouble() holds.

      Parameters:
      other - the other signal source to consider

    • modulo

      default DoubleSignalSource modulo(DoubleSignalSource 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).getAsDouble() == this.getAsDouble() % other.getAsDouble() holds.

      Parameters:
      other - the other signal source to consider

    • abs

      default DoubleSignalSource 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().getAsDouble() == Math.abs(this.getAsDouble()) holds.

    • min

      default DoubleSignalSource min(DoubleSignalSource 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).getAsDouble() == Math.min(this.getAsDouble(), other.getAsDouble()) holds.

      Parameters:
      other - the other signal source to consider

    • max

      default DoubleSignalSource max(DoubleSignalSource 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).getAsDouble() == Math.max(this.getAsDouble(), other.getAsDouble()) 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.getAsDouble() > 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.getAsDouble() < 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.getAsDouble() <= 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.getAsDouble() >= 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.getAsDouble() == 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.getAsDouble() != 0 holds.

    • lessThan

      default BooleanSignalSource lessThan(DoubleSignalSource 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.getAsDouble() < other.getAsDouble() holds.

      Parameters:
      other - the other signal source to consider

    • greaterThan

      default BooleanSignalSource greaterThan(DoubleSignalSource 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.getAsDouble() > other.getAsDouble() holds.

      Parameters:
      other - the other signal source to consider

    • lessOrEqual

      default BooleanSignalSource lessOrEqual(DoubleSignalSource 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.getAsDouble() <= other.getAsDouble() holds.

      Parameters:
      other - the other signal source to consider

    • greaterOrEqual

      default BooleanSignalSource greaterOrEqual(DoubleSignalSource 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.getAsDouble() >= other.getAsDouble() holds.

      Parameters:
      other - the other signal source to consider

    • equal

      default BooleanSignalSource equal(DoubleSignalSource 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.getAsDouble() == other.getAsDouble() holds.

      Parameters:
      other - the other signal source to consider

    • nonEqual

      default BooleanSignalSource nonEqual(DoubleSignalSource 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.getAsDouble() != other.getAsDouble() holds.

      Parameters:
      other - the other signal source to consider

    • floor

      @Undocumented default DoubleSignalSource floor()

    • ceil

      @Undocumented default DoubleSignalSource ceil()

    • defined

      default BooleanSignalSource defined()
      Returns a new signal source whose value is true iff the value of this signal source is a valid number.

      At any point in time, this.defined().getAsBoolean() == !Double.isNan(this.getAsDouble()) holds.

    • notANumber

      default BooleanSignalSource notANumber()
      Returns a new signal source whose value is true iff the value of this signal source is not a valid number.

      At any point in time, this.notANumber().getAsBoolean() == Double.isNan(this.getAsDouble()) holds.

    • sqrt

      default DoubleSignalSource sqrt()
      Returns a new signal source whose value is the square root of the value of this signal source.

      At any point in time, this.sqrt().getAsDouble() == (double)Math.sqrt(this.getAsDouble()) holds.

    • series

      default DoubleClockedSignalSource series()
      Returns a signal source whose value at each clock index is the sum of all values of this signal source at all clock indices up to the current one.

      The sum is computed using Kahan's stable algorithm, which requires four additions per iteration.

    • glidingSum

      default DoubleClockedSignalSource glidingSum(int width)
      Returns a signal source whose value at each clock index is the sum of values of this signal source at a fixed number of preceding clock indices, including to the current one.

      The sum is computed using Kahan's stable algorithm, which requires five additions per iteration.

      Parameters:
      width - the number of clock cycles to sum over
      Throws:
      NegativeArraySizeException - if width <= 0

    • glidingAverage

      default DoubleClockedSignalSource glidingAverage(int width)
      Returns a signal source whose value at each clock index is the average of values of this signal source at a fixed number of preceding clock indices, including to the current one.

      The average is computed using Kahan's stable algorithm, which requires five additions and one division per iteration.

      Parameters:
      width - the number of clock cycles to average over
      Throws:
      NegativeArraySizeException - if width <= 0

    • glidingVariance

      default DoubleClockedSignalSource glidingVariance(int width)
      Returns a signal source whose value at each clock index is the variance of values of this signal source at a fixed number of preceding clock indices, including to the current one.
      Parameters:
      width - the number of clock cycles to compute over
      Throws:
      NegativeArraySizeException - if width <= 0

    • glidingStandardDeviation

      default DoubleClockedSignalSource glidingStandardDeviation(int width)
      Returns a signal source whose value at each clock index is the standard deviation of values of this signal source at a fixed number of preceding clock indices, including to the current one.
      Parameters:
      width - the number of clock cycles to compute over
      Throws:
      NegativeArraySizeException - if width <= 0

    • zeroCrossing

      default BooleanClockedSignalSource zeroCrossing()
      Returns a signal source whose value at each clock index is true if the current value of this signal source has changed sign compared to its value at the preceding clock index.

      Corner cases, namly initial values, positive and negative zero, and NaNs, are handled robustly; they are not counted as sign changes.

    • selectAffine

      @Deprecated default DoubleSignalSource selectAffine(DoubleSignalSource onOne, DoubleSignalSource onZero)
      Deprecated.
      FIXME
      Returns a new signal source whose value is the affine combination of the simultaneous values of two signal sources.

      At any point in time, selectAffine(s, a, b).getAsDouble() == s.getAsDouble() * a.getAsDouble() + (1 - s.getAsDouble()) * b.getAsDouble() holds.

    • choose

      static <E extends Enum<E>> DoubleSignalSource choose(SignalSource<E> selector, EnumMap<E,? extends DoubleSignalSource> 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).getAsDouble() == m.get(s.get()).getAsDouble() 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>> DoubleSignalSource choose(EnumSignalSource<E> selector, EnumMap<E,? extends DoubleSignalSource> 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).getAsDouble() == m.get(E.values()[s.getAsInt()]).getAsDouble() 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>> DoubleSignalSource choose(EnumSignalSource<E> selector, DoubleSignalSource... 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).getAsDouble() == m[s.getAsInt()].getAsDouble() 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 DoubleClockedSignalSource sampleAndHold(BooleanSignalSource hold, double 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 is 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 DoubleClockedSignalSource power(BinaryOperator<DoubleSignalSource> op, long n)

    • compileMainSignalSource

      @Undocumented default void compileMainSignalSource(CompilationContext context)

    • publishStoredValueVariable

      @Undocumented default void publishStoredValueVariable(CompilationContext context)

    • fromArray

      static DoubleSignalSource fromArray(double[] data, IntSignalSource index)
      Returns a new signal source whose value is an element of a given array, whose index is determined by a given signal source. At execution time, the value of the index signal source must be a valid index in the array, or an exception occurs. (This implies that using an empty array as backing store results in a signal source that cannot be executed.)
      Parameters:
      data - the array to read from
      index - the signal source that determines the index

    • fromArrayCyclic

      static DoubleSignalSource fromArrayCyclic(double[] data, IntSignalSource index)
      Returns a new signal source whose value is an element of a given array, whose index is determined by a given signal source. The value of the index signal source is normalized cyclically (modulo the array length) to a valid index.
      Parameters:
      data - the array to read from
      index - the signal source that determines the index

    • DEBUG

      @Undocumented default Process DEBUG(String format)

    • asFloat

      default FloatSignalSource asFloat()

    • asDouble

      default DoubleSignalSource asDouble()