Module: Musa::All

Includes:
Chords, Clock, Darwin, Datasets, Logger, MIDIRecorder, MIDIVoices, Markov, MusicXML, Neumalang, Neumas, REPL, Scales, Sequencer, Series, Transcription, Transcriptors, Transport, Variatio
Defined in:
lib/musa-dsl.rb

Overview

Convenience module that includes all Musa DSL components in a single namespace.

This module provides a convenient way to include all Musa DSL functionality into your code with a single include Musa::All statement, rather than including each component individually.

Included Components

Core Functionality

  • Logger - Logging utilities
  • Clock - Timing and clock management
  • Transport - Transport control (play, stop, tempo)
  • Sequencer - Event sequencing and scheduling
  • Series - Series operations and transformations
  • Datasets - Musical dataset management
  • REPL - Read-Eval-Print Loop for live coding

Notation and Language

Musical Theory

  • Scales - Scale definitions and operations
  • Chords - Chord construction and manipulation

Data Structures

  • Matrix - Matrix operations for musical data

Generative Algorithms

  • Darwin - Evolutionary/genetic algorithms
  • Markov - Markov chain generation
  • Variatio - Combinatorial variation generator

Input/Output

Usage

Examples:

Include all Musa DSL components

require 'musa-dsl'
include Musa::All

# Now you have access to all Musa DSL methods and classes. S() is a
# constructor method, not a class.
pitches = S(60, 62, 64, 65)
pitches.i.to_a  # => [60, 62, 64, 65]

sequencer = Sequencer.new(4, 24)  # 4 beats per bar, 24 ticks per beat
scale = Scales.et12[440.0].major[60]
scale.tonic.pitch  # => 60

Selective inclusion (alternative)

# Instead of Musa::All, you can include only what you need:
include Musa::Series
include Musa::Sequencer

Instance Method Summary collapse

Instance Method Details

#A(*series) ⇒ FromArrayOfSeries Originally defined in module Series::Constructors

Creates array-mode serie from array of series.

Combines multiple series into array-structured values. Returns array of values from respective series. Stops when first serie exhausts.

Examples:

Array of series

a = A(S(1, 2, 3), S(10, 20, 30))
inst = a.i
inst.next_value  # => [1, 10]
inst.next_value  # => [2, 20]

Parameters:

  • series (Array) —

    array of series

Returns:

  • (FromArrayOfSeries) —

    combined array serie

#AC(*series) ⇒ FromArrayOfSeries Originally defined in module Series::Constructors

Creates array-mode combined serie from array of series.

Like A but cycles all series. When a serie exhausts, it restarts from the beginning, continuing until all series complete their cycles.

Examples:

Combined cycling all series

ac = AC(S(1, 2), S(10, 20, 30))
ac.max_size(6).i.to_a  # => [[1, 10], [2, 20], [1, 30],
                        #     [2, 10], [1, 20], [2, 30]]

Parameters:

  • series (Array) —

    array of series

Returns:

  • (FromArrayOfSeries) —

    combined array serie that cycles all series

#E(*value_args, **key_args) {|value_args, last_value, caller, key_args| ... } ⇒ FromEvalBlockWithParameters Originally defined in module Series::Constructors

Creates serie from evaluation block.

Calls block repeatedly with parameters and last_value. Block returns next value or nil to stop. Enables stateful generators and algorithms.

Block Parameters

  • value_args: Initial positional parameters
  • last_value: Previous return value (nil on first call)
  • caller: Serie instance (access to parameters attribute)
  • key_args: Initial keyword parameters

Examples:

Counter

# last_value is nil on the first call -- the positional arguments are
# the serie's parameters, handed to every call, not a seed value.
counter = E { |last_value:| (last_value || 0) + 1 unless last_value == 5 }
counter.i.to_a  # => [1, 2, 3, 4, 5]

Fibonacci

fib = E { |last_value:, caller:|
  a, b = caller.parameters
  caller.parameters = [b, a + b]
  a
}
fib.parameters = [0, 1]
fib.i.max_size(10).to_a  # => [0, 1, 1, 2, 3, 5, 8, 13, 21, 34]

