engine/io.github.moonlightsuite.moonlight.online.signal/TimeChain

TimeChain

public class TimeChain<T extends Comparable<T>, V> implements Iterable<T>

A segment chain is similar to a LinkedList, providing some specific features for Samples, like checking temporal integrity constraints, a custom iterator etc.

Let old and new denote the state of this before and after some mutating operations. Two data integrity constraints must hold on the data structure:

Monotonicity invariant: forall element: current.getStart() < next.getStart() && current.getStart() > prev.getStart()
Ending condition invariant: end > getLast().getStart() && old.end <= new.end

TODO: they should be enforced by mutators and trivially satisfied at the beginning, i.e. with no segments

See also

Constructors

public void TimeChain(@NotNull() @NotNull() T end)

It defines a chain of time segments that ends at some time instant

public void TimeChain(@NotNull() @NotNull() Sample<T, V> element, @NotNull() @NotNull() T end)

It defines a chain of time segments that ends at some time instant

public void TimeChain(@NotNull() @NotNull() List<Sample<T, V>> segments, @NotNull() @NotNull() T end)

WARNING: this interface assumes the programmer is taking responsibility about the Monotonicity of the ordered list of segments.

Properties

public final T end

Last time instant of definition of the chain

Functions

public boolean add(Sample<T, V> e)

Adds a segment to the TimeChain.

public ChainIterator<Sample<T, V>> chainIterator()

public ChainIterator<Sample<T, V>> chainIterator(int index)

public void clear()

public TimeChain<T, V> copy()

Shallow copy of the chain

public boolean equals(Object o)

public void forEach(Consumer<? super Sample<T, V>> action)

public Sample<T, V> get(int index)

public T getEnd()

public Sample<T, V> getFirst()

public Sample<T, V> getLast()

Returns the last element of the chain

public T getStart()

public int hashCode()

public boolean isEmpty()

@NotNull()

public @NotNull() Iterator<Sample<T, V>> iterator()

public int size()

public Spliterator<Sample<T, V>> spliterator()

public Stream<Sample<T, V>> stream()

public TimeChain<T, V> subChain(int from, int to, T end)

Generates a sub-chain of the current chain.

public List<Sample<T, V>> toList()

public String toString()

public List<Update<T, V>> toUpdates()