Class Builder<T>

Implementation of IBuilder that that adds in aligned order.

Type Parameters

T = any

Implements

IBuilder<T>

Index

Constructors

Methods

addValue addValues build

Constructors

constructor

new Builder<T = any>(
    createList?: (arr: T[]) => IList<T>,
    offsetMajor?: number,
    offsetMinor?: number,
): Builder<T>
Type Parameters
- T = any
Parameters
- OptionalcreateList: (arr: T[]) => IList<T>
- offsetMajor: number = 0
- offsetMinor: number = 0
Returns Builder<T>

Methods

addValue

addValue(major: number, minor: number, value: T): IBuilder<T>
Adds a single value associated with a specific major and minor index.
Parameters
- major: number
  The major index.
- minor: number
  The minor index.
- value: T
  The value to be added.
Returns IBuilder<T>
Remarks
If the value is an Array, it will be treated as a discrete value. If you want to set multiple values along the minor axis, then use addValues.

Implementation of IBuilder.addValue

addValues

addValues(major: number, minor: number, value: T[]): IBuilder<T>
Adds multiple values associated with a specific major and minor index.
Parameters
- major: number
  The major index.
- minor: number
  The minor index.
- value: T[]
  An array of values to be added.
Returns IBuilder<T>
Implementation of IBuilder.addValues

build

build(): BoundedTuples<T>
Constructs and returns the bounded tuples based on the added values. This method can be called multiple times.

Returns BoundedTuples<T>
The built bounded tuples.

Implementation of IBuilder.build