Skip to content

docs: update REPL namespace documentation #4692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 11, 2025
Merged

docs: update REPL namespace documentation #4692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/code-blocks/data/data.json
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions lib/node_modules/@stdlib/repl/help/data/data.csv
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.json
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions lib/node_modules/@stdlib/repl/info/data/data.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1906,8 +1906,8 @@ base.strided.dsempn,"\nbase.strided.dsempn( N:integer, correction:number, x:Floa
base.strided.dsempn.ndarray,"\nbase.strided.dsempn.ndarray( N:integer, correction:number, x:Float64Array, \n stride:integer, offset:integer )\n Computes the standard error of the mean for a double-precision floating-\n point strided array using a two-pass algorithm and alternative indexing\n semantics.\n"
base.strided.dsemtk,"\nbase.strided.dsemtk( N:integer, correction:number, x:Float64Array, \n stride:integer )\n Computes the standard error of the mean for a double-precision floating-\n point strided array using a one-pass textbook algorithm.\n"
base.strided.dsemtk.ndarray,"\nbase.strided.dsemtk.ndarray( N:integer, correction:number, x:Float64Array, \n stride:integer, offset:integer )\n Computes the standard error of the mean for a double-precision floating-\n point strided array using a one-pass textbook algorithm and alternative\n indexing semantics.\n"
base.strided.dsemwd,"\nbase.strided.dsemwd( N:integer, correction:number, x:Float64Array, \n stride:integer )\n Computes the standard error of the mean for a double-precision floating-\n point strided array using Welford's algorithm.\n"
base.strided.dsemwd.ndarray,"\nbase.strided.dsemwd.ndarray( N:integer, correction:number, x:Float64Array, \n stride:integer, offset:integer )\n Computes the standard error of the mean for a double-precision floating-\n point strided array using Welford's algorithm and alternative indexing\n semantics.\n"
base.strided.dsemwd,"\nbase.strided.dsemwd( N:integer, correction:number, x:Float64Array, \n strideX:integer )\n Computes the standard error of the mean for a double-precision floating-\n point strided array using Welford's algorithm.\n"
base.strided.dsemwd.ndarray,"\nbase.strided.dsemwd.ndarray( N:integer, correction:number, x:Float64Array, \n strideX:integer, offsetX:integer )\n Computes the standard error of the mean for a double-precision floating-\n point strided array using Welford's algorithm and alternative indexing\n semantics.\n"
base.strided.dsemyc,"\nbase.strided.dsemyc( N:integer, correction:number, x:Float64Array, \n stride:integer )\n Computes the standard error of the mean for a double-precision floating-\n point strided array using a one-pass algorithm proposed by Youngs and\n Cramer.\n"
base.strided.dsemyc.ndarray,"\nbase.strided.dsemyc.ndarray( N:integer, correction:number, x:Float64Array, \n stride:integer, offset:integer )\n Computes the standard error of the mean for a double-precision floating-\n point strided array using a one-pass algorithm proposed by Youngs and Cramer\n and alternative indexing semantics.\n"
base.strided.dsmean,"\nbase.strided.dsmean( N:integer, x:Float32Array, stride:integer )\n Computes the arithmetic mean of a single-precision floating-point strided\n array using extended accumulation and returning an extended precision\n result.\n"
Expand Down Expand Up @@ -2078,12 +2078,12 @@ base.strided.gsum,"\nbase.strided.gsum( N:integer, x:Array|TypedArray, stride:in
base.strided.gsum.ndarray,"\nbase.strided.gsum.ndarray( N:integer, x:Array|TypedArray, stride:integer, \n offset:integer )\n Computes the sum of strided array elements using alternative indexing\n semantics.\n"
base.strided.gsumkbn,"\nbase.strided.gsumkbn( N:integer, x:Array|TypedArray, stride:integer )\n Computes the sum of strided array elements using an improved Kahan–Babuška\n algorithm.\n"
base.strided.gsumkbn.ndarray,"\nbase.strided.gsumkbn.ndarray( N:integer, x:Array|TypedArray, stride:integer, \n offset:integer )\n Computes the sum of strided array elements using an improved Kahan–Babuška\n algorithm and alternative indexing semantics.\n"
base.strided.gsumkbn2,"\nbase.strided.gsumkbn2( N:integer, x:Array|TypedArray, stride:integer )\n Computes the sum of strided array elements using a second-order iterative\n Kahan–Babuška algorithm.\n"
base.strided.gsumkbn2.ndarray,"\nbase.strided.gsumkbn2.ndarray( N:integer, x:Array|TypedArray, stride:integer, \n offset:integer )\n Computes the sum of strided array elements using a second-order iterative\n Kahan–Babuška algorithm and alternative indexing semantics.\n"
base.strided.gsumors,"\nbase.strided.gsumors( N:integer, x:Array|TypedArray, stride:integer )\n Computes the sum of strided array elements using ordinary recursive\n summation.\n"
base.strided.gsumors.ndarray,"\nbase.strided.gsumors.ndarray( N:integer, x:Array|TypedArray, stride:integer, \n offset:integer )\n Computes the sum of strided array elements using ordinary recursive\n summation and alternative indexing semantics.\n"
base.strided.gsumpw,"\nbase.strided.gsumpw( N:integer, x:Array|TypedArray, stride:integer )\n Computes the sum of strided array elements using pairwise summation.\n"
base.strided.gsumpw.ndarray,"\nbase.strided.gsumpw.ndarray( N:integer, x:Array|TypedArray, stride:integer, \n offset:integer )\n Computes the sum of strided array elements using pairwise summation and\n alternative indexing semantics.\n"
base.strided.gsumkbn2,"\nbase.strided.gsumkbn2( N:integer, x:Array|TypedArray, strideX:integer )\n Computes the sum of strided array elements using a second-order iterative\n Kahan–Babuška algorithm.\n"
base.strided.gsumkbn2.ndarray,"\nbase.strided.gsumkbn2.ndarray( N:integer, x:Array|TypedArray, strideX:integer, \n offsetX:integer )\n Computes the sum of strided array elements using a second-order iterative\n Kahan–Babuška algorithm and alternative indexing semantics.\n"
base.strided.gsumors,"\nbase.strided.gsumors( N:integer, x:Array|TypedArray, strideX:integer )\n Computes the sum of strided array elements using ordinary recursive\n summation.\n"
base.strided.gsumors.ndarray,"\nbase.strided.gsumors.ndarray( N:integer, x:Array|TypedArray, strideX:integer, \n offsetX:integer )\n Computes the sum of strided array elements using ordinary recursive\n summation and alternative indexing semantics.\n"
base.strided.gsumpw,"\nbase.strided.gsumpw( N:integer, x:Array|TypedArray, strideX:integer )\n Computes the sum of strided array elements using pairwise summation.\n"
base.strided.gsumpw.ndarray,"\nbase.strided.gsumpw.ndarray( N:integer, x:Array|TypedArray, strideX:integer, \n offsetX:integer )\n Computes the sum of strided array elements using pairwise summation and\n alternative indexing semantics.\n"
base.strided.gswap,"\nbase.strided.gswap( N:integer, x:ArrayLikeObject, strideX:integer, \n y:ArrayLikeObject, strideY:integer )\n Interchanges vectors `x` and `y`.\n"
base.strided.gswap.ndarray,"\nbase.strided.gswap.ndarray( N:integer, x:ArrayLikeObject, strideX:integer, \n offsetX:integer, y:ArrayLikeObject, strideY:integer, offsetY:integer )\n Interchanges vectors `x` and `y` using alternative indexing semantics.\n"
base.strided.mapBy,"\nbase.strided.mapBy( N:integer, x:Array|TypedArray|Object, sx:integer, \n y:Array|TypedArray|Object, sy:integer, fcn:Function, clbk:Function[, \n thisArg:any] )\n Applies a unary function to each element retrieved from a strided input\n array according to a callback function and assigns results to a strided\n output array.\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/info/data/data.json
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions lib/node_modules/@stdlib/repl/signature/data/data.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1907,8 +1907,8 @@ base.strided.dsempn,"base.strided.dsempn( N, correction, x, stride )"
base.strided.dsempn.ndarray,"base.strided.dsempn.ndarray( N, correction, x, stride, offset )"
base.strided.dsemtk,"base.strided.dsemtk( N, correction, x, stride )"
base.strided.dsemtk.ndarray,"base.strided.dsemtk.ndarray( N, correction, x, stride, offset )"
base.strided.dsemwd,"base.strided.dsemwd( N, correction, x, stride )"
base.strided.dsemwd.ndarray,"base.strided.dsemwd.ndarray( N, correction, x, stride, offset )"
base.strided.dsemwd,"base.strided.dsemwd( N, correction, x, strideX )"
base.strided.dsemwd.ndarray,"base.strided.dsemwd.ndarray( N, correction, x, strideX, offsetX )"
base.strided.dsemyc,"base.strided.dsemyc( N, correction, x, stride )"
base.strided.dsemyc.ndarray,"base.strided.dsemyc.ndarray( N, correction, x, stride, offset )"
base.strided.dsmean,"base.strided.dsmean( N, x, stride )"
Expand Down Expand Up @@ -2079,12 +2079,12 @@ base.strided.gsum,"base.strided.gsum( N, x, stride )"
base.strided.gsum.ndarray,"base.strided.gsum.ndarray( N, x, stride, offset )"
base.strided.gsumkbn,"base.strided.gsumkbn( N, x, stride )"
base.strided.gsumkbn.ndarray,"base.strided.gsumkbn.ndarray( N, x, stride, offset )"
base.strided.gsumkbn2,"base.strided.gsumkbn2( N, x, stride )"
base.strided.gsumkbn2.ndarray,"base.strided.gsumkbn2.ndarray( N, x, stride, offset )"
base.strided.gsumors,"base.strided.gsumors( N, x, stride )"
base.strided.gsumors.ndarray,"base.strided.gsumors.ndarray( N, x, stride, offset )"
base.strided.gsumpw,"base.strided.gsumpw( N, x, stride )"
base.strided.gsumpw.ndarray,"base.strided.gsumpw.ndarray( N, x, stride, offset )"
base.strided.gsumkbn2,"base.strided.gsumkbn2( N, x, strideX )"
base.strided.gsumkbn2.ndarray,"base.strided.gsumkbn2.ndarray( N, x, strideX, offsetX )"
base.strided.gsumors,"base.strided.gsumors( N, x, strideX )"
base.strided.gsumors.ndarray,"base.strided.gsumors.ndarray( N, x, strideX, offsetX )"
base.strided.gsumpw,"base.strided.gsumpw( N, x, strideX )"
base.strided.gsumpw.ndarray,"base.strided.gsumpw.ndarray( N, x, strideX, offsetX )"
base.strided.gswap,"base.strided.gswap( N, x, strideX, y, strideY )"
base.strided.gswap.ndarray,"base.strided.gswap.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )"
base.strided.mapBy,"base.strided.mapBy( N, x, sx, y, sy, fcn, clbk[, thisArg] )"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/signature/data/data.json
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions lib/node_modules/@stdlib/repl/typed-signature/data/data.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1907,8 +1907,8 @@ base.strided.dsempn,"base.strided.dsempn( N:integer, correction:number, x:Float6
base.strided.dsempn.ndarray,"base.strided.dsempn.ndarray( N:integer, correction:number, x:Float64Array, stride:integer, offset:integer )"
base.strided.dsemtk,"base.strided.dsemtk( N:integer, correction:number, x:Float64Array, stride:integer )"
base.strided.dsemtk.ndarray,"base.strided.dsemtk.ndarray( N:integer, correction:number, x:Float64Array, stride:integer, offset:integer )"
base.strided.dsemwd,"base.strided.dsemwd( N:integer, correction:number, x:Float64Array, stride:integer )"
base.strided.dsemwd.ndarray,"base.strided.dsemwd.ndarray( N:integer, correction:number, x:Float64Array, stride:integer, offset:integer )"
base.strided.dsemwd,"base.strided.dsemwd( N:integer, correction:number, x:Float64Array, strideX:integer )"
base.strided.dsemwd.ndarray,"base.strided.dsemwd.ndarray( N:integer, correction:number, x:Float64Array, strideX:integer, offsetX:integer )"
base.strided.dsemyc,"base.strided.dsemyc( N:integer, correction:number, x:Float64Array, stride:integer )"
base.strided.dsemyc.ndarray,"base.strided.dsemyc.ndarray( N:integer, correction:number, x:Float64Array, stride:integer, offset:integer )"
base.strided.dsmean,"base.strided.dsmean( N:integer, x:Float32Array, stride:integer )"
Expand Down Expand Up @@ -2079,12 +2079,12 @@ base.strided.gsum,"base.strided.gsum( N:integer, x:Array|TypedArray, stride:inte
base.strided.gsum.ndarray,"base.strided.gsum.ndarray( N:integer, x:Array|TypedArray, stride:integer, offset:integer )"
base.strided.gsumkbn,"base.strided.gsumkbn( N:integer, x:Array|TypedArray, stride:integer )"
base.strided.gsumkbn.ndarray,"base.strided.gsumkbn.ndarray( N:integer, x:Array|TypedArray, stride:integer, offset:integer )"
base.strided.gsumkbn2,"base.strided.gsumkbn2( N:integer, x:Array|TypedArray, stride:integer )"
base.strided.gsumkbn2.ndarray,"base.strided.gsumkbn2.ndarray( N:integer, x:Array|TypedArray, stride:integer, offset:integer )"
base.strided.gsumors,"base.strided.gsumors( N:integer, x:Array|TypedArray, stride:integer )"
base.strided.gsumors.ndarray,"base.strided.gsumors.ndarray( N:integer, x:Array|TypedArray, stride:integer, offset:integer )"
base.strided.gsumpw,"base.strided.gsumpw( N:integer, x:Array|TypedArray, stride:integer )"
base.strided.gsumpw.ndarray,"base.strided.gsumpw.ndarray( N:integer, x:Array|TypedArray, stride:integer, offset:integer )"
base.strided.gsumkbn2,"base.strided.gsumkbn2( N:integer, x:Array|TypedArray, strideX:integer )"
base.strided.gsumkbn2.ndarray,"base.strided.gsumkbn2.ndarray( N:integer, x:Array|TypedArray, strideX:integer, offsetX:integer )"
base.strided.gsumors,"base.strided.gsumors( N:integer, x:Array|TypedArray, strideX:integer )"
base.strided.gsumors.ndarray,"base.strided.gsumors.ndarray( N:integer, x:Array|TypedArray, strideX:integer, offsetX:integer )"
base.strided.gsumpw,"base.strided.gsumpw( N:integer, x:Array|TypedArray, strideX:integer )"
base.strided.gsumpw.ndarray,"base.strided.gsumpw.ndarray( N:integer, x:Array|TypedArray, strideX:integer, offsetX:integer )"
base.strided.gswap,"base.strided.gswap( N:integer, x:ArrayLikeObject, strideX:integer, y:ArrayLikeObject, strideY:integer )"
base.strided.gswap.ndarray,"base.strided.gswap.ndarray( N:integer, x:ArrayLikeObject, strideX:integer, offsetX:integer, y:ArrayLikeObject, strideY:integer, offsetY:integer )"
base.strided.mapBy,"base.strided.mapBy( N:integer, x:Array|TypedArray|Object, sx:integer, y:Array|TypedArray|Object, sy:integer, fcn:Function, clbk:Function[, thisArg:any] )"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/typed-signature/data/data.json
View file
Open in desktop

Large diffs are not rendered by default.

Loading