Skip to content

Commit

Permalink
docs: update REPL namespace documentation
Browse files Browse the repository at this point in the history 
PR-URL: #5050
Reviewed-by: Athan Reines <[email protected]>
  • Loading branch information
@stdlib-bot
stdlib-bot authored Feb 4, 2025
1 parent fc72bf5 commit 6c52481
Show file tree
Hide file tree
Showing 10 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1998,8 +1998,8 @@ base.strided.dvariance,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.st
base.strided.dvariance.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dvariance.ndarray( x.length, 1, x, 1, 0 )\nvar x = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nvar N = base.floor( x.length / 2 );\nbase.strided.dvariance.ndarray( N, 1, x, 2, 1 )\n"
base.strided.dvariancech,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dvariancech( x.length, 1, x, 1 )\nx = new Float64Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );\nbase.strided.dvariancech( 3, 1, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.dvariancech( 3, 1, x1, 2 )\n"
base.strided.dvariancech.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dvariancech.ndarray( x.length, 1, x, 1, 0 )\nvar x = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nbase.strided.dvariancech.ndarray( 3, 1, x, 2, 1 )\n"
base.strided.dvariancepn,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dvariancepn( x.length, 1, x, 1 )\nx = new Float64Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );\nvar N = base.floor( x.length / 2 );\nvar stride = 2;\nbase.strided.dvariancepn( N, 1, x, stride )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nN = base.floor( x0.length / 2 );\nstride = 2;\nbase.strided.dvariancepn( N, 1, x1, stride )\n"
base.strided.dvariancepn.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dvariancepn.ndarray( x.length, 1, x, 1, 0 )\nvar x = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nvar N = base.floor( x.length / 2 );\nbase.strided.dvariancepn.ndarray( N, 1, x, 2, 1 )\n"
base.strided.dvariancepn,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dvariancepn( x.length, 1, x, 1 )\nx = new Float64Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );\nbase.strided.dvariancepn( 3, 1, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.dvariancepn( 3, 1, x1, 2 )\n"
base.strided.dvariancepn.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dvariancepn.ndarray( x.length, 1, x, 1, 0 )\nvar x = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nbase.strided.dvariancepn.ndarray( 3, 1, x, 2, 1 )\n"
base.strided.dvariancetk,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dvariancetk( x.length, 1, x, 1 )\nx = new Float64Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );\nbase.strided.dvariancetk( 3, 1, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.dvariancetk( 3, 1, x1, 2 )\n"
base.strided.dvariancetk.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dvariancetk.ndarray( x.length, 1, x, 1, 0 )\nvar x = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nbase.strided.dvariancetk.ndarray( 3, 1, x, 2, 1 )\n"
base.strided.dvariancewd,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dvariancewd( x.length, 1, x, 1 )\nx = new Float64Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );\nbase.strided.dvariancewd( 3, 1, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.dvariancewd( 3, 1, x1, 2 )\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/code-blocks/data/data.json
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/repl/help/data/data.csv
View file

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/repl/info/data/data.csv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1998,8 +1998,8 @@ base.strided.dvariance,"\nbase.strided.dvariance( N:integer, correction:number,
base.strided.dvariance.ndarray,"\nbase.strided.dvariance.ndarray( N:integer, correction:number, x:Float64Array, \n stride:integer, offset:integer )\n Computes the variance of a double-precision floating-point strided array\n using alternative indexing semantics.\n"
base.strided.dvariancech,"\nbase.strided.dvariancech( 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 trial mean algorithm.\n"
base.strided.dvariancech.ndarray,"\nbase.strided.dvariancech.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 trial mean algorithm and alternative indexing semantics.\n"
base.strided.dvariancepn,"\nbase.strided.dvariancepn( N:integer, correction:number, x:Float64Array, \n stride:integer )\n Computes the variance of a double-precision floating-point strided array\n using a two-pass algorithm.\n"
base.strided.dvariancepn.ndarray,"\nbase.strided.dvariancepn.ndarray( N:integer, correction:number, x:Float64Array, \n stride:integer, offset:integer )\n Computes the variance of a double-precision floating-point strided array\n using a two-pass algorithm and alternative indexing semantics.\n"
base.strided.dvariancepn,"\nbase.strided.dvariancepn( N:integer, correction:number, x:Float64Array, \n strideX:integer )\n Computes the variance of a double-precision floating-point strided array\n using a two-pass algorithm.\n"
base.strided.dvariancepn.ndarray,"\nbase.strided.dvariancepn.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 two-pass algorithm and alternative indexing semantics.\n"
base.strided.dvariancetk,"\nbase.strided.dvariancetk( 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 textbook algorithm.\n"
base.strided.dvariancetk.ndarray,"\nbase.strided.dvariancetk.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 textbook algorithm and alternative indexing semantics.\n"
base.strided.dvariancewd,"\nbase.strided.dvariancewd( N:integer, correction:number, x:Float64Array, \n strideX:integer )\n Computes the variance of a double-precision floating-point strided array\n using Welford's algorithm.\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/info/data/data.json
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/repl/signature/data/data.csv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1999,8 +1999,8 @@ base.strided.dvariance,"base.strided.dvariance( N, correction, x, stride )"
base.strided.dvariance.ndarray,"base.strided.dvariance.ndarray( N, correction, x, stride, offset )"
base.strided.dvariancech,"base.strided.dvariancech( N, correction, x, strideX )"
base.strided.dvariancech.ndarray,"base.strided.dvariancech.ndarray( N, correction, x, strideX, offsetX )"
base.strided.dvariancepn,"base.strided.dvariancepn( N, correction, x, stride )"
base.strided.dvariancepn.ndarray,"base.strided.dvariancepn.ndarray( N, correction, x, stride, offset )"
base.strided.dvariancepn,"base.strided.dvariancepn( N, correction, x, strideX )"
base.strided.dvariancepn.ndarray,"base.strided.dvariancepn.ndarray( N, correction, x, strideX, offsetX )"
base.strided.dvariancetk,"base.strided.dvariancetk( N, correction, x, strideX )"
base.strided.dvariancetk.ndarray,"base.strided.dvariancetk.ndarray( N, correction, x, strideX, offsetX )"
base.strided.dvariancewd,"base.strided.dvariancewd( N, correction, x, strideX )"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/signature/data/data.json
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/repl/typed-signature/data/data.csv
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1999,8 +1999,8 @@ base.strided.dvariance,"base.strided.dvariance( N:integer, correction:number, x:
base.strided.dvariance.ndarray,"base.strided.dvariance.ndarray( N:integer, correction:number, x:Float64Array, stride:integer, offset:integer )"
base.strided.dvariancech,"base.strided.dvariancech( N:integer, correction:number, x:Float64Array, strideX:integer )"
base.strided.dvariancech.ndarray,"base.strided.dvariancech.ndarray( N:integer, correction:number, x:Float64Array, strideX:integer, offsetX:integer )"
base.strided.dvariancepn,"base.strided.dvariancepn( N:integer, correction:number, x:Float64Array, stride:integer )"
base.strided.dvariancepn.ndarray,"base.strided.dvariancepn.ndarray( N:integer, correction:number, x:Float64Array, stride:integer, offset:integer )"
base.strided.dvariancepn,"base.strided.dvariancepn( N:integer, correction:number, x:Float64Array, strideX:integer )"
base.strided.dvariancepn.ndarray,"base.strided.dvariancepn.ndarray( N:integer, correction:number, x:Float64Array, strideX:integer, offsetX:integer )"
base.strided.dvariancetk,"base.strided.dvariancetk( N:integer, correction:number, x:Float64Array, strideX:integer )"
base.strided.dvariancetk.ndarray,"base.strided.dvariancetk.ndarray( N:integer, correction:number, x:Float64Array, strideX:integer, offsetX:integer )"
base.strided.dvariancewd,"base.strided.dvariancewd( N:integer, correction:number, x:Float64Array, strideX:integer )"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/typed-signature/data/data.json
View file

Large diffs are not rendered by default.

1 comment on commit 6c52481

@stdlib-bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
repl/code-blocks $\color{green}95/95$
$\color{green}+100.00\%$ 		$\color{green}7/7$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}95/95$
$\color{green}+100.00\%$
repl/help $\color{green}95/95$
$\color{green}+100.00\%$ 		$\color{green}7/7$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}95/95$
$\color{green}+100.00\%$
repl/info $\color{green}95/95$
$\color{green}+100.00\%$ 		$\color{green}7/7$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}95/95$
$\color{green}+100.00\%$
repl/signature $\color{green}99/99$
$\color{green}+100.00\%$ 		$\color{green}10/10$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}99/99$
$\color{green}+100.00\%$
repl/typed-signature $\color{green}99/99$
$\color{green}+100.00\%$ 		$\color{green}10/10$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}99/99$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.