Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "ndarray/ctor/docs/types/index.d"

Index

Interfaces

Variables

Variables

ctor

ndarray constructor.

param

data type

param

data buffer

param

array shape

param

array strides

param

index offset

param

specifies whether an array is row-major (C-style) or column-major (Fortran-style)

param

function options

param

specifies how to handle indices which exceed array dimensions (default: 'throw')

param

specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw'])

param

specifies whether an array should be read-only (default: false)

throws

buffer argument get and set properties must be functions

throws

shape argument must be an array-like object containing nonnegative integers

throws

shape argument length must equal the number of dimensions

throws

strides argument must be an array-like object containing integers

throws

strides argument length must equal the number of dimensions (except for zero-dimensional arrays; in which case, the strides argument length must be equal to 1)

throws

for zero-dimensional ndarrays, the strides argument must contain a single element equal to 0

throws

offset argument must be a nonnegative integer

throws

buffer argument must be compatible with specified meta data

throws

must provide valid options

throws

too many dimensions

returns

ndarray instance