Parameters:

  • value_args (Array) —

    initial positional parameters

  • key_args (Hash) —

    initial keyword parameters

Yields:

  • block called for each value

Yield Parameters:

  • value_args (Array) —

    current positional parameters

  • last_value (Object, nil) —

    previous return value

  • caller (FromEvalBlockWithParameters) —

    serie instance

  • key_args (Hash) —

    current keyword parameters

Yield Returns:

  • (Object, nil) —

    next value or nil to stop

Returns:

  • (FromEvalBlockWithParameters) —

    evaluation-based serie

#FIBO(first = 1, second = 1) ⇒ Fibonacci Originally defined in module Series::Constructors

Creates a Fibonacci serie: every value is the sum of the two before it.

The two seeds ARE the first two values, so FIBO() yields 1, 1, 2, 3, 5... and any other pair gives a different sequence out of the same machine — not a delayed echo of Fibonacci, a relative of it. Infinite serie.

Examples:

Fibonacci numbers

fib = FIBO()
fib.infinite?  # => true
inst = fib.i
10.times.map { inst.next_value }
# => [1, 1, 2, 3, 5, 8, 13, 21, 34, 55]

Seeded: the sequence including its leading zero

inst = FIBO(0, 1).i
6.times.map { inst.next_value }
# => [0, 1, 1, 2, 3, 5]

Seeded: Fibonacci with its first term removed

inst = FIBO(1, 2).i
6.times.map { inst.next_value }
# => [1, 2, 3, 5, 8, 13]

Lucas numbers

inst = FIBO(2, 1).i
6.times.map { inst.next_value }
# => [2, 1, 3, 4, 7, 11]

Rhythmic proportions

durations = FIBO().i.map { |n| Rational(n, 16) }

A grid position that Fibonacci lands on, turn after turn

positions = FIBO().i.map { |n| n % 32 }

Parameters:

  • first (Numeric) (defaults to: 1) —

    the first value (default 1)

  • second (Numeric) (defaults to: 1) —

    the second value (default 1)

Returns:

  • (Fibonacci) —

    Fibonacci sequence serie

#FOR(from: nil, to: nil, step: nil) ⇒ ForLoop Originally defined in module Series::Constructors

Creates for-loop style numeric sequence.

Generates sequence from from to to (inclusive) with step increment. Automatically adjusts step sign based on from/to relationship.

Examples:

Ascending sequence

s = FOR(from: 0, to: 10, step: 2)
s.i.to_a  # => [0, 2, 4, 6, 8, 10]

Descending sequence

s = FOR(from: 10, to: 0, step: 2)
s.i.to_a  # => [10, 8, 6, 4, 2, 0]

Infinite sequence

s = FOR(from: 0, step: 1)  # to: nil
s.infinite?  # => true

Parameters:

  • from (Numeric, nil) (defaults to: nil) —

    starting value (default: 0)

  • to (Numeric, nil) (defaults to: nil) —

    ending value (nil for infinite)

  • step (Numeric, nil) (defaults to: nil) —

    increment (default: 1, sign auto-adjusted)

Returns:

  • (ForLoop) —

    numeric sequence serie

#H(**series_hash) ⇒ FromHashOfSeries Originally defined in module Series::Constructors

Note:

h.i builds a NEW instance every time it is called, each starting from the beginning. Keep the instance to advance through the serie.

Creates hash-mode serie from hash of series.

Combines multiple series into hash-structured values. Returns hash with same keys, values from respective series. Stops when first serie exhausts.

Examples:

Hash of series

h = H(pitch: S(60, 64, 67), velocity: S(96, 80, 64))
inst = h.i
inst.next_value  # => {pitch: 60, velocity: 96}
inst.next_value  # => {pitch: 64, velocity: 80}

Parameters:

  • series_hash (Hash) —

    hash of series (key => serie)

Returns:

  • (FromHashOfSeries) —

    combined hash serie

