Skip to content

docs: update REPL namespace documentation #7353

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
Jun 14, 2025
Merged

docs: update REPL namespace documentation #7353

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
32 changes: 16 additions & 16 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.

92 changes: 46 additions & 46 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.

32 changes: 16 additions & 16 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 @@ -2012,10 +2012,10 @@ base.strided.dvariancewd,"\nbase.strided.dvariancewd( N:integer, correction:numb
base.strided.dvariancewd.ndarray,"\nbase.strided.dvariancewd.ndarray( N:integer, correction:number, x:Float64Array, \n strideX:integer, offsetX:integer )\n Computes the variance of a double-precision floating-point strided array\n using Welford's algorithm and alternative indexing semantics.\n"
base.strided.dvarianceyc,"\nbase.strided.dvarianceyc( N:integer, correction:number, x:Float64Array, \n strideX:integer )\n Computes the variance of a double-precision floating-point strided array\n using a one-pass algorithm proposed by Youngs and Cramer.\n"
base.strided.dvarianceyc.ndarray,"\nbase.strided.dvarianceyc.ndarray( N:integer, correction:number, x:Float64Array, \n strideX:integer, offsetX:integer )\n Computes the variance of a double-precision floating-point strided array\n using a one-pass algorithm proposed by Youngs and Cramer and alternative\n indexing semantics.\n"
base.strided.dvarm,"\nbase.strided.dvarm( N:integer, mean:number, correction:number, x:Float64Array, \n stride:integer )\n Computes the variance of a double-precision floating-point strided array\n provided a known mean.\n"
base.strided.dvarm.ndarray,"\nbase.strided.dvarm.ndarray( N:integer, mean:number, correction:number, \n x:Float64Array, stride:integer, offset:integer )\n Computes the variance of a double-precision floating-point strided array\n provided a known mean and using alternative indexing semantics.\n"
base.strided.dvarmpn,"\nbase.strided.dvarmpn( N:integer, mean:number, correction:number, \n x:Float64Array, stride:integer )\n Computes the variance of a double-precision floating-point strided array\n provided a known mean and using Neely's correction algorithm.\n"
base.strided.dvarmpn.ndarray,"\nbase.strided.dvarmpn.ndarray( N:integer, mean:number, correction:number, \n x:Float64Array, stride:integer, offset:integer )\n Computes the variance of a double-precision floating-point strided array\n provided a known mean and using Neely's correction algorithm and alternative\n indexing semantics.\n"
base.strided.dvarm,"\nbase.strided.dvarm( N:integer, mean:number, correction:number, x:Float64Array, \n strideX:integer )\n Computes the variance of a double-precision floating-point strided array\n provided a known mean.\n"
base.strided.dvarm.ndarray,"\nbase.strided.dvarm.ndarray( N:integer, mean:number, correction:number, \n x:Float64Array, strideX:integer, offsetX:integer )\n Computes the variance of a double-precision floating-point strided array\n provided a known mean and using alternative indexing semantics.\n"
base.strided.dvarmpn,"\nbase.strided.dvarmpn( N:integer, mean:number, correction:number, \n x:Float64Array, strideX:integer )\n Computes the variance of a double-precision floating-point strided array\n provided a known mean and using Neely's correction algorithm.\n"
base.strided.dvarmpn.ndarray,"\nbase.strided.dvarmpn.ndarray( N:integer, mean:number, correction:number, \n x:Float64Array, strideX:integer, offsetX:integer )\n Computes the variance of a double-precision floating-point strided array\n provided a known mean and using Neely's correction algorithm and alternative\n indexing semantics.\n"
base.strided.dvarmtk,"\nbase.strided.dvarmtk( N:integer, mean:number, correction:number, \n x:Float64Array, strideX:integer )\n Computes the variance of a double-precision floating-point strided array\n provided a known mean and using a one-pass textbook algorithm.\n"
base.strided.dvarmtk.ndarray,"\nbase.strided.dvarmtk.ndarray( N:integer, mean:number, correction:number, \n x:Float64Array, strideX:integer, offsetX:integer )\n Computes the variance of a double-precision floating-point strided array\n provided a known mean and using a one-pass textbook algorithm and\n alternative indexing semantics.\n"
base.strided.gapx,"\nbase.strided.gapx( N:integer, alpha:number, x:Array|TypedArray, \n strideX:integer )\n Adds a scalar constant to each element in a strided array.\n"
Expand Down Expand Up @@ -2189,8 +2189,8 @@ base.strided.nanstdevyc,"\nbase.strided.nanstdevyc( N:integer, correction:number
base.strided.nanstdevyc.ndarray,"\nbase.strided.nanstdevyc.ndarray( N:integer, correction:number, \n x:Array|TypedArray, stride:integer, offset:integer )\n Computes the standard deviation of a strided array ignoring `NaN` values and\n using a one-pass algorithm proposed by Youngs and Cramer and alternative\n indexing semantics.\n"
base.strided.nanvariance,"\nbase.strided.nanvariance( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the variance of a strided array ignoring `NaN` values.\n"
base.strided.nanvariance.ndarray,"\nbase.strided.nanvariance.ndarray( N:integer, correction:number, \n x:Array|TypedArray, stride:integer, offset:integer )\n Computes the variance of a strided array ignoring `NaN` values and using\n alternative indexing semantics.\n"
base.strided.nanvariancech,"\nbase.strided.nanvariancech( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the variance of a strided array ignoring `NaN` values and using a\n one-pass trial mean algorithm.\n"
base.strided.nanvariancech.ndarray,"\nbase.strided.nanvariancech.ndarray( N:integer, correction:number, \n x:Array|TypedArray, stride:integer, offset:integer )\n Computes the variance of a strided array ignoring `NaN` values and using a\n one-pass trial mean algorithm and alternative indexing semantics.\n"
base.strided.nanvariancech,"\nbase.strided.nanvariancech( N:integer, correction:number, x:Array|TypedArray, \n strideX:integer )\n Computes the variance of a strided array ignoring `NaN` values and using a\n one-pass trial mean algorithm.\n"
base.strided.nanvariancech.ndarray,"\nbase.strided.nanvariancech.ndarray( N:integer, correction:number, \n x:Array|TypedArray, strideX:integer, offsetX:integer )\n Computes the variance of a strided array ignoring `NaN` values and using a\n one-pass trial mean algorithm and alternative indexing semantics.\n"
base.strided.nanvariancepn,"\nbase.strided.nanvariancepn( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the variance of a strided array ignoring `NaN` values and using a\n two-pass algorithm.\n"
base.strided.nanvariancepn.ndarray,"\nbase.strided.nanvariancepn.ndarray( N:integer, correction:number, \n x:Array|TypedArray, stride:integer, offset:integer )\n Computes the variance of a strided array ignoring `NaN` values and using a\n two-pass algorithm and alternative indexing semantics.\n"
base.strided.nanvariancetk,"\nbase.strided.nanvariancetk( N:integer, correction:number, x:Array|TypedArray, \n strideX:integer )\n Computes the variance of a strided array ignoring `NaN` values and using a\n one-pass textbook algorithm.\n"
Expand Down Expand Up @@ -2471,12 +2471,12 @@ base.strided.ssumpw,"\nbase.strided.ssumpw( N:integer, x:Float32Array, strideX:i
base.strided.ssumpw.ndarray,"\nbase.strided.ssumpw.ndarray( N:integer, x:Float32Array, strideX:integer, \n offsetX:integer )\n Computes the sum of single-precision floating-point strided array elements\n using pairwise summation and alternative indexing semantics.\n"
base.strided.sswap,"\nbase.strided.sswap( N:integer, x:Float32Array, strideX:integer, y:Float32Array, \n strideY:integer )\n Interchanges two single-precision floating-point vectors.\n"
base.strided.sswap.ndarray,"\nbase.strided.sswap.ndarray( N:integer, x:Float32Array, strideX:integer, \n offsetX:integer, y:Float32Array, strideY:integer, offsetY:integer )\n Interchanges two single-precision floating-point vectors using alternative\n indexing semantics.\n"
base.strided.stdev,"\nbase.strided.stdev( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the standard deviation of a strided array.\n"
base.strided.stdev.ndarray,"\nbase.strided.stdev.ndarray( N:integer, correction:number, x:Array|TypedArray, \n stride:integer, offset:integer )\n Computes the standard deviation of a strided array using alternative\n indexing semantics.\n"
base.strided.stdevch,"\nbase.strided.stdevch( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the standard deviation of a strided array using a one-pass trial\n mean algorithm.\n"
base.strided.stdevch.ndarray,"\nbase.strided.stdevch.ndarray( N:integer, correction:number, x:Array|TypedArray, \n stride:integer, offset:integer )\n Computes the standard deviation of a strided array using a one-pass trial\n mean algorithm and alternative indexing semantics.\n"
base.strided.stdevpn,"\nbase.strided.stdevpn( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the standard deviation of a strided array using a two-pass\n algorithm.\n"
base.strided.stdevpn.ndarray,"\nbase.strided.stdevpn.ndarray( N:integer, correction:number, x:Array|TypedArray, \n stride:integer, offset:integer )\n Computes the standard deviation of a strided array using a two-pass\n algorithm and alternative indexing semantics.\n"
base.strided.stdev,"\nbase.strided.stdev( N:integer, correction:number, x:Array|TypedArray, \n strideX:integer )\n Computes the standard deviation of a strided array.\n"
base.strided.stdev.ndarray,"\nbase.strided.stdev.ndarray( N:integer, correction:number, x:Array|TypedArray, \n strideX:integer, offsetX:integer )\n Computes the standard deviation of a strided array using alternative\n indexing semantics.\n"
base.strided.stdevch,"\nbase.strided.stdevch( N:integer, correction:number, x:Array|TypedArray, \n strideX:integer )\n Computes the standard deviation of a strided array using a one-pass trial\n mean algorithm.\n"
base.strided.stdevch.ndarray,"\nbase.strided.stdevch.ndarray( N:integer, correction:number, x:Array|TypedArray, \n strideX:integer, offsetX:integer )\n Computes the standard deviation of a strided array using a one-pass trial\n mean algorithm and alternative indexing semantics.\n"
base.strided.stdevpn,"\nbase.strided.stdevpn( N:integer, correction:number, x:Array|TypedArray, \n strideX:integer )\n Computes the standard deviation of a strided array using a two-pass\n algorithm.\n"
base.strided.stdevpn.ndarray,"\nbase.strided.stdevpn.ndarray( N:integer, correction:number, x:Array|TypedArray, \n strideX:integer, offsetX:integer )\n Computes the standard deviation of a strided array using a two-pass\n algorithm and alternative indexing semantics.\n"
base.strided.stdevtk,"\nbase.strided.stdevtk( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the standard deviation of a strided array using a one-pass textbook\n algorithm.\n"
base.strided.stdevtk.ndarray,"\nbase.strided.stdevtk.ndarray( N:integer, correction:number, x:Array|TypedArray, \n stride:integer, offset:integer )\n Computes the standard deviation of a strided array using a one-pass textbook\n algorithm and alternative indexing semantics.\n"
base.strided.stdevwd,"\nbase.strided.stdevwd( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the standard deviation of a strided array using Welford's\n algorithm.\n"
Expand Down Expand Up @@ -2507,10 +2507,10 @@ base.strided.unaryDtypeSignatures,"\nbase.strided.unaryDtypeSignatures( dtypes1:
base.strided.unarySignatureCallbacks,"\nbase.strided.unarySignatureCallbacks( table:Object, signatures:ArrayLike<any> )\n Assigns callbacks to unary interfaces according to type promotion rules.\n"
base.strided.variance,"\nbase.strided.variance( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the variance of a strided array.\n"
base.strided.variance.ndarray,"\nbase.strided.variance.ndarray( N:integer, correction:number, \n x:Array|TypedArray, stride:integer, offset:integer )\n Computes the variance of a strided array using alternative indexing\n semantics.\n"
base.strided.variancech,"\nbase.strided.variancech( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the variance of a strided array using a one-pass trial mean\n algorithm.\n"
base.strided.variancech.ndarray,"\nbase.strided.variancech.ndarray( N:integer, correction:number, \n x:Array|TypedArray, stride:integer, offset:integer )\n Computes the variance of a strided array using a one-pass trial mean\n algorithm and alternative indexing semantics.\n"
base.strided.variancepn,"\nbase.strided.variancepn( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the variance of a strided array using a two-pass algorithm.\n"
base.strided.variancepn.ndarray,"\nbase.strided.variancepn.ndarray( N:integer, correction:number, \n x:Array|TypedArray, stride:integer, offset:integer )\n Computes the variance of a strided array using a two-pass algorithm and\n alternative indexing semantics.\n"
base.strided.variancech,"\nbase.strided.variancech( N:integer, correction:number, x:Array|TypedArray, \n strideX:integer )\n Computes the variance of a strided array using a one-pass trial mean\n algorithm.\n"
base.strided.variancech.ndarray,"\nbase.strided.variancech.ndarray( N:integer, correction:number, \n x:Array|TypedArray, strideX:integer, offsetX:integer )\n Computes the variance of a strided array using a one-pass trial mean\n algorithm and alternative indexing semantics.\n"
base.strided.variancepn,"\nbase.strided.variancepn( N:integer, correction:number, x:Array|TypedArray, \n strideX:integer )\n Computes the variance of a strided array using a two-pass algorithm.\n"
base.strided.variancepn.ndarray,"\nbase.strided.variancepn.ndarray( N:integer, correction:number, \n x:Array|TypedArray, strideX:integer, offsetX:integer )\n Computes the variance of a strided array using a two-pass algorithm and\n alternative indexing semantics.\n"
base.strided.variancetk,"\nbase.strided.variancetk( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the variance of a strided array using a one-pass textbook\n algorithm.\n"
base.strided.variancetk.ndarray,"\nbase.strided.variancetk.ndarray( N:integer, correction:number, \n x:Array|TypedArray, stride:integer, offset:integer )\n Computes the variance of a strided array using a one-pass textbook algorithm\n and alternative indexing semantics.\n"
base.strided.variancewd,"\nbase.strided.variancewd( N:integer, correction:number, x:Array|TypedArray, \n stride:integer )\n Computes the variance of a strided array using Welford's algorithm.\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.

