Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface floatcomplexndarray

Interface describing an ndarray having a floating-point real or complex number data type.

Hierarchy

Index

Properties

Methods

Properties

BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

Size (in bytes) of each array element.

byteLength

byteLength: number

Size (in bytes) of the array.

data

data: FloatOrComplexTypedArray

A reference to the underlying data buffer.

dtype

dtype: FloatOrComplexDataType

Underlying data type.

flags

flags: { COLUMN_MAJOR_CONTIGUOUS: boolean; READONLY?: undefined | false | true; ROW_MAJOR_CONTIGUOUS: boolean }

Flags and other meta information (e.g., memory layout of the array).

Type declaration

  • COLUMN_MAJOR_CONTIGUOUS: boolean

    Boolean indicating if an array is column-major contiguous.

  • Optional READONLY?: undefined | false | true

    Boolean indicating if an array is read-only.

  • ROW_MAJOR_CONTIGUOUS: boolean

    Boolean indicating if an array is row-major contiguous.

length

length: number

Number of array elements.

ndims

ndims: number

Number of dimensions.

offset

offset: number

Index offset which specifies the buffer index at which to start iterating over array elements.

order

order: Order

Array order.

Notes
  • The array order is either row-major (C-style) or column-major (Fortran-style).

shape

shape: Shape

Array shape.

strides

strides: Strides

Array strides.

Methods

get

  • get(...args: Array<number>): number | ComplexLike | void

set