#HARMO(error: nil, extended: nil) ⇒ HarmonicNotes Originally defined in module Series::Constructors

Creates a serie of the harmonic series, in semitones over the fundamental.

Yields the interval of each harmonic from a fundamental of 0, approximated to the nearest semitone, and skips any harmonic whose approximation error exceeds the tolerance. Infinite serie; add the fundamental's own pitch to place it. The values do not depend on any input: it starts producing at once.

Parameters

  • error: maximum approximation error, IN SEMITONES, for a harmonic to be accepted (default: 0.5, i.e. accept every harmonic, since no approximation to the nearest semitone can be off by more than half of one)
  • extended: yield { pitch:, error: } instead of the bare pitch, so the approximation error of each harmonic is available. It does NOT add harmonics: the pitches are the same ones.

Examples:

Harmonic series

harmonics = HARMO(error: 0.5)
inst = harmonics.i
8.times.map { inst.next_value }
# => [0, 12, 19, 24, 28, 31, 34, 36]

A tighter tolerance drops the harmonics that fall between semitones

inst = HARMO(error: 0.1).i
8.times.map { inst.next_value }
# => [0, 12, 19, 24, 31, 36, 38, 43]
# the 5th harmonic (28) is 0.137 semitones off, so it is not accepted

Extended: the same pitches, carrying their error

inst = HARMO(error: 0.5, extended: true).i
3.times.map { inst.next_value }
# => [{ pitch: 0, error: 0.0 },
#     { pitch: 12, error: 0.0 },
#     { pitch: 19, error: 0.0195... }]

Over a fundamental other than C

over_g = HARMO().i.map { |n| n + 67 }

Parameters:

  • error (Numeric, nil) (defaults to: nil) —

    maximum approximation error in semitones (default: 0.5)

  • extended (Boolean, nil) (defaults to: nil) —

    yield pitch and error instead of pitch (default: false)

Returns:

  • (HarmonicNotes) —

    harmonic series serie

#HC(**series_hash) ⇒ FromHashOfSeries Originally defined in module Series::Constructors

Creates hash-mode combined serie from hash of series.

Like H but cycles all series. When a serie exhausts, it restarts from the beginning, continuing until all series complete their cycles.

Examples:

Combined cycling all series

hc = HC(a: S(1, 2), b: S(10, 20, 30))
hc.max_size(6).i.to_a  # => [{a:1, b:10}, {a:2, b:20}, {a:1, b:30},
                        #     {a:2, b:10}, {a:1, b:20}, {a:2, b:30}]

Parameters:

  • series_hash (Hash) —

    hash of series (key => serie)

Returns:

  • (FromHashOfSeries) —

    combined hash serie that cycles all series

#MERGE(*series) ⇒ Sequence Originally defined in module Series::Constructors

Merges multiple series sequentially.

Plays series in sequence: first serie until exhausted, then second, etc. Restarts each serie (except first) before playing.

Examples:

Merge sequences

merged = MERGE(S(1, 2, 3), S(10, 20, 30))
merged.i.to_a  # => [1, 2, 3, 10, 20, 30]

Melodic phrases

phrase1 = S(60, 64, 67)
phrase2 = S(72, 69, 65)
melody = MERGE(phrase1, phrase2)

Parameters:

  • series (Array<Serie>) —

    series to merge sequentially

Returns:

  • (Sequence) —

    sequential merge serie

#NIL ⇒ NilSerie Originally defined in module Series::Constructors

Creates serie that always returns nil.

Returns nil on every next_value call. Useful for padding or as placeholder in composite structures.

Examples:

Nil serie

s = NIL().i
s.next_value  # => nil
s.next_value  # => nil

Returns:

  • (NilSerie) —

    serie returning nil

#PROXY(serie = nil, cyclic: nil) ⇒ ProxySerie Originally defined in module Series::Constructors

Creates a proxy serie with optional initial source.

Proxy series enable late binding - creating a serie placeholder that will be resolved later. Useful for:

