Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "@stdlib/types/ndarray"

Module containing ndarray definitions.

Index

Interfaces

Type aliases

Type aliases

BooleanAndGenericDataType

BooleanAndGenericDataType: BooleanDataType | "generic"

Data type for boolean and generic ndarrays.

BooleanAndGenericDataTypeMap

BooleanAndGenericDataTypeMap<T>: Remap<BooleanDataTypeMap & { generic: genericndarray<T> }>

Mapping of boolean data types and the "generic" data type to ndarray constructors.

Type parameters

  • T

BooleanDataType

BooleanDataType: "bool"

Data type for boolean typed arrays.

BooleanDataTypeMap

BooleanDataTypeMap: { bool: booleanndarray }

Mapping of data types for boolean typed ndarrays to ndarray constructors.

Type declaration

CartesianIndexArray

CartesianIndexArray: IntegerIndexArray

Cartesian index ndarray.

ComplexFloatingPointAndGenericDataType

ComplexFloatingPointAndGenericDataType: ComplexFloatingPointDataType | "generic"

Data type for complex number ndarrays.

ComplexFloatingPointAndGenericDataTypeMap

ComplexFloatingPointAndGenericDataTypeMap<T>: Remap<ComplexFloatingPointDataTypeMap & { generic: genericndarray<T> }>

Mapping of complex floating point data types and the "generic" data type to ndarray constructors.

Type parameters

  • T

ComplexFloatingPointDataType

ComplexFloatingPointDataType: "complex64" | "complex128"

Data type for complex number ndarrays.

ComplexFloatingPointDataTypeMap

ComplexFloatingPointDataTypeMap: { complex128: complex128ndarray; complex64: complex64ndarray }

Mapping of data types for complex number typed ndarrays to ndarray constructors.

Type declaration

DataType

DataType: NumericDataType | BooleanDataType | "binary" | "generic"

Data type.

DataTypeKind

DataTypeKind: StrictDataTypeKind | "all" | "typed_and_generic" | "numeric_and_generic" | "real_and_generic" | "floating_point_and_generic" | "real_floating_point_and_generic" | "complex_floating_point_and_generic" | "integer_and_generic" | "signed_integer_and_generic" | "unsigned_integer_and_generic" | "boolean_and_generic"

Data type "kinds".

DataTypeMap

DataTypeMap<T>: Remap<TypedDataTypeMap & { generic: genericndarray<T> }>

Mapping of data types to ndarray constructors.

Type parameters

  • T

FloatingPointAndGenericDataType

FloatingPointAndGenericDataType: FloatingPointDataType | "generic"

Data type for floating-point real or complex ndarrays.

FloatingPointAndGenericDataTypeMap

FloatingPointAndGenericDataTypeMap<T>: Remap<FloatingPointDataTypeMap & { generic: genericndarray<T> }>

Mapping for floating point (real or complex) data types and the "generic" data type to ndarray constructors.

Type parameters

  • T

FloatingPointDataType

Data type for floating-point real or complex ndarrays.

FloatingPointDataTypeMap

Mapping of data types for floating-point (real or complex) typed ndarrays to ndarray constructors.

GenericBooleanIndexArray

GenericBooleanIndexArray: genericndarray<boolean>

Boolean index ndarray.

GenericIndexArray

Generic index array.

GenericIntegerIndexArray

GenericIntegerIndexArray: genericndarray<number>

Integer index ndarray.

IndexArray

Index ndarray.

IndexArrayKinds

IndexArrayKinds: "" | "cartesian" | "linear"

Integer index ndarray kinds.

IntegerAndGenericDataType

IntegerAndGenericDataType: IntegerDataType | "generic"

Data type for integer ndarrays.

IntegerAndGenericDataTypeMap

IntegerAndGenericDataTypeMap<T>: Remap<IntegerDataTypeMap & { generic: genericndarray<T> }>

Mapping of integer data types and the "generic" data type to ndarray constructors.

Type parameters

  • T

IntegerDataType

Data type for integer ndarrays.

IntegerDataTypeMap

Mapping of integer data types to ndarray constructors.

IntegerIndexArray

Integer index ndarray.

LinearIndexArray

LinearIndexArray: IntegerIndexArray

Linear index ndarray.

Mode

Mode: "throw" | "normalize" | "clamp" | "wrap"

Array index mode.

Notes

  • The following index modes are supported:

    • throw: specifies that a function should throw an error when an index is outside a restricted interval.
    • normalize: specifies that a function should normalize negative indices and throw an error when an index is outside a restricted interval.
    • wrap: specifies that a function should wrap around an index using modulo arithmetic.
    • clamp: specifies that a function should set an index less than zero to zero (minimum index) and set an index greater than a maximum index value to the maximum possible index.

