Skip to content

Commit

Permalink
docs: update REPL namespace documentation
Browse files Browse the repository at this point in the history
PR-URL: #3372

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
  • Loading branch information
stdlib-bot and Planeshifter authored Dec 8, 2024
1 parent 1aae203 commit 911e839
Show file tree
Hide file tree
Showing 10 changed files with 23 additions and 23 deletions.
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -1688,8 +1688,8 @@ base.strided.dapxsumpw,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.st
base.strided.dapxsumpw.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dapxsumpw.ndarray( x.length, 5.0, x, 1, 0 )\nvar x = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nbase.strided.dapxsumpw.ndarray( 3, 5.0, x, 2, 1 )\n"
base.strided.dasum,"var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0 ] );\nvar s = base.strided.dasum( x.length, x, 1 )\ns = base.strided.dasum( 3, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\ns = base.strided.dasum( 3, x1, 2 )\n"
base.strided.dasum.ndarray,"var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0 ] );\nvar s = base.strided.dasum.ndarray( x.length, x, 1, 0 )\nx = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );\ns = base.strided.dasum.ndarray( 3, x, -1, x.length-1 )\n"
base.strided.dasumpw,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dasumpw( x.length, 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.dasumpw( N, 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.dasumpw( N, x1, stride )\n"
base.strided.dasumpw.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dasumpw.ndarray( x.length, 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.dasumpw.ndarray( N, x, 2, 1 )\n"
base.strided.dasumpw,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dasumpw( x.length, x, 1 )\nx = new Float64Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );\nvar stride = 2;\nbase.strided.dasumpw( 3, 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 );\nstride = 2;\nbase.strided.dasumpw( 3, x1, stride )\n"
base.strided.dasumpw.ndarray,"var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.dasumpw.ndarray( x.length, x, 1, 0 )\nvar x = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nbase.strided.dasumpw.ndarray( 3, x, 2, 1 )\n"
base.strided.daxpy,"var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );\nvar y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] );\nvar alpha = 5.0;\nbase.strided.daxpy( x.length, alpha, x, 1, y, 1 )\nx = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );\ny = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );\nbase.strided.daxpy( 3, alpha, x, 2, y, -1 )\nvar x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );\nvar y0 = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nvar y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 );\nbase.strided.daxpy( 3, 5.0, x1, -2, y1, 1 )\ny0\n"
base.strided.daxpy.ndarray,"var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );\nvar y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] );\nvar alpha = 5.0;\nbase.strided.daxpy.ndarray( x.length, alpha, x, 1, 0, y, 1, 0 )\nx = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );\ny = new Float64Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );\nbase.strided.daxpy.ndarray( 3, alpha, x, 2, 1, y, -1, y.length-1 )\n"
base.strided.dcbrt,"var x = new Float64Array( [ 0.0, 1.0, 8.0, 27.0 ] );\nvar y = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );\nbase.strided.dcbrt( x.length, x, 1, y, 1 )\nvar N = base.floor( x.length / 2 );\ny = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );\nbase.strided.dcbrt( N, x, 2, y, -1 )\nvar x0 = new Float64Array( [ 0.0, 1.0, 8.0, 27.0 ] );\nvar y0 = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nvar y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 );\nN = base.floor( x0.length / 2 );\nbase.strided.dcbrt( N, x1, -2, y1, 1 )\ny0\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/code-blocks/data/data.json

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions lib/node_modules/@stdlib/repl/help/data/data.csv

Large diffs are not rendered by default.

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

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/repl/info/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -949,7 +949,7 @@ base.erfc,"\nbase.erfc( x:number )\n Evaluates the complementary error functi
base.erfcinv,"\nbase.erfcinv( x:number )\n Evaluates the inverse complementary error function.\n"
base.erfcx,"\nbase.erfcx( x:number )\n Evaluates the scaled complementary error function.\n"
base.erfinv,"\nbase.erfinv( x:number )\n Evaluates the inverse error function.\n"
base.eta,"\nbase.eta( s:number )\n Evaluates the Dirichlet eta function as a function of a real variable `s`.\n"
base.eta,"\nbase.eta( s:number )\n Evaluates the Dirichlet eta function for a double-precision\n floating-point number `s`.\n"
base.evalpoly,"\nbase.evalpoly( c:Array<number>, x:number )\n Evaluates a polynomial using double-precision floating-point arithmetic.\n"
base.evalpoly.factory,"\nbase.evalpoly.factory( c:Array<number> )\n Returns a function for evaluating a polynomial using double-precision\n floating-point arithmetic.\n"
base.evalrational,"\nbase.evalrational( P:Array<number>, Q:Array<number>, x:number )\n Evaluates a rational function using double-precision floating-point\n arithmetic.\n"
Expand Down Expand Up @@ -2397,8 +2397,8 @@ base.strided.snansumkbn2,"\nbase.strided.snansumkbn2( N:integer, x:Float32Array,
base.strided.snansumkbn2.ndarray,"\nbase.strided.snansumkbn2.ndarray( N:integer, x:Float32Array, stride:integer, \n offset:integer )\n Computes the sum of single-precision floating-point strided array elements,\n ignoring `NaN` values and using a second-order iterative Kahan–Babuška\n algorithm and alternative indexing semantics.\n"
base.strided.snansumors,"\nbase.strided.snansumors( N:integer, x:Float32Array, stride:integer )\n Computes the sum of single-precision floating-point strided array elements,\n ignoring `NaN` values and using ordinary recursive summation.\n"
base.strided.snansumors.ndarray,"\nbase.strided.snansumors.ndarray( N:integer, x:Float32Array, stride:integer, \n offset:integer )\n Computes the sum of single-precision floating-point strided array elements,\n ignoring `NaN` values and using ordinary recursive summation and alternative\n indexing semantics.\n"
base.strided.snansumpw,"\nbase.strided.snansumpw( N:integer, x:Float32Array, stride:integer )\n Computes the sum of single-precision floating-point strided array elements,\n ignoring `NaN` values and using pairwise summation.\n"
base.strided.snansumpw.ndarray,"\nbase.strided.snansumpw.ndarray( N:integer, x:Float32Array, stride:integer, \n offset:integer )\n Computes the sum of single-precision floating-point strided array elements,\n ignoring `NaN` values and using pairwise summation and alternative indexing\n semantics.\n"
base.strided.snansumpw,"\nbase.strided.snansumpw( N:integer, x:Float32Array, strideX:integer )\n Computes the sum of single-precision floating-point strided array elements,\n ignoring `NaN` values and using pairwise summation.\n"
base.strided.snansumpw.ndarray,"\nbase.strided.snansumpw.ndarray( N:integer, x:Float32Array, strideX:integer, \n offsetX:integer )\n Computes the sum of single-precision floating-point strided array elements,\n ignoring `NaN` values and using pairwise summation and alternative indexing\n semantics.\n"
base.strided.snanvariance,"\nbase.strided.snanvariance( N:integer, correction:number, x:Float32Array, \n stride:integer )\n Computes the variance of a single-precision floating-point strided array\n ignoring `NaN` values.\n"
base.strided.snanvariance.ndarray,"\nbase.strided.snanvariance.ndarray( N:integer, correction:number, \n x:Float32Array, stride:integer, offset:integer )\n Computes the variance of a single-precision floating-point strided array\n ignoring `NaN` values and using alternative indexing semantics.\n"
base.strided.snanvariancech,"\nbase.strided.snanvariancech( N:integer, correction:number, x:Float32Array, \n stride:integer )\n Computes the variance of a single-precision floating-point strided array\n ignoring `NaN` values and using a one-pass trial mean algorithm.\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/info/data/data.json

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/repl/signature/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2398,8 +2398,8 @@ base.strided.snansumkbn2,"base.strided.snansumkbn2( N, x, stride )"
base.strided.snansumkbn2.ndarray,"base.strided.snansumkbn2.ndarray( N, x, stride, offset )"
base.strided.snansumors,"base.strided.snansumors( N, x, stride )"
base.strided.snansumors.ndarray,"base.strided.snansumors.ndarray( N, x, stride, offset )"
base.strided.snansumpw,"base.strided.snansumpw( N, x, stride )"
base.strided.snansumpw.ndarray,"base.strided.snansumpw.ndarray( N, x, stride, offset )"
base.strided.snansumpw,"base.strided.snansumpw( N, x, strideX )"
base.strided.snansumpw.ndarray,"base.strided.snansumpw.ndarray( N, x, strideX, offsetX )"
base.strided.snanvariance,"base.strided.snanvariance( N, correction, x, stride )"
base.strided.snanvariance.ndarray,"base.strided.snanvariance.ndarray( N, correction, x, stride, offset )"
base.strided.snanvariancech,"base.strided.snanvariancech( N, correction, x, stride )"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/signature/data/data.json

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/repl/typed-signature/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2398,8 +2398,8 @@ base.strided.snansumkbn2,"base.strided.snansumkbn2( N:integer, x:Float32Array, s
base.strided.snansumkbn2.ndarray,"base.strided.snansumkbn2.ndarray( N:integer, x:Float32Array, stride:integer, offset:integer )"
base.strided.snansumors,"base.strided.snansumors( N:integer, x:Float32Array, stride:integer )"
base.strided.snansumors.ndarray,"base.strided.snansumors.ndarray( N:integer, x:Float32Array, stride:integer, offset:integer )"
base.strided.snansumpw,"base.strided.snansumpw( N:integer, x:Float32Array, stride:integer )"
base.strided.snansumpw.ndarray,"base.strided.snansumpw.ndarray( N:integer, x:Float32Array, stride:integer, offset:integer )"
base.strided.snansumpw,"base.strided.snansumpw( N:integer, x:Float32Array, strideX:integer )"
base.strided.snansumpw.ndarray,"base.strided.snansumpw.ndarray( N:integer, x:Float32Array, strideX:integer, offsetX:integer )"
base.strided.snanvariance,"base.strided.snanvariance( N:integer, correction:number, x:Float32Array, stride:integer )"
base.strided.snanvariance.ndarray,"base.strided.snanvariance.ndarray( N:integer, correction:number, x:Float32Array, stride:integer, offset:integer )"
base.strided.snanvariancech,"base.strided.snanvariancech( N:integer, correction:number, x:Float32Array, stride:integer )"
Expand Down

Large diffs are not rendered by default.

1 comment on commit 911e839

@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.