Use Cases

  • Forward references: Reference series before definition
  • Circular structures: Self-referential or mutually referential series
  • Dependency injection: Define structure, inject source later
  • Dynamic routing: Change source serie at runtime

Method Delegation

Proxy delegates all methods to underlying source via method_missing, making it transparent proxy for most operations.

State Resolution

Proxy starts in :undefined state, becomes :prototype/:instance when source is set and resolved.

Cycles

A proxy that points back into the serie it is part of closes a cycle: the material loops instead of ending. This has to be declared with cyclic: true, because a cycle changes what every walk of the graph has to do and should not appear by accident -- a proxy that closes one without having been declared raises ArgumentError. The reverse is fine: declaring a proxy cyclic and pointing it somewhere that does not loop back is exactly the forward reference the declaration exists for.

What a cycle is for is material whose repetition is not decided in advance: a QUEUE fed while the loop is already sounding, an E() reading state that changes between turns. For a serie that is fully known beforehand, .repeat says the same thing without any of this.

Examples:

Forward reference

proxy = PROXY()
proxy.undefined?  # => true

# Define later
proxy.proxy_source = S(1, 2, 3)
proxy.prototype?  # => true

Circular structure

loop_serie = PROXY(cyclic: true)
sequence = S(1, 2, 3).after(loop_serie)
loop_serie.proxy_source = sequence

# The circle closes, and the state of a cycle is the state of what feeds
# it from outside -- here S(1, 2, 3), a prototype.
sequence.state    # => :prototype
loop_serie.state  # => :prototype

# It never runs out, and says so without walking round itself.
sequence.infinite?  # => true

i = sequence.i
9.times.collect { i.next_value }  # => [1, 2, 3, 1, 2, 3, 1, 2, 3]

Two materials calling each other

to_b = PROXY(cyclic: true)
to_a = PROXY(cyclic: true)

a = S(1, 2).after(to_b)
b = S(3, 4).after(to_a)

to_b.proxy_source = b
to_a.proxy_source = a

i = a.i
8.times.collect { i.next_value }  # => [1, 2, 3, 4, 1, 2, 3, 4]

A cycle that comes back empty ends

n = 0
material = E(nil) { n += 1; n <= 3 ? n : nil }

back = PROXY(cyclic: true)
cycle = material.after(back)
back.proxy_source = cycle

# One turn per request: when the turn produces nothing, the loop is over
# instead of spinning forever.
i = cycle.i
5.times.collect { i.next_value }  # => [1, 2, 3, nil, nil]

With initial source

proxy = PROXY(S(1, 2, 3))

Parameters:

  • serie (Serie, nil) (defaults to: nil) —

    initial source serie (default: nil)

  • cyclic (Boolean, nil) (defaults to: nil) —

    whether this proxy may close a cycle

Returns:

#QUANTIZE(time_value_serie, reference: nil, step: nil, value_attribute: nil, stops: nil, predictive: nil, left_open: nil, right_open: nil) ⇒ RawQuantizer, PredictiveQuantizer Originally defined in module Series::Constructors

Quantizes time-value serie to discrete steps.

Parameters:

  • time_value_serie (Serie) —

    source timed serie

  • reference (Numeric, nil) (defaults to: nil) —

    quantization reference

  • step (Numeric, nil) (defaults to: nil) —

    step size

  • value_attribute (Symbol, nil) (defaults to: nil) —

    attribute to quantize

  • stops (Boolean, nil) (defaults to: nil) —

    include stop points

  • predictive (Boolean, nil) (defaults to: nil) —

    use predictive mode

  • left_open (Boolean, nil) (defaults to: nil) —

    left boundary open

  • right_open (Boolean, nil) (defaults to: nil) —

    right boundary open

Returns:

  • (RawQuantizer, PredictiveQuantizer) —

    quantized serie

#QUEUE(*series) ⇒ QueueSerie Originally defined in module Series::Constructors

Note:

to_a RESTARTS the instance, so it returns everything queued and not what is left after the next_value above.

Creates queue serie from initial series.

