You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
ndemptyLike,"var x = base.ndzeros( 'float64', [ 2, 2 ], 'row-major' )\nvar sh = x.shape\nvar dt = x.dtype\nvar y = ndemptyLike( x )\nsh = y.shape\ndt = y.dtype\n"
3682
+
ndims,"var n = ndims( ndzeros( [ 3, 3, 3 ] ) )\n"
3682
3683
nditerColumns,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar it = nditerColumns( x );\nvar v = it.next().value;\nndarray2array( v )\nv = it.next().value;\nndarray2array( v )\n"
3683
3684
nditerEntries,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar it = nditerEntries( x );\nvar v = it.next().value\nv = it.next().value\n"
3684
3685
nditerIndices,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar it = nditerIndices( x.shape );\nvar v = it.next().value\nv = it.next().value\n"
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/repl/help/data/data.csv
+1
Original file line number
Diff line number
Diff line change
@@ -3685,6 +3685,7 @@ nditerEntries,"\nnditerEntries( x[, options] )\n Returns an iterator which re
3685
3685
nditerIndices,"\nnditerIndices( shape[, options] )\n Returns an iterator which returns indices for use indexing into an ndarray\n having a specified shape.\n\n If an environment supports Symbol.iterator, the returned iterator is\n iterable.\n\n Parameters\n ----------\n shape: Array<integer>\n Input shape.\n\n options: Object (optional)\n Options.\n\n options.order: string (optional)\n Index iteration order. By default, the returned iterator iterates over\n the last dimensions first, thus corresponding to iteration over\n contiguous data stored in row-major order. Must be either 'row-major'\n or 'column-major'.\n\n Returns\n -------\n iterator: Object\n Iterator.\n\n iterator.next(): Function\n Returns an iterator protocol-compliant object containing the next\n iterated value (if one exists) and a boolean flag indicating whether the\n iterator is finished.\n\n iterator.return( [value] ): Function\n Finishes an iterator and returns a provided value.\n\n Examples\n --------\n > var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n > var it = nditerIndices( x.shape );\n > var v = it.next().value\n [ 0, 0 ]\n > v = it.next().value\n [ 0, 1 ]\n\n See Also\n --------\n ndarray, nditerEntries, nditerValues\n"
3686
3686
nditerRows,"\nnditerRows( x[, options] )\n Returns an iterator which iterates over each row in a matrix (or stack of\n matrices).\n\n If an environment supports Symbol.iterator, the returned iterator is\n iterable.\n\n If an environment supports Symbol.iterator, the function explicitly does not\n invoke an ndarray's `@@iterator` method, regardless of whether this method\n is defined.\n\n Parameters\n ----------\n x: ndarray\n Input ndarray for which to create the iterator.\n\n options: Object (optional)\n Options.\n\n options.readonly: boolean (optional)\n Boolean indicating whether returned ndarray views should be read-only.\n If the input ndarray is read-only, setting this option to `false` raises\n an exception. Default: true.\n\n Returns\n -------\n iterator: Object\n Iterator.\n\n iterator.next(): Function\n Returns an iterator protocol-compliant object containing the next\n iterated value (if one exists) and a boolean flag indicating whether the\n iterator is finished.\n\n iterator.return( [value] ): Function\n Finishes an iterator and returns a provided value.\n\n Examples\n --------\n > var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n > var it = nditerRows( x );\n > var v = it.next().value;\n > ndarray2array( v )\n [ 1, 2 ]\n > v = it.next().value;\n > ndarray2array( v )\n [ 3, 4 ]\n\n See Also\n --------\n nditerColumns, ndslice\n"
3687
3687
nditerValues,"\nnditerValues( x[, options] )\n Returns an iterator which returns individual elements from a provided\n ndarray.\n\n If an environment supports Symbol.iterator, the returned iterator is\n iterable.\n\n If an environment supports Symbol.iterator, the function explicitly does not\n invoke an ndarray's `@@iterator` method, regardless of whether this method\n is defined.\n\n Parameters\n ----------\n x: ndarray\n Input array.\n\n options: Object (optional)\n Options.\n\n options.order: string (optional)\n Index iteration order. By default, the returned iterator returns values\n according to the layout order of the provided array. Accordingly, for\n row-major input arrays, the last dimension indices increment fastest.\n For column-major input arrays, the first dimension indices increment\n fastest. To override the inferred order and ensure that indices\n increment in a specific manor, regardless of the input array's layout\n order, explicitly set the iteration order. Note, however, that iterating\n according to an order which does not match that of the input array may,\n in some circumstances, result in performance degradation due to cache\n misses. Must be either 'row-major' or 'column-major'.\n\n Returns\n -------\n iterator: Object\n Iterator.\n\n iterator.next(): Function\n Returns an iterator protocol-compliant object containing the next\n iterated value (if one exists) and a boolean flag indicating whether the\n iterator is finished.\n\n iterator.return( [value] ): Function\n Finishes an iterator and returns a provided value.\n\n Examples\n --------\n > var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n > var it = nditerValues( x );\n > var v = it.next().value\n 1\n > v = it.next().value\n 2\n\n See Also\n --------\n ndarray, nditerEntries, nditerIndices\n"
3688
+
ndshape,"\nndshape( x )\n Returns the shape of a provided ndarray.\n\n Parameters\n ----------\n x: ndarray\n Input ndarray.\n\n Returns\n -------\n out: Array<integer>\n Shape.\n\n Examples\n --------\n > var out = ndshape( ndzeros( [ 3, 3, 3 ] ) )\n [ 3, 3, 3 ]\n\n See Also\n --------\n array, ndarray\n"
3688
3689
ndslice,"\nndslice( x, ...s[, options] )\n Returns a read-only view of an input ndarray.\n\n The function supports three (mutually exclusive) means of providing slice\n arguments:\n\n 1. Providing a single MultiSlice object.\n 2. Providing a single array containing slice arguments.\n 3. Providing slice arguments as separate arguments.\n\n An individual slice argument must be either a Slice, an integer, null, or\n undefined.\n\n In all cases, the number of slice dimensions must match the number of array\n dimensions.\n\n If providing a MultiSlice object or an array of slice arguments, no other\n slice arguments should be provided.\n\n Mixing function invocation styles (e.g., providing multiple MultiSlice\n objects or providing an array of slice arguments followed by additional\n slice arguments) is not supported.\n\n Parameters\n ----------\n x: ndarray\n Input array.\n\n s: ...MultiSlice|Slice|null|undefined|integer|ArrayLike\n Slice arguments.\n\n options: Object (optional)\n Options.\n\n options.strict: boolean (optional)\n Boolean indicating whether to enforce strict bounds checking.\n Default: true.\n\n Returns\n -------\n out: ndarray\n Output array view.\n\n Examples\n --------\n > var x = array( [ [ 1, 2 ], [ 3, 4 ] ] )\n <ndarray>\n > x.shape\n [ 2, 2 ]\n > var s = new MultiSlice( null, 1 )\n <MultiSlice>\n > var y = ndslice( x, s )\n <ndarray>\n > y.shape\n [ 2 ]\n > ndarray2array( y )\n [ 2, 4 ]\n\n See Also\n --------\n array, ndarray, ndsliceAssign\n"
3689
3690
ndsliceAssign,"\nndsliceAssign( x, y, ...s[, options] )\n Assigns element values from a broadcasted input ndarray to corresponding\n elements in an output ndarray view.\n\n The function supports three (mutually exclusive) means of providing slice\n arguments:\n\n 1. Providing a single MultiSlice object.\n 2. Providing a single array containing slice arguments.\n 3. Providing slice arguments as separate arguments.\n\n An individual slice argument must be either a Slice, an integer, null, or\n undefined.\n\n In all cases, the number of slice dimensions must match the number of output\n array dimensions.\n\n If providing a MultiSlice object or an array of slice arguments, no other\n slice arguments should be provided.\n\n Mixing function invocation styles (e.g., providing multiple MultiSlice\n objects or providing an array of slice arguments followed by additional\n slice arguments) is not supported.\n\n Parameters\n ----------\n x: ndarray\n Input array. The input array must be broadcast compatible with the\n output array view and must have a data type which can be safely cast to\n the output array data type. Floating-point data types (both real and\n complex) are allowed to downcast to a lower precision data type of the\n same kind (e.g., element values from a 'float64' input array can be\n assigned to corresponding elements in a 'float32' output array).\n\n y: ndarray\n Output array. The output array must be writable.\n\n s: ...MultiSlice|Slice|null|undefined|integer|ArrayLike\n Slice arguments.\n\n options: Object (optional)\n Options.\n\n options.strict: boolean (optional)\n Boolean indicating whether to enforce strict bounds checking.\n Default: true.\n\n Returns\n -------\n out: ndarray\n Output array.\n\n Examples\n --------\n > var y = ndzeros( [ 2, 2 ] )\n <ndarray>\n > var x = scalar2ndarray( 3.0 )\n <ndarray>\n > var s = new MultiSlice( null, 1 )\n <MultiSlice>\n > var out = ndsliceAssign( x, y, s )\n <ndarray>\n > var bool = ( out === y )\n true\n > ndarray2array( y )\n [ [ 0.0, 3.0 ], [ 0.0, 3.0 ] ]\n\n See Also\n --------\n array, ndarray, ndslice\n"
3690
3691
ndzeros,"\nndzeros( shape[, options] )\n Returns a zero-filled ndarray having a specified shape and data type.\n\n Parameters\n ----------\n shape: ArrayLikeObject<integer>|integer\n Array shape.\n\n options: Object (optional)\n Options.\n\n options.dtype: string (optional)\n Underlying data type. Default: 'float64'.\n\n options.order: string (optional)\n Specifies whether an array is row-major (C-style) or column-major\n (Fortran-style). Default: 'row-major'.\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 options.readonly: boolean (optional)\n Boolean indicating whether an array should be read-only. Default: false.\n\n Returns\n -------\n out: ndarray\n Output array.\n\n Examples\n --------\n > var arr = ndzeros( [ 2, 2 ] )\n <ndarray>\n > var sh = arr.shape\n [ 2, 2 ]\n > var dt = arr.dtype\n 'float64'\n\n See Also\n --------\n ndempty, ndzerosLike\n"
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/repl/info/data/data.csv
+1
Original file line number
Diff line number
Diff line change
@@ -3679,6 +3679,7 @@ ndarraySafeCasts,"\nndarraySafeCasts( [dtype:any] )\n Returns a list of ndarr
3679
3679
ndarraySameKindCasts,"\nndarraySameKindCasts( [dtype:any] )\n Returns a list of ndarray data types to which a provided ndarray data type\n can be safely cast or cast within the same \"kind\".\n"
3680
3680
ndempty,"\nndempty( shape:ArrayLikeObject<integer>|integer[, options:Object] )\n Returns an uninitialized ndarray having a specified shape and data type.\n"
3681
3681
ndemptyLike,"\nndemptyLike( x:ndarray[, options:Object] )\n Returns an uninitialized ndarray having the same shape and data type as a\n provided input ndarray.\n"
3682
+
ndims,"\nndims( x:ndarray )\n Returns the number of ndarray dimensions.\n"
3682
3683
nditerColumns,"\nnditerColumns( x:ndarray[, options:Object] )\n Returns an iterator which iterates over each column in a matrix (or stack of\n matrices).\n"
3683
3684
nditerEntries,"\nnditerEntries( x:ndarray[, options:Object] )\n Returns an iterator which returns [index, value] pairs for each element in a\n provided ndarray.\n"
3684
3685
nditerIndices,"\nnditerIndices( shape:Array<integer>[, options:Object] )\n Returns an iterator which returns indices for use indexing into an ndarray\n having a specified shape.\n"
0 commit comments