BooleanSignalSourceVector (BandM signal & music)

All Superinterfaces:

Collection<S>, Iterable<S>, List<S>

All Known Subinterfaces:

BooleanClockedSignalSourceVector, BooleanSignalSourceVector.Mutable<S>

All Known Implementing Classes:

BooleanDelayVector
```
public interface BooleanSignalSourceVector<S extends BooleanSignalSource>
extends List<S>
```
Interface of aggregates of signal sources of primitive type boolean.
This interface is intended for grouping signal sources and routing parallel data flow at contruction time of a network. Objects that implement this interface should not themselves contribute to realtime behavior.

See Also:

PrimitiveBooleanSignalSourceVector, BooleanSignalSource

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`BooleanSignalSourceVector.Mutable<S extends BooleanSignalSource>` Interface of mutable aggregates of signal sources of primitive type `boolean`.

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default BooleanSignalSourceVector<S>`	`append(BooleanSignalSourceVector<S> other)` Returns a new aggregate that combines the components of this and the given other aggregate in order.
`static <S extends BooleanSignalSource> BooleanSignalSourceVector<S>`	`empty()` Creates a new aggregate with zero components.
`static <S extends BooleanSignalSource> BooleanSignalSourceVector<S>`	`iterate(int size, Supplier<? extends S> producer)` Creates a new aggregate with a given number components obtained from a producer.
`default BooleanSignalSourceVector<BooleanSignalSource>`	`map(BooleanUnaryOperator op)` Returns a new aggregate that is obtained by uniformly transforming the values of the corresponding components of this aggregate.
`static <S extends BooleanSignalSource> BooleanSignalSourceVector.Mutable<S>`	`of(int size)` Creates a mutable aggregate of the given size.
`static <S extends BooleanSignalSource> BooleanSignalSourceVector<S>`	`of(int size, IntFunction<? extends S> components)` Creates a new aggregate from the given component-valued function.
`static <S extends BooleanSignalSource> BooleanSignalSourceVector<S>`	`of(List<? extends S> components)` Creates a new aggregate from the given list of components.
`static <S extends BooleanSignalSource> BooleanSignalSourceVector<S>`	`of(S... components)` Creates a new aggregate from the given array of components.
`static <S extends BooleanSignalSource> BooleanSignalSourceVector<S>`	`repeat(int size, S source)` Creates a new aggregate with a given number of identical references to the same given signal source.
`static <S extends BooleanSignalSource> BooleanSignalSourceVector<S>`	`singleton(S source)` Creates a new aggregate with one component.
`default int`	`sizeCompatibleWith(int expected)` Returns the number of components of this aggregate if equal to the expected value.
`default int`	`sizeCompatibleWith(List<?> expected)`
`default int`	`sizeCompatibleWith(Object... expected)`
`default BooleanClockedSignalSourceVector`	`stored()` Returns a new aggegate whose components take snapshots of the corresponding components of this aggregate.
`default BooleanSignalSourceVector<BooleanSignalSource>`	`zipWith(BooleanBinaryOperator op, BooleanSignalSourceVector<?> other)` Returns a new aggregate that is obtained by uniformly combining the values of the corresponding components of this and another aggregate.

Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - sizeCompatibleWith
```
@Undocumented
default int sizeCompatibleWith(List<?> expected)
```
  - sizeCompatibleWith
```
@Undocumented
default int sizeCompatibleWith(Object... expected)
```
  - sizeCompatibleWith
```
default int sizeCompatibleWith(int expected)
```
    Returns the number of components of this aggregate if equal to the expected value.
    
    Parameters:
    
    expected - the expected number of components
    
    Returns:
    
    the number of elements of this aggregate
    
    Throws:
    
    IllegalArgumentException - if the number of components of this aggregate is not equal to the expected number
  - of
```
@SafeVarargs
static <S extends BooleanSignalSource> BooleanSignalSourceVector<S> of(S... components)
```
    Creates a new aggregate from the given array of components.
    The resulting object is a view of the passed array; concurrent mutation of array elements is observed. For immutable aggregates, no reference to the array should be shared.
    
    Parameters:
    
    components - the components
    
    Throws:
    
    NullPointerException - if components == null
  - of
```
static <S extends BooleanSignalSource> BooleanSignalSourceVector<S> of(List<? extends S> components)
```
    Creates a new aggregate from the given list of components.
    The specified list is copied internally; later mutations of the original are not reflected.
    
    Parameters:
    
    components - the components
    
    Throws:
    
    NullPointerException - if components == null
  - of
```
static <S extends BooleanSignalSource> BooleanSignalSourceVector.Mutable<S> of(int size)
```
    Creates a mutable aggregate of the given size. All components are initialized with null and must be set before use.
    
    Parameters:
    
    size - the number of components of the new aggregate
  - of
```
static <S extends BooleanSignalSource> BooleanSignalSourceVector<S> of(int size,
                                                                       IntFunction<? extends S> components)
