Interface IGridND<BUF, T>

Semi-typechecked interface for cases accepting 1D-4D grids, i.e. IGrid1D - IGrid4D.

interface IGridND<BUF, T> {
    data: BUF;
    dim: number;
    offset: number;
    size: NumericArray;
    stride: NumericArray;
    getAt(...pos): T;
    getAtUnsafe(...pos): T;
    includes(...pos): boolean;
    indexAt(...pos): number;
    indexAtUnsafe(...pos): number;
    order(): number[];
    setAt(...args): boolean;
    setAtUnsafe(...args): boolean;
}

Type Parameters

Hierarchy (view full)

Properties

data: BUF
dim: number
offset: number
stride: NumericArray

Methods

  • Returns value at given position. If outside the grid's defined region, returns a suitable zero value.

    Parameters

    • Rest ...pos: [number, number] | [number] | [number, number, number] | [number, number, number, number]

    Returns T

  • Non-boundschecked version of IGridND.getAt. Assumes given position is valid.

    Parameters

    • Rest ...pos: [number, number] | [number] | [number, number, number] | [number, number, number, number]

    Returns T

  • Returns true if given position is valid (i.e. within grid bounds).

    Parameters

    • Rest ...pos: [number, number] | [number] | [number, number, number] | [number, number, number, number]

    Returns boolean

  • Returns index for given position. Returns negative value if outside the grid's defined region.

    Parameters

    • Rest ...pos: [number, number] | [number] | [number, number, number] | [number, number, number, number]

    Returns number

  • Non-boundschecked version of IGridND.indexAt. Assumes given position is valid.

    Parameters

    • Rest ...pos: [number, number] | [number] | [number, number, number] | [number, number, number, number]

    Returns number

  • Writes value at given position. Has no effect if outside of the defined region. Returns true, if succeeded.

    Parameters

    • Rest ...args: [number, T] | [number, number, T] | [number, number, number, T] | [number, number, number, number, T]

    Returns boolean

  • Non-boundschecked version of IGridND.setAt. Assumes given position is valid. Returns true, if succeeded.

    Parameters

    • Rest ...args: [number, T] | [number, number, T] | [number, number, number, T] | [number, number, number, number, T]

    Returns boolean

Generated using TypeDoc