32 changes: 16 additions & 16 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 @@ -2012,10 +2012,10 @@ base.strided.dvariancewd,"base.strided.dvariancewd( N, correction, x, strideX )"
base.strided.dvariancewd.ndarray,"base.strided.dvariancewd.ndarray( N, correction, x, strideX, offsetX )"
base.strided.dvarianceyc,"base.strided.dvarianceyc( N, correction, x, strideX )"
base.strided.dvarianceyc.ndarray,"base.strided.dvarianceyc.ndarray( N, correction, x, strideX, offsetX )"
base.strided.dvarm,"base.strided.dvarm( N, mean, correction, x, stride )"
base.strided.dvarm.ndarray,"base.strided.dvarm.ndarray( N, mean, correction, x, stride, offset )"
base.strided.dvarmpn,"base.strided.dvarmpn( N, mean, correction, x, stride )"
base.strided.dvarmpn.ndarray,"base.strided.dvarmpn.ndarray( N, mean, correction, x, stride, offset )"
base.strided.dvarm,"base.strided.dvarm( N, mean, correction, x, strideX )"
base.strided.dvarm.ndarray,"base.strided.dvarm.ndarray( N, mean, correction, x, strideX, offsetX )"
base.strided.dvarmpn,"base.strided.dvarmpn( N, mean, correction, x, strideX )"
base.strided.dvarmpn.ndarray,"base.strided.dvarmpn.ndarray( N, mean, correction, x, strideX, offsetX )"
base.strided.dvarmtk,"base.strided.dvarmtk( N, mean, correction, x, strideX )"
base.strided.dvarmtk.ndarray,"base.strided.dvarmtk.ndarray( N, mean, correction, x, strideX, offsetX )"
base.strided.gapx,"base.strided.gapx( N, alpha, x, strideX )"
Expand Down Expand Up @@ -2189,8 +2189,8 @@ base.strided.nanstdevyc,"base.strided.nanstdevyc( N, correction, x, stride )"
base.strided.nanstdevyc.ndarray,"base.strided.nanstdevyc.ndarray( N, correction, x, stride, offset )"
base.strided.nanvariance,"base.strided.nanvariance( N, correction, x, stride )"
base.strided.nanvariance.ndarray,"base.strided.nanvariance.ndarray( N, correction, x, stride, offset )"
base.strided.nanvariancech,"base.strided.nanvariancech( N, correction, x, stride )"
base.strided.nanvariancech.ndarray,"base.strided.nanvariancech.ndarray( N, correction, x, stride, offset )"
base.strided.nanvariancech,"base.strided.nanvariancech( N, correction, x, strideX )"
base.strided.nanvariancech.ndarray,"base.strided.nanvariancech.ndarray( N, correction, x, strideX, offsetX )"
base.strided.nanvariancepn,"base.strided.nanvariancepn( N, correction, x, stride )"
base.strided.nanvariancepn.ndarray,"base.strided.nanvariancepn.ndarray( N, correction, x, stride, offset )"
base.strided.nanvariancetk,"base.strided.nanvariancetk( N, correction, x, strideX )"
Expand Down Expand Up @@ -2471,12 +2471,12 @@ base.strided.ssumpw,"base.strided.ssumpw( N, x, strideX )"
base.strided.ssumpw.ndarray,"base.strided.ssumpw.ndarray( N, x, strideX, offsetX )"
base.strided.sswap,"base.strided.sswap( N, x, strideX, y, strideY )"
base.strided.sswap.ndarray,"base.strided.sswap.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )"
base.strided.stdev,"base.strided.stdev( N, correction, x, stride )"
base.strided.stdev.ndarray,"base.strided.stdev.ndarray( N, correction, x, stride, offset )"
base.strided.stdevch,"base.strided.stdevch( N, correction, x, stride )"
base.strided.stdevch.ndarray,"base.strided.stdevch.ndarray( N, correction, x, stride, offset )"
base.strided.stdevpn,"base.strided.stdevpn( N, correction, x, stride )"
base.strided.stdevpn.ndarray,"base.strided.stdevpn.ndarray( N, correction, x, stride, offset )"
base.strided.stdev,"base.strided.stdev( N, correction, x, strideX )"
base.strided.stdev.ndarray,"base.strided.stdev.ndarray( N, correction, x, strideX, offsetX )"
base.strided.stdevch,"base.strided.stdevch( N, correction, x, strideX )"
base.strided.stdevch.ndarray,"base.strided.stdevch.ndarray( N, correction, x, strideX, offsetX )"
base.strided.stdevpn,"base.strided.stdevpn( N, correction, x, strideX )"
base.strided.stdevpn.ndarray,"base.strided.stdevpn.ndarray( N, correction, x, strideX, offsetX )"
base.strided.stdevtk,"base.strided.stdevtk( N, correction, x, stride )"
base.strided.stdevtk.ndarray,"base.strided.stdevtk.ndarray( N, correction, x, stride, offset )"
base.strided.stdevwd,"base.strided.stdevwd( N, correction, x, stride )"
Expand Down Expand Up @@ -2507,10 +2507,10 @@ base.strided.unaryDtypeSignatures,"base.strided.unaryDtypeSignatures( dtypes1, d
base.strided.unarySignatureCallbacks,"base.strided.unarySignatureCallbacks( table, signatures )"
base.strided.variance,"base.strided.variance( N, correction, x, stride )"
base.strided.variance.ndarray,"base.strided.variance.ndarray( N, correction, x, stride, offset )"
base.strided.variancech,"base.strided.variancech( N, correction, x, stride )"
base.strided.variancech.ndarray,"base.strided.variancech.ndarray( N, correction, x, stride, offset )"
base.strided.variancepn,"base.strided.variancepn( N, correction, x, stride )"
base.strided.variancepn.ndarray,"base.strided.variancepn.ndarray( N, correction, x, stride, offset )"
base.strided.variancech,"base.strided.variancech( N, correction, x, strideX )"
base.strided.variancech.ndarray,"base.strided.variancech.ndarray( N, correction, x, strideX, offsetX )"
base.strided.variancepn,"base.strided.variancepn( N, correction, x, strideX )"
base.strided.variancepn.ndarray,"base.strided.variancepn.ndarray( N, correction, x, strideX, offsetX )"
base.strided.variancetk,"base.strided.variancetk( N, correction, x, stride )"
base.strided.variancetk.ndarray,"base.strided.variancetk.ndarray( N, correction, x, stride, offset )"
base.strided.variancewd,"base.strided.variancewd( N, correction, x, stride )"
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.

Loading