Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Sep 30, 2023
1 parent 46badaa commit 32df34b
Show file tree
Hide file tree
Showing 12 changed files with 13 additions and 8 deletions.
1 change: 1 addition & 0 deletions code-blocks/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3677,6 +3677,7 @@ ndarraySafeCasts,"var out = ndarraySafeCasts( 'float32' )\n"
ndarraySameKindCasts,"var out = ndarraySameKindCasts( 'float32' )\n"
ndempty,"var arr = ndempty( [ 2, 2 ] )\nvar sh = arr.shape\nvar dt = arr.dtype\n"
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"
ndslice,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] )\nx.shape\nvar s = new MultiSlice( null, 1 )\nvar y = ndslice( x, s )\ny.shape\nndarray2array( y )\n"
ndzeros,"var arr = ndzeros( [ 2, 2 ] )\nvar sh = arr.shape\nvar dt = arr.dtype\n"
ndzerosLike,"var x = base.ndzeros( 'float64', [ 2, 2 ], 'row-major' )\nvar sh = x.shape\nvar dt = x.dtype\nvar y = ndzerosLike( x )\nsh = y.shape\ndt = y.dtype\n"
nextGraphemeClusterBreak,"var out = nextGraphemeClusterBreak( 'last man standing', 4 )\nout = nextGraphemeClusterBreak( 'presidential election', 8 )\nout = nextGraphemeClusterBreak( 'अनुच्छेद', 1 )\nout = nextGraphemeClusterBreak( '🌷' )\n"
Expand Down
2 changes: 1 addition & 1 deletion code-blocks/data/data.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/index.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dist/index.js.map

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions help/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3678,6 +3678,7 @@ ndarraySameKindCasts,"\nndarraySameKindCasts( [dtype] )\n Returns a list of n
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"
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"
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\n"
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.\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"
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"
ndzerosLike,"\nndzerosLike( x[, options] )\n Returns a zero-filled 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 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 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 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 = ndzerosLike( x )\n <ndarray>\n > sh = y.shape\n [ 2, 2 ]\n > dt = y.dtype\n 'float64'\n\n See Also\n --------\n ndemptyLike, ndzeros\n"
nextGraphemeClusterBreak,"\nnextGraphemeClusterBreak( str[, fromIndex] )\n Returns the next extended grapheme cluster break in a string after a\n specified position.\n\n Parameters\n ----------\n str: string\n Input string.\n\n fromIndex: integer (optional)\n Position. Default: 0.\n\n Returns\n -------\n out: integer\n Next extended grapheme cluster break position.\n\n Examples\n --------\n > var out = nextGraphemeClusterBreak( 'last man standing', 4 )\n 5\n > out = nextGraphemeClusterBreak( 'presidential election', 8 )\n 9\n > out = nextGraphemeClusterBreak( 'अनुच्छेद', 1 )\n 3\n > out = nextGraphemeClusterBreak( '🌷' )\n -1\n\n See Also\n --------\n numGraphemeClusters, prevGraphemeClusterBreak"
Expand Down
2 changes: 1 addition & 1 deletion help/data/data.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions info/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3677,6 +3677,7 @@ ndarraySafeCasts,"\nndarraySafeCasts( [dtype:any] )\n Returns a list of ndarr
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"
ndempty,"\nndempty( shape:ArrayLikeObject<integer>|integer[, options:Object] )\n Returns an uninitialized ndarray having a specified shape and data type.\n"
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"
ndslice,"\nndslice( x:ndarray, ...s:MultiSlice|Slice|null|undefined|integer|ArrayLike[, \n options:Object] )\n Returns a read-only view of an input ndarray.\n"
ndzeros,"\nndzeros( shape:ArrayLikeObject<integer>|integer[, options:Object] )\n Returns a zero-filled ndarray having a specified shape and data type.\n"
ndzerosLike,"\nndzerosLike( x:ndarray[, options:Object] )\n Returns a zero-filled ndarray having the same shape and data type as a\n provided input ndarray.\n"
nextGraphemeClusterBreak,"\nnextGraphemeClusterBreak( str:string[, fromIndex:integer] )\n Returns the next extended grapheme cluster break in a string after a\n specified position.\n"
Expand Down
2 changes: 1 addition & 1 deletion info/data/data.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions signature/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3714,6 +3714,7 @@ ndarraySafeCasts,"ndarraySafeCasts( [dtype] )"
ndarraySameKindCasts,"ndarraySameKindCasts( [dtype] )"
ndempty,"ndempty( shape[, options] )"
ndemptyLike,"ndemptyLike( x[, options] )"
ndslice,"ndslice( x, ...s[, options] )"
ndzeros,"ndzeros( shape[, options] )"
ndzerosLike,"ndzerosLike( x[, options] )"
nextGraphemeClusterBreak,"nextGraphemeClusterBreak( str[, fromIndex] )"
Expand Down
2 changes: 1 addition & 1 deletion signature/data/data.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions typed-signature/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3714,6 +3714,7 @@ ndarraySafeCasts,"ndarraySafeCasts( [dtype:any] )"
ndarraySameKindCasts,"ndarraySameKindCasts( [dtype:any] )"
ndempty,"ndempty( shape:ArrayLikeObject<integer>|integer[, options:Object] )"
ndemptyLike,"ndemptyLike( x:ndarray[, options:Object] )"
ndslice,"ndslice( x:ndarray, ...s:MultiSlice|Slice|null|undefined|integer|ArrayLike[, options:Object] )"
ndzeros,"ndzeros( shape:ArrayLikeObject<integer>|integer[, options:Object] )"
ndzerosLike,"ndzerosLike( x:ndarray[, options:Object] )"
nextGraphemeClusterBreak,"nextGraphemeClusterBreak( str:string[, fromIndex:integer] )"
Expand Down
2 changes: 1 addition & 1 deletion typed-signature/data/data.json

Large diffs are not rendered by default.

0 comments on commit 32df34b

Please sign in to comment.