Class TransposedBuilder<T>

Transposes cell coordinates within tuples to create MajorTuple representations in the opposite axis.

This utility efficiently converts data organized by one axis into the opposite.

Type Parameters

T

Implements

IBuilder<T>

Index

Constructors

Methods

build getAt pushAt pushMultipleAt

Constructors

constructor

new TransposedBuilder<T>(
    createList?: CreateList<T>,
    offsetMajor?: number,
    offsetMinor?: number,
): TransposedBuilder<T>
Type Parameters
- T
Parameters
- OptionalcreateList: CreateList<T>
- offsetMajor: number = 0
- offsetMinor: number = 0
Returns TransposedBuilder<T>

Methods

build

build(): Region<T>

Constructs and returns the bounded tuples based on the added values. This method can be called multiple times.

Returns Region<T>
The built bounded tuples.

Implementation of IBuilder.build

getAt

getAt(major: number, minor: number): T | undefined
The value pushed at a position, as pushAt was given it.
Parameters
- major: number
- minor: number
Returns T | undefined
undefined if no value is stored there.

Implementation of IBuilder.getAt

pushAt

pushAt(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 pushMultipleAt.

Implementation of IBuilder.pushAt

pushMultipleAt

pushMultipleAt(
    major: number,
    minor: number,
    value: IListLike<T> | 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: IListLike<T> | T[]
  An array of values to be added.
Returns IBuilder<T>

Implementation of IBuilder.pushMultipleAt