Queue allows adding series dynamically during playback, creating flexible sequential playback with runtime modification.

Features

  • Dynamic addition: Add series with << during playback
  • Sequential playback: Plays series in queue order
  • Method delegation: Delegates methods to current serie
  • Clear: Can clear queue and reset

Use Cases

  • Interactive sequencing with user input
  • Dynamic phrase assembly
  • Playlist-style serie management
  • Reactive composition systems
  • Live coding pattern queuing

Examples:

Basic queue

queue = QUEUE(S(1, 2, 3)).i
queue.next_value  # => 1
queue << S(4, 5, 6).i  # Add dynamically
queue.to_a  # => [1, 2, 3, 4, 5, 6]

Dynamic playlist

melody1 = S(60, 62)
melody2 = S(67, 69)

queue = QUEUE(melody1).i
queue << melody2.i
queue.to_a  # => [60, 62, 67, 69]

A queue that starts with nothing

queue = QUEUE().i
queue.next_value  # => nil

queue << S(1, 2).i
queue.next_value  # => 1
queue.next_value  # => 2

Parameters:

  • series (Array<Serie>) —

    initial series in queue

Returns:

#RND(*_values, values: nil, from: nil, to: nil, step: nil, random: nil) ⇒ RandomValuesFromArray, RandomNumbersFromRange Originally defined in module Series::Constructors

Creates random value serie from array or range.

Two modes:

  • Array mode: Random values from provided array
  • Range mode: Random numbers from range (from, to, step)

A SHUFFLE, NOT A DIE. Each value is drawn once and removed, so the serie is a random permutation and then ends: six values from RND(1..6) and nil on the seventh. .repeat is what gives sampling with replacement, reshuffling on each pass, and that one is infinite.

Examples:

Shuffling an array

shuffled = RND(1, 2, 3, 4, 5, 6, random: 42)
shuffled.i.to_a       # => [4, 6, 3, 5, 2, 1]
shuffled.infinite?    # => false

Rolling a die -- with replacement, which needs repeat

die = RND(1, 2, 3, 4, 5, 6, random: 42).repeat
die.infinite?  # => true

Random from range

RND(from: 0, to: 10, step: 5, random: 7).i.to_a  # => [0, 10, 5]

With seed

# The same seed is the same sequence, which is what makes a piece the
# same piece.
RND(1, 2, 3, random: 42).i.to_a  # => [3, 2, 1]
RND(1, 2, 3, random: 42).i.to_a  # => [3, 2, 1]

Parameters:

  • _values (Array) —

    values to choose from (positional)

  • values (Array, nil) (defaults to: nil) —

    values to choose from (named)

  • from (Numeric, nil) (defaults to: nil) —

    range start (range mode)

  • to (Numeric, nil) (defaults to: nil) —

    range end (range mode, required)

  • step (Numeric, nil) (defaults to: nil) —

    range step (default: 1)

  • random (Random, Integer, nil) (defaults to: nil) —

    Random instance or seed

Returns:

  • (RandomValuesFromArray, RandomNumbersFromRange) —

    random serie

Raises:

  • (ArgumentError) —

    if using both positional and named values

  • (ArgumentError) —

    if mixing array and range parameters

#RND1(*_values, values: nil, from: nil, to: nil, step: nil, random: nil) ⇒ RandomValueFromArray, RandomNumberFromRange Originally defined in module Series::Constructors

Creates single random value serie from array or range.

Like RND but returns only one random value then exhausts. Two modes: array mode and range mode.

Examples:

Single random value

rnd = RND1(1, 2, 3, 4, 5)
rnd.i.next_value  # => random 1-5
rnd.i.next_value  # => nil (exhausted)

Random seed selection

seed = RND1(10, 20, 30, random: 42)

Parameters:

  • _values (Array) —

    values to choose from (positional)

  • values (Array, nil) (defaults to: nil) —

    values to choose from (named)

  • from (Numeric, nil) (defaults to: nil) —

    range start (range mode)

  • to (Numeric, nil) (defaults to: nil) —

    range end (range mode, required)

  • step (Numeric, nil) (defaults to: nil) —

    range step (default: 1)

  • random (Random, Integer, nil) (defaults to: nil) —

    Random instance or seed