```
    Creates a new aggregate from the given component-valued function.
    The given function is evaluated for all valid indices, from 0 to size-1, in unspecified order.
    
    Parameters:
    
    components - the component function
    
    Throws:
    
    NullPointerException - if components == null
  - repeat
```
static <S extends BooleanSignalSource> BooleanSignalSourceVector<S> repeat(int size,
                                                                           S source)
```
    Creates a new aggregate with a given number of identical references to the same given signal source.
    
    Parameters:
    
    size - the number of elements of the new aggregate
    
    source - the signal source to use as component
    
    Throws:
    
    IllegalArgumentException - if size < 0
  - iterate
```
static <S extends BooleanSignalSource> BooleanSignalSourceVector<S> iterate(int size,
                                                                            Supplier<? extends S> producer)
```
    Creates a new aggregate with a given number components obtained from a producer.
    
    Parameters:
    
    size - the number of elements of the new aggregate
    
    producer - the producer of signal source components
    
    Throws:
    
    IllegalArgumentException - if size < 0
  - empty
```
static <S extends BooleanSignalSource> BooleanSignalSourceVector<S> empty()
```
    Creates a new aggregate with zero components.
  - singleton
```
static <S extends BooleanSignalSource> BooleanSignalSourceVector<S> singleton(S source)
```
    Creates a new aggregate with one component.
    
    Parameters:
    
    source - the component of the new aggregate
  - append
```
default BooleanSignalSourceVector<S> append(BooleanSignalSourceVector<S> other)
```
    Returns a new aggregate that combines the components of this and the given other aggregate in order.
    For app = this.append(other), it holds that app.size() == this.size() + other.size(); furthermore, for m = this.size(), app.get(i) == this.get(i) holds for i < m, and app.get(i) == other.get(i - m) holds for i >= m.
    
    Parameters:
    
    other - the other aggregate
  - map
```
default BooleanSignalSourceVector<BooleanSignalSource> map(BooleanUnaryOperator op)
```
    Returns a new aggregate that is obtained by uniformly transforming the values of the corresponding components of this aggregate.
    For that = this.map(f), it holds that that.size() == this.size(); furthermore, at any point in time, that.get(i).getAsBoolean() == op.applyAsBoolean(this.get(i).getAsBoolean()) holds.
    
    Parameters:
    
    op - the operator to apply to the values of all components
    
    See Also:
    
    BooleanSignalSource.map(BooleanUnaryOperator)
  - zipWith
```
default BooleanSignalSourceVector<BooleanSignalSource> zipWith(BooleanBinaryOperator op,
                                                               BooleanSignalSourceVector<?> other)
```
    Returns a new aggregate that is obtained by uniformly combining the values of the corresponding components of this and another aggregate.
    For that = this.map(f), it holds that that.size() == this.size() == other.size(); furthermore, at any point in time, that.get(i).getAsBoolean() == op.applyAsBoolean(this.get(i).getAsBoolean(), other.get(i).getAsBoolean()) holds.
    
    Parameters:
    
    op - the operator to apply to the values of all components
    
    Throws:
    
    IllegalArgumentException - if the two aggregates are of different size
    
    See Also:
    
    BooleanSignalSource.zipWith(BooleanBinaryOperator, BooleanSignalSource)
  - stored
```
default BooleanClockedSignalSourceVector stored()
```
    Returns a new aggegate whose components take snapshots of the corresponding components of this aggregate.
    
    See Also:
    
    BooleanSignalSource.stored()

Interface BooleanSignalSourceVector<S extends BooleanSignalSource>

Nested Class Summary

Method Summary

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Method Detail

sizeCompatibleWith

sizeCompatibleWith

sizeCompatibleWith

of

of

of

of

repeat

iterate

empty

singleton

append

map

zipWith

stored