NumericAndGenericDataType

NumericAndGenericDataType: NumericDataType | "generic"

Data type for real-valued or complex number ndarrays.

NumericAndGenericDataTypeMap

NumericAndGenericDataTypeMap<T>: Remap<NumericDataTypeMap & { generic: genericndarray<T> }>

Mapping of numeric (real or complex) data types and the "generic" data type to ndarray constructors.

Type parameters

  • T

NumericDataType

Data type for real-valued or complex number ndarrays.

NumericDataTypeMap

Mapping of numeric data types (real or complex) to ndarray constructors.

Order

Order: Layout

Array order.

Notes

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

OutputPolicy

OutputPolicy: "default" | "same" | "promoted" | "boolean" | "numeric" | "real" | "floating_point" | "real_floating_point" | "complex_floating_point" | "integer" | "signed_integer" | "unsigned_integer"

Output data type policy.

RealAndGenericDataType

RealAndGenericDataType: RealDataType | "generic"

Data type for real-valued ndarrays.

RealAndGenericDataTypeMap

RealAndGenericDataTypeMap<T>: Remap<RealDataTypeMap & { generic: genericndarray<T> }>

Mapping of data types for real-valued typed ndarrays and the "generic" data type to ndarray constructors.

Type parameters

  • T

RealDataType

Data type for real-valued ndarrays.

RealDataTypeMap

Mapping of data types for real-valued typed arrays to ndarray constructors.

RealFloatingPointAndGenericDataType

RealFloatingPointAndGenericDataType: RealFloatingPointDataType | "generic"

Data type for floating-point ndarrays.

RealFloatingPointAndGenericDataTypeMap

RealFloatingPointAndGenericDataTypeMap<T>: Remap<RealFloatingPointDataTypeMap & { generic: genericndarray<T> }>

Mapping of real floating point data types and the "generic" data type to ndarray constructors.

Type parameters

  • T

RealFloatingPointDataType

RealFloatingPointDataType: "float64" | "float32"

Data type for floating-point ndarrays.

RealFloatingPointDataTypeMap

RealFloatingPointDataTypeMap: { float32: float32ndarray; float64: float64ndarray }

Mapping of data types for complex number typed ndarrays to ndarray constructors.

Type declaration

Shape

Shape: Collection<number>

Array shape.

Notes

  • Each element of the array shape (i.e., dimension size) should be a nonnegative integer.

Shape0D

Shape0D: Collection<never>

Array shape for a zero-dimensional array.

Notes

  • The array shape for a zero-dimensional array contains zero elements.

Shape10D

Shape10D: Collection<number>

Array shape for a ten-dimensional array.

Notes

  • The array shape for a ten-dimensional array contains ten elements and each element (i.e., dimension size) should be a nonnegative integer.

Shape1D

Shape1D: Collection<number>

Array shape for a one-dimensional array.

Notes

  • The array shape for a one-dimensional array contains a single element and the element value (i.e., dimension size) should be a nonnegative integer.

Shape2D

Shape2D: Collection<number>

Array shape for a two-dimensional array.

Notes

  • The array shape for a three-dimensional array contains two elements and each element (i.e., dimension size) should be a nonnegative integer.

Shape3D

Shape3D: Collection<number>

Array shape for a three-dimensional array.

Notes

  • The array shape for a three-dimensional array contains three elements and each element (i.e., dimension size) should be a nonnegative integer.

Shape4D

Shape4D: Collection<number>

Array shape for a four-dimensional array.

Notes

  • The array shape for a four-dimensional array contains four elements and each element (i.e., dimension size) should be a nonnegative integer.

Shape5D

Shape5D: Collection<number>

Array shape for a five-dimensional array.

Notes

  • The array shape for a five-dimensional array contains five elements and each element (i.e., dimension size) should be a nonnegative integer.

Shape6D

Shape6D: Collection<number>

Array shape for a six-dimensional array.

Notes

  • The array shape for a six-dimensional array contains six elements and each element (i.e., dimension size) should be a nonnegative integer.

Shape7D

Shape7D: Collection<number>

Array shape for a seven-dimensional array.

Notes

  • The array shape for a seven-dimensional array contains seven elements and each element (i.e., dimension size) should be a nonnegative integer.

Shape8D

Shape8D: Collection<number>

Array shape for an eight-dimensional array.

Notes

  • The array shape for an eight-dimensional array contains eight elements and each element (i.e., dimension size) should be a nonnegative integer.

Shape9D

Shape9D: Collection<number>

Array shape for a nine-dimensional array.

