Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -4269,7 +4269,7 @@ ndarrayFlag,"\nndarrayFlag( x, name )\n Returns a specified flag for a provid
ndarrayFlags,"\nndarrayFlags( x )\n Returns the flags of a provided ndarray.\n\n Parameters\n ----------\n x: ndarray\n Input ndarray.\n\n Returns\n -------\n out: Object\n Flags.\n\n Examples\n --------\n > var out = ndarrayFlags( ndzeros( [ 3, 3, 3 ] ) )\n {...}\n\n See Also\n --------\n array, ndarray, ndarrayFlag\n"
ndarrayIndexModes,"\nndarrayIndexModes()\n Returns a list of ndarray index modes.\n\n The output array contains the following modes:\n\n - throw: specifies that a function should throw an error when an index is\n outside a restricted interval.\n - normalize: specifies that a function should normalize negative indices and\n throw an error when an index is outside a restricted interval.\n - wrap: specifies that a function should wrap around an index using modulo\n arithmetic.\n - clamp: specifies that a function should set an index less than zero to\n zero (minimum index) and set an index greater than a maximum index value to\n the maximum possible index.\n\n Returns\n -------\n out: Array<string>\n List of ndarray index modes.\n\n Examples\n --------\n > var out = ndarrayIndexModes()\n [ 'throw', 'normalize', 'clamp', 'wrap' ]\n\n See Also\n --------\n array, ndarray\n"
ndarraylike2ndarray,"\nndarraylike2ndarray( x[, options] )\n Converts an ndarray-like object to an ndarray.\n\n If provided a read-only ndarray, the function returns a read-only ndarray.\n\n Parameters\n ----------\n x: ndarrayLike\n Input ndarray-like object.\n\n options: Object (optional)\n Options.\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 'normalize', an ndarray instance\n normalizes negative indices and 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\n to 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 'normalize', an ndarray instance normalizes negative\n subscripts and throws an error when a subscript exceeds array\n dimensions. If equal to 'wrap', an ndarray instance wraps around\n subscripts exceeding array dimensions using modulo arithmetic. If equal\n to 'clamp', an ndarray instance sets a subscript exceeding array\n dimensions to either `0` (minimum index) or the maximum index. If the\n number of modes is fewer than the number of dimensions, the function\n recycles modes using modulo arithmetic. Default: [ options.mode ].\n\n options.readonly: boolean (optional)\n Boolean indicating whether an array should be read-only.\n\n Returns\n -------\n out: ndarray\n Output array.\n\n Examples\n --------\n > var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n > var out = ndarraylike2ndarray( arr )\n <ndarray>\n\n See Also\n --------\n array, ndarray, ndemptyLike, ndzerosLike\n"
ndarrayMinDataType,"\nndarrayMinDataType( value )\n Returns the minimum ndarray data type of the closest \"kind\" necessary for\n storing a provided scalar value.\n\n The function does *not* provide precision guarantees for non-integer-valued\n numbers. In other words, the function returns the smallest possible\n floating-point (i.e., inexact) data type for storing numbers having\n decimals.\n\n Parameters\n ----------\n value: any\n Scalar value.\n\n Returns\n -------\n dt: string\n ndarray data type.\n\n Examples\n --------\n > var dt = ndarrayMinDataType( 3.141592653589793 )\n 'float32'\n > dt = ndarrayMinDataType( 3 )\n 'uint8'\n > dt = ndarrayMinDataType( -3 )\n 'int8'\n > dt = ndarrayMinDataType( '-3' )\n 'generic'\n\n See Also\n --------\n ndarrayDataTypes, ndarrayPromotionRules, ndarraySafeCasts\n"
ndarrayMinDataType,"\nndarrayMinDataType( value )\n Returns the minimum ndarray data type of the closest \"kind\" necessary for\n storing a provided scalar value.\n\n The function does *not* provide precision guarantees for non-integer-valued\n numbers. In other words, the function returns the smallest possible\n floating-point (i.e., inexact) data type for storing numbers having\n decimals.\n\n Parameters\n ----------\n value: any\n Scalar value.\n\n Returns\n -------\n dt: string\n ndarray data type.\n\n Examples\n --------\n > var dt = ndarrayMinDataType( 3.141592653589793 )\n 'float16'\n > dt = ndarrayMinDataType( 3 )\n 'uint8'\n > dt = ndarrayMinDataType( -3 )\n 'int8'\n > dt = ndarrayMinDataType( '-3' )\n 'generic'\n\n See Also\n --------\n ndarrayDataTypes, ndarrayPromotionRules, ndarraySafeCasts\n"
ndarrayMostlySafeCasts,"\nndarrayMostlySafeCasts( [dtype] )\n Returns a list of ndarray data types to which a provided ndarray data type\n can be safely cast and, for floating-point data types, can be downcast.\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 cast.\n\n Examples\n --------\n > var out = ndarrayMostlySafeCasts( 'float32' )\n <Array>\n\n See Also\n --------\n ndarrayCastingModes, ndarrayDataTypes, ndarraySafeCasts, ndarraySameKindCasts\n"
ndarrayNextDataType,"\nndarrayNextDataType( [dtype] )\n Returns the next larger ndarray data type of the same kind.\n\n If not provided a data type, the function returns a table.\n\n If a data type does not have a next larger data type or the next larger type\n is not supported, the function returns `-1`.\n\n If provided an unrecognized 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|string|integer|null\n Next larger type(s).\n\n Examples\n --------\n > var out = ndarrayNextDataType( 'float32' )\n 'float64'\n\n See Also\n --------\n ndarrayDataTypes, ndarrayPromotionRules, ndarraySafeCasts\n"
ndarrayOffset,"\nndarrayOffset( x )\n Returns the index offset specifying the underlying buffer index of the first\n iterated ndarray element.\n\n Parameters\n ----------\n x: ndarray\n Input ndarray.\n\n Returns\n -------\n n: integer\n Index offset.\n\n Examples\n --------\n > var n = ndarrayOffset( ndzeros( [ 3, 3, 3 ] ) )\n 0\n\n See Also\n --------\n array, ndarray, ndarrayShape, ndarrayStrides\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.json

Large diffs are not rendered by default.

Loading