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
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
@@ -3679,6 +3679,7 @@ ndarraySafeCasts,"\nndarraySafeCasts( [dtype] )\n Returns a list of ndarray d
3679
3679
ndarraySameKindCasts,"\nndarraySameKindCasts( [dtype] )\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\n If not provided an ndarray data type, the function returns a casting table.\n\n If provided an unrecognized ndarray data type, the function returns `null`.\n\n Parameters\n ----------\n dtype: any (optional)\n ndarray data type value.\n\n Returns\n -------\n out: Object|Array<string>|null\n ndarray data types to which a data type can be safely cast or cast\n within the same \"kind\".\n\n Examples\n --------\n > var out = ndarraySameKindCasts( 'float32' )\n <Array>\n\n See Also\n --------\n ndarrayCastingModes, ndarrayDataTypes, ndarraySafeCasts\n"
3680
3680
ndempty,"\nndempty( shape[, options] )\n Returns an uninitialized ndarray having a specified shape and data type.\n\n In browser environments, the function always returns zero-filled ndarrays.\n\n If `dtype` is 'generic', the function always returns a zero-filled ndarray.\n\n For returned ndarrays whose underlying memory is *not* initialized, memory\n contents are unknown and may contain *sensitive* data.\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 Returns\n -------\n out: ndarray\n Output array.\n\n Examples\n --------\n > var arr = ndempty( [ 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 ndemptyLike, ndzeros\n"
3681
3681
ndemptyLike,"\nndemptyLike( x[, options] )\n Returns an uninitialized ndarray having the same shape and data type as a\n provided input ndarray.\n\n The function infers the following attributes from the input array:\n\n - shape: array shape.\n - dtype: underlying array data type.\n - order: whether the array order is row-major (C-style) or column-major\n (Fortran-style).\n\n In browser environments, the function always returns zero-filled ndarrays.\n\n If `dtype` is 'generic', the function always returns a zero-filled ndarray.\n\n For returned ndarrays whose underlying memory is *not* initialized, memory\n contents are unknown and may contain *sensitive* data.\n\n Parameters\n ----------\n x: ndarray\n Input array.\n\n options: Object (optional)\n Options.\n\n options.shape: ArrayLikeObject<integer>|integer (optional)\n Array shape. Overrides the input array's inferred shape.\n\n options.dtype: string (optional)\n Array data type. Overrides the input array's inferred data type.\n\n options.order: string (optional)\n Array order (either 'row-major' (C-style) or 'column-major' (Fortran-\n style)). Overrides the input array's inferred order.\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 out: ndarray\n Output array.\n\n Examples\n --------\n > var x = base.ndzeros( 'float64', [ 2, 2 ], 'row-major' )\n <ndarray>\n > var sh = x.shape\n [ 2, 2 ]\n > var dt = x.dtype\n 'float64'\n > var y = ndemptyLike( x )\n <ndarray>\n > sh = y.shape\n [ 2, 2 ]\n > dt = y.dtype\n 'float64'\n\n See Also\n --------\n ndempty, ndzerosLike\n"
3682
+
ndims,"\nndims( x )\n Returns the number of ndarray dimensions.\n\n Parameters\n ----------\n x: ndarray\n Input ndarray.\n\n Returns\n -------\n n: integer\n Number of dimensions.\n\n Examples\n --------\n > var n = ndims( ndzeros( [ 3, 3, 3 ] ) )\n 3\n\n See Also\n --------\n array, ndarray, numel\n"
3682
3683
nditerColumns,"\nnditerColumns( x[, options] )\n Returns an iterator which iterates over each column 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 = nditerColumns( x );\n > var v = it.next().value;\n > ndarray2array( v )\n [ 1, 3 ]\n > v = it.next().value;\n > ndarray2array( v )\n [ 2, 4 ]\n\n See Also\n --------\n nditerRows, ndslice\n"
3683
3684
nditerEntries,"\nnditerEntries( x[, options] )\n Returns an iterator which returns [index, value] pairs for each element in a\n provided ndarray.\n\n Each returned index is a Cartesian index (i.e., an array of subscripts/\n dimension indices).\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 = nditerEntries( x );\n > var v = it.next().value\n [ [ 0, 0 ], 1 ]\n > v = it.next().value\n [ [ 0, 1 ], 2 ]\n\n See Also\n --------\n ndarray, nditerIndices, nditerValues\n"
3684
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"
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
@@ -3712,6 +3712,7 @@ now,"\nnow()\n Returns the time in seconds since the epoch.\n"
3712
3712
NUM_CPUS,"\nNUM_CPUS\n Number of CPUs.\n"
3713
3713
num2words,"\nnum2words( value:integer[, options:Object] )\n Converts a number to a word representation.\n"
3714
3714
Number,"\nNumber( value:number )\n Returns a Number object.\n"
3715
+
numel,"\nnumel( x:ndarray )\n Returns the number of elements in an ndarray.\n"
3715
3716
numGraphemeClusters,"\nnumGraphemeClusters( str:string )\n Returns the number of grapheme clusters in a string.\n"
3716
3717
Object,"\nObject( value:any )\n Returns an object.\n"
3717
3718
Object.assign,"\nObject.assign( target:Object, ...sources:Object )\n Assigns enumerable and own properties from source objects to a target\n object.\n"
0 commit comments