Notes

  • The array shape for a nine-dimensional array contains nine elements and each element (i.e., dimension size) should be a nonnegative integer.

SignedIntegerAndGenericDataType

SignedIntegerAndGenericDataType: SignedIntegerDataType | "generic"

Data type for signed integer ndarrays.

SignedIntegerAndGenericDataTypeMap

SignedIntegerAndGenericDataTypeMap<T>: Remap<SignedIntegerDataTypeMap & { generic: genericndarray<T> }>

Mapping of signed integer data types and the "generic" data type to ndarray constructors.

Type parameters

  • T

SignedIntegerDataType

SignedIntegerDataType: "int32" | "int16" | "int8"

Data type for signed integer ndarrays.

SignedIntegerDataTypeMap

SignedIntegerDataTypeMap: { int16: int16ndarray; int32: int32ndarray; int8: int8ndarray }

Mapping of signed integer data types to ndarray constructors.

Type declaration

StrictDataTypeKind

StrictDataTypeKind: "typed" | "numeric" | "real" | "floating_point" | "real_floating_point" | "complex_floating_point" | "integer" | "signed_integer" | "unsigned_integer" | "boolean"

Strict data type "kinds".

Strides

Strides: Collection<number>

Array strides.

Notes

  • Each stride (i.e., index increment along a respective dimension) should be an integer.

Strides0D

Strides0D: Collection<number>

Array strides for a zero-dimensional array.

Notes

  • The strides array for a two-dimensional array contains a single element equal to zero.

Strides10D

Strides10D: Collection<number>

Array strides for a ten-dimensional array.

Notes

  • The strides array for a ten-dimensional array contains ten elements and each element should be an integer.

Strides1D

Strides1D: Collection<number>

Array strides for a one-dimensional array.

Notes

  • The strides array for a two-dimensional array containsgle element and the element value should be an integer.

Strides2D

Strides2D: Collection<number>

Array strides for a two-dimensional array.

Notes

  • The strides array for a two-dimensional array contains two elements and each element should be an integer.

Strides3D

Strides3D: Collection<number>

Array strides for a three-dimensional array.

Notes

  • The strides array for a three-dimensional array contains three elements and each element should be an integer.

Strides4D

Strides4D: Collection<number>

Array strides for a four-dimensional array.

Notes

  • The strides array for a four-dimensional array contains four elements and each element should be an integer.

Strides5D

Strides5D: Collection<number>

Array strides for a five-dimensional array.

Notes

  • The strides array for a five-dimensional array contains five elements and each element should be an integer.

Strides6D

Strides6D: Collection<number>

Array strides for a six-dimensional array.

Notes

  • The strides array for a six-dimensional array contains six elements and each element should be an integer.

Strides7D

Strides7D: Collection<number>

Array strides for a seven-dimensional array.

Notes

  • The strides array for a seven-dimensional array contains seven elements and each element should be an integer.

Strides8D

Strides8D: Collection<number>

Array strides for an eight-dimensional array.

Notes

  • The strides array for an eight-dimensional array contains eight elements and each element should be an integer.

Strides9D

Strides9D: Collection<number>

Array strides for a nine-dimensional array.

Notes

  • The strides array for a nine-dimensional array contains nine elements and each element should be an integer.

TypedAndGenericDataType

TypedAndGenericDataType: TypedDataType | "generic"

Data type for strictly typed and generic ndarrays.

TypedDataType

Data type for strictly "typed" ndarrays.

TypedDataTypeMap

Mapping of strictly typed ndarray data types to ndarray constructors.

TypedIndexArray

Strictly typed index ndarray.

UnsignedIntegerAndGenericDataType

UnsignedIntegerAndGenericDataType: UnsignedIntegerDataType | "generic"

Data type for unsigned integer ndarrays.

UnsignedIntegerAndGenericDataTypeMap

UnsignedIntegerAndGenericDataTypeMap<T>: Remap<UnsignedIntegerDataTypeMap & { generic: genericndarray<T> }>

Mapping of unsigned integer data types and the "generic" data type to ndarray constructors.

Type parameters

  • T

UnsignedIntegerDataType

UnsignedIntegerDataType: "uint32" | "uint16" | "uint8" | "uint8c"

Data type for unsigned integer ndarrays.

UnsignedIntegerDataTypeMap

UnsignedIntegerDataTypeMap: { uint16: uint16ndarray; uint32: uint32ndarray; uint8: uint8ndarray; uint8c: uint8cndarray }

Mapping of unsigned integer data types to ndarray constructors.

Type declaration

ndindex

ndarray index object.

ndindexObject

Index ndarray data object.