Returns:

  • (RandomValueFromArray, RandomNumberFromRange) —

    single random value serie

Raises:

  • (ArgumentError) —

    if using both positional and named values

  • (ArgumentError) —

    if mixing array and range parameters

#S(*values) ⇒ FromArray Originally defined in module Series::Constructors

Creates serie from array of values.

Most common constructor. Values can include ranges which will be expanded automatically via ExplodeRanges extension.

Examples:

Basic array

notes = S(60, 64, 67, 72)
notes.i.to_a  # => [60, 64, 67, 72]

With ranges

scale = S(60..67)
scale.i.to_a  # => [60, 61, 62, 63, 64, 65, 66, 67]

Parameters:

  • values (Array) —

    values to iterate (supports ranges)

Returns:

#SIN(start_value: nil, steps: nil, amplitude: nil, center: nil) ⇒ SinFunction Originally defined in module Series::Constructors

Creates sine wave function serie.

Generates values following sine curve. Useful for smooth oscillations, LFO-style modulation, and periodic variations.

Wave Parameters

  • start_value: Initial value (default: center)
  • steps: Period in steps (nil for continuous)
  • amplitude: Wave amplitude (default: 1.0)
  • center: Center/offset value (default: 0.0)

Wave equation: center + amplitude * sin(progress)

Examples:

Basic sine wave

wave = SIN(steps: 8, amplitude: 10, center: 50)
wave.i.to_a  # => oscillates around 50 ± 10

LFO modulation

lfo = SIN(steps: 16, amplitude: 0.5, center: 0.5)
# Use for amplitude modulation

Parameters:

  • start_value (Numeric, nil) (defaults to: nil) —

    initial value

  • steps (Numeric, nil) (defaults to: nil) —

    full period in steps

  • amplitude (Numeric, nil) (defaults to: nil) —

    wave amplitude (default: 1.0)

  • center (Numeric, nil) (defaults to: nil) —

    center offset (default: 0.0)

Returns:

  • (SinFunction) —

    sine wave serie

#TIMED_UNION(*array_of_timed_series, **hash_of_timed_series) ⇒ TimedUnionOfArrayOfTimedSeries, TimedUnionOfHashOfTimedSeries Originally defined in module Series::Constructors

Merges multiple timed series by synchronizing events at each time point.

TIMED_UNION combines series with :time attributes, emitting events at each unique time where at least one source has a value. Sources without values at a given time emit nil. Operates in two distinct modes based on input format.

Timed Series Format

Each event is a hash with :time and :value keys, extended with AbsTimed:

{ time: 0r, value: 60, duration: 1r }.extend(Musa::Datasets::AbsTimed)

Additional attributes (:duration, :velocity, etc.) are preserved and synchronized alongside values.

Operating Modes

Array Mode: TIMED_UNION(s1, s2, s3)

  • Anonymous positional sources
  • Output: { time: t, value: [val1, val2, val3] }
  • Use for: Ordered tracks without specific names

Hash Mode: TIMED_UNION(melody: s1, bass: s2)

  • Named sources with keys
  • Output: { time: t, value: { melody: val1, bass: val2 } }
  • Use for: Identified voices/tracks for routing

Value Types and Combination

Direct values (integers, strings, etc.):

s1 = S({ time: 0, value: 60 })
s2 = S({ time: 0, value: 64 })
TIMED_UNION(s1, s2)  # => { time: 0, value: [60, 64] }

Hash values (polyphonic events):

s1 = S({ time: 0, value: { a: 1, b: 2 } })
s2 = S({ time: 0, value: { c: 10 } })
TIMED_UNION(s1, s2)  # => { time: 0, value: { a: 1, b: 2, c: 10 } }

Array values (multi-element events):

s1 = S({ time: 0, value: [1, 2] })
s2 = S({ time: 0, value: [10, 20] })
TIMED_UNION(s1, s2)  # => { time: 0, value: [1, 2, 10, 20] }

