"ndarrayMemoized": "\nndarrayMemoized( dtype, ndims[, options] )\n Returns a memoized ndarray constructor.\n\n Parameters\n ----------\n dtype: string\n Underlying data type.\n\n ndims: integer\n Number of dimensions.\n\n options: Object (optional)\n Options.\n\n options.codegen: boolean (optional)\n Boolean indicating whether to use code generation. Code generation can\n boost performance, but may be problematic in browser contexts enforcing\n a strict content security policy (CSP). Default: true.\n\n options.mode: string (optional)\n Specifies how to handle indices which exceed array dimensions. If equal\n to 'throw', an ndarray instance throws an error when an index exceeds\n array dimensions. If equal to 'wrap', an ndarray instance wraps around\n indices exceeding array dimensions using modulo arithmetic. If equal to\n 'clamp', an ndarray instance sets an index exceeding array dimensions to\n either `0` (minimum index) or the maximum index. Default: 'throw'.\n\n options.submode: Array<string> (optional)\n Specifies how to handle subscripts which exceed array dimensions. If a\n mode for a corresponding dimension is equal to 'throw', an ndarray\n instance throws an error when a subscript exceeds array dimensions. If\n equal to 'wrap', an ndarray instance wraps around subscripts exceeding\n array dimensions using modulo arithmetic. If equal to 'clamp', an\n ndarray instance sets a subscript exceeding array dimensions to either\n `0` (minimum index) or the maximum index. If the number of modes is\n fewer than the number of dimensions, the function recycles modes using\n modulo arithmetic. Default: [ options.mode ].\n\n Returns\n -------\n ctor: Function\n Memoized ndarray constructor.\n\n ctor.BYTES_PER_ELEMENT: integer\n Size (in bytes) of each array element (if known).\n\n ctor.dtype: string\n Underlying data type.\n\n ctor.ndims: integer\n Number of dimensions.\n\n ctor.prototype.byteLength: integer\n Size (in bytes) of the array (if known).\n\n ctor.prototype.BYTES_PER_ELEMENT: integer\n Size (in bytes) of each array element (if known).\n\n ctor.prototype.data: ArrayLikeObject|TypedArray|Buffer\n Pointer to the underlying data buffer.\n\n ctor.prototype.dtype: string\n Underlying data type.\n\n ctor.prototype.flags: Object\n Information about the memory layout of the array.\n\n ctor.prototype.length: integer\n Length of the array (i.e., number of elements).\n\n ctor.prototype.ndims: integer\n Number of dimensions.\n\n ctor.prototype.offset: integer\n Index offset which specifies the buffer index at which to start\n iterating over array elements.\n\n ctor.prototype.order: string\n Array order. The array order is either row-major (C-style) or column-\n major (Fortran-style).\n\n ctor.prototype.shape: Array\n Array shape.\n\n ctor.prototype.strides: Array\n Index strides which specify how to access data along corresponding array\n dimensions.\n\n ctor.prototype.get: Function\n Returns an array element specified according to provided subscripts. The\n number of provided subscripts should equal the number of dimensions.\n\n ctor.prototype.iget: Function\n Returns an array element located at a specified linear index.\n\n ctor.prototype.set: Function\n Sets an array element specified according to provided subscripts. The\n number of provided subscripts should equal the number of dimensions.\n\n ctor.prototype.iset: Function\n Sets an array element located at a specified linear index.\n\n ctor.prototype.toString: Function\n Serializes an ndarray as a string. This method does **not** serialize\n data outside of the buffer region defined by the array configuration.\n\n ctor.prototype.toJSON: Function\n Serializes an ndarray as a JSON object. This method does **not**\n serialize data outside of the buffer region defined by the array\n configuration.\n\n Examples\n --------\n > var ctor = ndarrayMemoized( 'generic', 3 )\n <Function>\n > var f = ndarrayMemoized( 'generic', 3 )\n <Function>\n > var bool = ( f === ctor )\n true\n\n // To create a new instance...\n > var b = [ 1.0, 2.0, 3.0, 4.0 ]; // underlying data buffer\n > var d = [ 2, 2 ]; // shape\n > var s = [ 2, 1 ]; // strides\n > var o = 0; // index offset\n > var arr = ctor( b, d, s, o, 'row-major' )\n <ndarray>\n\n // Get an element using subscripts:\n > var v = arr.get( 1, 1 )\n 4.0\n\n // Get an element using a linear index:\n > v = arr.iget( 3 )\n 4.0\n\n // Set an element using subscripts:\n > arr.set( 1, 1, 40.0 );\n > arr.get( 1, 1 )\n 40.0\n\n // Set an element using a linear index:\n > arr.iset( 3, 99.0 );\n > arr.get( 1, 1 )\n 99.0\n\n See Also\n --------\n array, ndarray\n",
0 commit comments