Mixed Hash + Direct (advanced):

s1 = S({ time: 0, value: { a: 1, b: 2 } })
s2 = S({ time: 0, value: 100 })
TIMED_UNION(s1, s2)  # => { time: 0, value: { a: 1, b: 2, 0 => 100 } }

Synchronization Behavior

Events are emitted at each unique time point across all sources:

s1 = S({ time: 0r, value: 1 }, { time: 2r, value: 3 })
s2 = S({ time: 1r, value: 10 })
TIMED_UNION(s1, s2).i.to_a
# => [{ time: 0r, value: [1, nil] },
#     { time: 1r, value: [nil, 10] },
#     { time: 2r, value: [3, nil] }]

Extra Attributes

Non-standard attributes (beyond :time, :value) are synchronized:

s1 = S({ time: 0, value: 1, velocity: 80 })
s2 = S({ time: 0, value: 10, duration: 1r })
TIMED_UNION(s1, s2)
# => { time: 0, value: [1, 10], velocity: [80, nil], duration: [nil, 1r] }

Examples:

Array mode with direct values

s1 = S({ time: 0r, value: 1 }, { time: 1r, value: 2 })
s2 = S({ time: 0r, value: 10 }, { time: 2r, value: 20 })

union = TIMED_UNION(s1, s2).i
union.to_a
# => [{ time: 0r, value: [1, 10] },
#     { time: 1r, value: [2, nil] },
#     { time: 2r, value: [nil, 20] }]

Hash mode with named sources

melody = S({ time: 0r, value: 60 }, { time: 1r, value: 64 })
bass = S({ time: 0r, value: 36 }, { time: 2r, value: 40 })

union = TIMED_UNION(melody: melody, bass: bass).i
union.to_a
# => [{ time: 0r, value: { melody: 60, bass: 36 } },
#     { time: 1r, value: { melody: 64, bass: nil } },
#     { time: 2r, value: { melody: nil, bass: 40 } }]

Hash values with polyphonic events

s1 = S({ time: 0r, value: { a: 1, b: 2 } })
s2 = S({ time: 0r, value: { c: 10, d: 20 } })

union = TIMED_UNION(s1, s2).i
union.next_value  # => { time: 0r, value: { a: 1, b: 2, c: 10, d: 20 } }

Extra attributes synchronization

s1 = S({ time: 0r, value: 1, velocity: 80, duration: 1r })
s2 = S({ time: 0r, value: 10, velocity: 90 })

union = TIMED_UNION(s1, s2).i
union.next_value
# => { time: 0r,
#      value: [1, 10],
#      velocity: [80, 90],
#      duration: [1r, nil] }

Key conflict detection

s1 = S({ time: 0r, value: { a: 1, b: 2 } })
s2 = S({ time: 0r, value: { a: 10 } })  # 'a' already used!

union = TIMED_UNION(s1, s2).i
union.next_value  # => RuntimeError: Value: key a already used

Parameters:

  • array_of_timed_series (Array<Serie>) —

    timed series (array mode)

  • hash_of_timed_series (Hash{Symbol => Serie}) —

    named timed series (hash mode)

Returns:

  • (TimedUnionOfArrayOfTimedSeries, TimedUnionOfHashOfTimedSeries) —

    merged serie

Raises:

  • (ArgumentError) —

    if mixing array and hash modes

  • (RuntimeError) —

    if hash values have duplicate keys across sources

  • (RuntimeError) —

    if mixing incompatible value types (Hash with Array)

See Also:

  • Splits compound values into individual timed events
  • Removes events with all-nil values
  • Instance method for union

#UNDEFINED ⇒ UndefinedSerie Originally defined in module Series::Constructors

Creates undefined serie.

Returns serie in undefined state. Useful as placeholder that will be resolved later (e.g., in PROXY).

Examples:

Undefined placeholder

proxy = PROXY()  # Uses UNDEFINED internally
proxy.undefined?  # => true

Returns: