Skip to content

docs: update REPL namespace documentation #4878

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 24, 2025
Merged

docs: update REPL namespace documentation #4878

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
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2277,7 +2277,7 @@ base.strided.sdsnansumpw,"var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\n
base.strided.sdsnansumpw.ndarray,"var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\nbase.strided.sdsnansumpw.ndarray( x.length, x, 1, 0 )\nvar x = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );\nbase.strided.sdsnansumpw.ndarray( 4, x, 2, 1 )\n"
base.strided.sdssum,"var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.sdssum( x.length, x, 1 )\nx = new Float32Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );\nvar stride = 2;\nbase.strided.sdssum( 3, x, stride )\nvar x0 = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nvar x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nstride = 2;\nbase.strided.sdssum( 3, x1, stride )\n"
base.strided.sdssum.ndarray,"var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.sdssum.ndarray( x.length, x, 1, 0 )\nvar x = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nbase.strided.sdssum.ndarray( 3, x, 2, 1 )\n"
base.strided.sdssumpw,"var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.sdssumpw( x.length, x, 1 )\nx = new Float32Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );\nvar stride = 2;\nbase.strided.sdssumpw( 3, x, stride )\nvar x0 = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nvar x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nstride = 2;\nbase.strided.sdssumpw( 3, x1, stride )\n"
base.strided.sdssumpw,"var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.sdssumpw( x.length, x, 1 )\nx = new Float32Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );\nbase.strided.sdssumpw( 3, x, 2 )\nvar x0 = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nvar x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.sdssumpw( 3, x1, 2 )\n"
base.strided.sdssumpw.ndarray,"var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );\nbase.strided.sdssumpw.ndarray( x.length, x, 1, 0 )\nvar x = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nbase.strided.sdssumpw.ndarray( 3, x, 2, 1 )\n"
base.strided.sfill,"var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );\nbase.strided.sfill( x.length, 5.0, x, 1 )\nx = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );\nbase.strided.sfill( 3, 5.0, x, 2 )\nvar x0 = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );\nvar x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.sfill( 3, 5.0, x1, 2 )\nx0\n"
base.strided.sfill.ndarray,"var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );\nbase.strided.sfill.ndarray( x.length, 5.0, x, 1, 0 )\nx = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );\nbase.strided.sfill.ndarray( 3, 5.0, x, 2, 1 )\n"
Expand Down Expand Up @@ -2395,7 +2395,7 @@ base.strided.snanstdevyc,"var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\n
base.strided.snanstdevyc.ndarray,"var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\nbase.strided.snanstdevyc.ndarray( x.length, 1, x, 1, 0 )\nvar x = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );\nvar N = base.floor( x.length / 2 );\nbase.strided.snanstdevyc.ndarray( N, 1, x, 2, 1 )\n"
base.strided.snansum,"var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\nbase.strided.snansum( x.length, x, 1 )\nx = new Float32Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] );\nbase.strided.snansum( 4, x, 2 )\nvar x0 = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );\nvar x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.snansum( 4, x1, 2 )\n"
base.strided.snansum.ndarray,"var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\nbase.strided.snansum.ndarray( x.length, x, 1, 0 )\nvar x = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );\nbase.strided.snansum.ndarray( 4, x, 2, 1 )\n"
base.strided.snansumkbn,"var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\nbase.strided.snansumkbn( x.length, x, 1 )\nx = new Float32Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] );\nvar stride = 2;\nbase.strided.snansumkbn( 4, x, stride )\nvar x0 = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );\nvar x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nstride = 2;\nbase.strided.snansumkbn( 4, x1, stride )\n"
base.strided.snansumkbn,"var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\nbase.strided.snansumkbn( x.length, x, 1 )\nx = new Float32Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] );\nbase.strided.snansumkbn( 4, x, 2 )\nvar x0 = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );\nvar x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.snansumkbn( 4, x1, 2 )\n"
base.strided.snansumkbn.ndarray,"var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\nbase.strided.snansumkbn.ndarray( x.length, x, 1, 0 )\nvar x = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );\nbase.strided.snansumkbn.ndarray( 4, x, 2, 1 )\n"
base.strided.snansumkbn2,"var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\nbase.strided.snansumkbn2( x.length, x, 1 )\nx = new Float32Array( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] );\nbase.strided.snansumkbn2( 4, x, 2 )\nvar x0 = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );\nvar x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.snansumkbn2( 4, x1, 2 )\n"
base.strided.snansumkbn2.ndarray,"var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );\nbase.strided.snansumkbn2.ndarray( x.length, x, 1, 0 )\nvar x = new Float32Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );\nbase.strided.snansumkbn2.ndarray( 4, x, 2, 1 )\n"
Expand Down
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.

20 changes: 10 additions & 10 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.

20 changes: 10 additions & 10 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 @@ -2259,8 +2259,8 @@ base.strided.sdot,"\nbase.strided.sdot( N:integer, x:Float32Array, strideX:integ
base.strided.sdot.ndarray,"\nbase.strided.sdot.ndarray( N:integer, x:Float32Array, strideX:integer, \n offsetX:integer, y:Float32Array, strideY:integer, offsetY:integer )\n Computes the dot product of two single-precision floating-point vectors\n using alternative indexing semantics.\n"
base.strided.sdsapxsum,"\nbase.strided.sdsapxsum( N:integer, alpha:number, x:Float32Array, \n stride:integer )\n Adds a constant to each single-precision floating-point strided array\n element and computes the sum using extended accumulation.\n"
base.strided.sdsapxsum.ndarray,"\nbase.strided.sdsapxsum.ndarray( N:integer, alpha:number, x:Float32Array, \n stride:integer, offset:integer )\n Adds a constant to each single-precision floating-point strided array\n element and computes the sum using extended accumulation and alternative\n indexing semantics.\n"
base.strided.sdsapxsumpw,"\nbase.strided.sdsapxsumpw( N:integer, alpha:number, x:Float32Array, \n stride:integer )\n Adds a constant to each single-precision floating-point strided array\n element and computes the sum using pairwise summation with extended\n accumulation.\n"
base.strided.sdsapxsumpw.ndarray,"\nbase.strided.sdsapxsumpw.ndarray( N:integer, alpha:number, x:Float32Array, \n stride:integer, offset:integer )\n Adds a constant to each single-precision floating-point strided array\n element and computes the sum using pairwise summation with extended\n accumulation and alternative indexing semantics.\n"
base.strided.sdsapxsumpw,"\nbase.strided.sdsapxsumpw( N:integer, alpha:number, x:Float32Array, \n strideX:integer )\n Adds a scalar constant to each single-precision floating-point strided array\n element and computes the sum using pairwise summation with extended\n accumulation.\n"
base.strided.sdsapxsumpw.ndarray,"\nbase.strided.sdsapxsumpw.ndarray( N:integer, alpha:number, x:Float32Array, \n strideX:integer, offsetX:integer )\n Adds a scalar constant to each single-precision floating-point strided array\n element and computes the sum using pairwise summation with extended\n accumulation and alternative indexing semantics.\n"
base.strided.sdsdot,"\nbase.strided.sdsdot( N:integer, scalar:number, x:Float32Array, strideX:integer, \n y:Float32Array, strideY:integer )\n Computes the dot product of two single-precision floating-point vectors with\n extended accumulation.\n"
base.strided.sdsdot.ndarray,"\nbase.strided.sdsdot.ndarray( N:integer, scalar:number, x:Float32Array, \n strideX:integer, offsetX:integer, y:Float32Array, strideY:integer, \n offsetY:integer )\n Computes the dot product of two single-precision floating-point vectors\n using alternative indexing semantics and with extended accumulation.\n"
base.strided.sdsmean,"\nbase.strided.sdsmean( N:integer, x:Float32Array, stride:integer )\n Computes the arithmetic mean of a single-precision floating-point strided\n array using extended accumulation.\n"
Expand All @@ -2273,12 +2273,12 @@ base.strided.sdsnanmeanors,"\nbase.strided.sdsnanmeanors( N:integer, x:Float32Ar
base.strided.sdsnanmeanors.ndarray,"\nbase.strided.sdsnanmeanors.ndarray( N:integer, x:Float32Array, stride:integer, \n offset:integer )\n Computes the arithmetic mean of a single-precision floating-point strided\n array, ignoring `NaN` values and using ordinary recursive summation with\n extended accumulation and alternative indexing semantics.\n"
base.strided.sdsnansum,"\nbase.strided.sdsnansum( N:integer, x:Float32Array, stride:integer )\n Computes the sum of single-precision floating-point strided array\n elements, ignore `NaN` values and using extended accumulation.\n"
base.strided.sdsnansum.ndarray,"\nbase.strided.sdsnansum.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 extended accumulation and alternative\n indexing semantics.\n"
base.strided.sdsnansumpw,"\nbase.strided.sdsnansumpw( 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 with extended\n accumulation.\n"
base.strided.sdsnansumpw.ndarray,"\nbase.strided.sdsnansumpw.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 with extended\n accumulation and alternative indexing semantics.\n"
base.strided.sdsnansumpw,"\nbase.strided.sdsnansumpw( 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 with extended\n accumulation.\n"
base.strided.sdsnansumpw.ndarray,"\nbase.strided.sdsnansumpw.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 with extended\n accumulation and alternative indexing semantics.\n"
base.strided.sdssum,"\nbase.strided.sdssum( N:integer, x:Float32Array, stride:integer )\n Computes the sum of single-precision floating-point strided array elements\n using extended accumulation.\n"
base.strided.sdssum.ndarray,"\nbase.strided.sdssum.ndarray( N:integer, x:Float32Array, stride:integer, \n offset:integer )\n Computes the sum of single-precision floating-point strided array elements\n using extended accumulation and alternative indexing semantics.\n"
base.strided.sdssumpw,"\nbase.strided.sdssumpw( N:integer, x:Float32Array, stride:integer )\n Computes the sum of single-precision floating-point strided array elements\n using pairwise summation with extended accumulation.\n"
base.strided.sdssumpw.ndarray,"\nbase.strided.sdssumpw.ndarray( N:integer, x:Float32Array, stride:integer, \n offset:integer )\n Computes the sum of single-precision floating-point strided array elements\n using pairwise summation with extended accumulation and alternative indexing\n semantics.\n"
base.strided.sdssumpw,"\nbase.strided.sdssumpw( N:integer, x:Float32Array, strideX:integer )\n Computes the sum of single-precision floating-point strided array elements\n using pairwise summation with extended accumulation.\n"
base.strided.sdssumpw.ndarray,"\nbase.strided.sdssumpw.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 with extended accumulation and alternative indexing\n semantics.\n"
base.strided.sfill,"\nbase.strided.sfill( N:integer, alpha:number, x:Float32Array, strideX:integer )\n Fills a single-precision floating-point strided array with a specified\n scalar value.\n"
base.strided.sfill.ndarray,"\nbase.strided.sfill.ndarray( N:integer, alpha:number, x:Float32Array, \n strideX:integer, offsetX:integer )\n Fills a single-precision floating-point strided array with a specified\n scalar value using alternative indexing semantics.\n"
base.strided.sfloor,"\nbase.strided.sfloor( N:integer, x:Float32Array, strideX:integer, \n y:Float32Array, strideY:integer )\n Rounds each element in a single-precision floating-point strided array `x`\n toward negative infinity and assigns the results to elements in a single-\n precision floating-point strided array `y`.\n"
Expand Down Expand Up @@ -2395,8 +2395,8 @@ base.strided.snanstdevyc,"\nbase.strided.snanstdevyc( N:integer, correction:numb
base.strided.snanstdevyc.ndarray,"\nbase.strided.snanstdevyc.ndarray( N:integer, correction:number, x:Float32Array, \n stride:integer, offset:integer )\n Computes the standard deviation of a single-precision floating-point strided\n array ignoring `NaN` values and using a one-pass algorithm proposed by\n Youngs and Cramer and alternative indexing semantics.\n"
base.strided.snansum,"\nbase.strided.snansum( N:integer, x:Float32Array, stride:integer )\n Computes the sum of single-precision floating-point strided array elements,\n ignoring `NaN` values.\n"
base.strided.snansum.ndarray,"\nbase.strided.snansum.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 alternative indexing semantics.\n"
base.strided.snansumkbn,"\nbase.strided.snansumkbn( N:integer, x:Float32Array, stride:integer )\n Computes the sum of single-precision floating-point strided array elements,\n ignoring `NaN` values and using an improved Kahan–Babuška algorithm.\n"
base.strided.snansumkbn.ndarray,"\nbase.strided.snansumkbn.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 an improved Kahan–Babuška algorithm and\n alternative indexing semantics.\n"
base.strided.snansumkbn,"\nbase.strided.snansumkbn( N:integer, x:Float32Array, strideX:integer )\n Computes the sum of single-precision floating-point strided array elements,\n ignoring `NaN` values and using an improved Kahan–Babuška algorithm.\n"
base.strided.snansumkbn.ndarray,"\nbase.strided.snansumkbn.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 an improved Kahan–Babuška algorithm and\n alternative indexing semantics.\n"
base.strided.snansumkbn2,"\nbase.strided.snansumkbn2( N:integer, x:Float32Array, strideX: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.\n"
base.strided.snansumkbn2.ndarray,"\nbase.strided.snansumkbn2.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 a second-order iterative Kahan–Babuška\n algorithm and alternative indexing semantics.\n"
base.strided.snansumors,"\nbase.strided.snansumors( N:integer, x:Float32Array, strideX:integer )\n Computes the sum of single-precision floating-point strided array elements,\n ignoring `NaN` values and using ordinary recursive summation.\n"
Expand Down Expand Up @@ -2455,8 +2455,8 @@ base.strided.sstdevyc,"\nbase.strided.sstdevyc( N:integer, correction:number, x:
base.strided.sstdevyc.ndarray,"\nbase.strided.sstdevyc.ndarray( N:integer, correction:number, x:Float32Array, \n stride:integer, offset:integer )\n Computes the standard deviation of a single-precision floating-point strided\n array using a one-pass algorithm proposed by Youngs and Cramer and\n alternative indexing semantics.\n"
base.strided.ssum,"\nbase.strided.ssum( N:integer, x:Float32Array, stride:integer )\n Computes the sum of single-precision floating-point strided array elements.\n"
base.strided.ssum.ndarray,"\nbase.strided.ssum.ndarray( N:integer, x:Float32Array, stride:integer, \n offset:integer )\n Computes the sum of single-precision floating-point strided array elements\n using alternative indexing semantics.\n"
base.strided.ssumkbn,"\nbase.strided.ssumkbn( N:integer, x:Float32Array, stride:integer )\n Computes the sum of single-precision floating-point strided array elements\n using an improved Kahan–Babuška algorithm.\n"
base.strided.ssumkbn.ndarray,"\nbase.strided.ssumkbn.ndarray( N:integer, x:Float32Array, stride:integer, \n offset:integer )\n Computes the sum of single-precision floating-point strided array elements\n using an improved Kahan–Babuška algorithm and alternative indexing\n semantics.\n"
base.strided.ssumkbn,"\nbase.strided.ssumkbn( N:integer, x:Float32Array, strideX:integer )\n Computes the sum of single-precision floating-point strided array elements\n using an improved Kahan–Babuška algorithm.\n"
base.strided.ssumkbn.ndarray,"\nbase.strided.ssumkbn.ndarray( N:integer, x:Float32Array, strideX:integer, \n offsetX:integer )\n Computes the sum of single-precision floating-point strided array elements\n using an improved Kahan–Babuška algorithm and alternative indexing\n semantics.\n"
base.strided.ssumkbn2,"\nbase.strided.ssumkbn2( N:integer, x:Float32Array, stride:integer )\n Computes the sum of single-precision floating-point strided array elements\n using a second-order iterative Kahan–Babuška algorithm.\n"
base.strided.ssumkbn2.ndarray,"\nbase.strided.ssumkbn2.ndarray( N:integer, x:Float32Array, stride:integer, \n offset:integer )\n Computes the sum of single-precision floating-point strided array elements\n using a second-order iterative Kahan–Babuška algorithm and alternative\n indexing semantics.\n"
base.strided.ssumors,"\nbase.strided.ssumors( N:integer, x:Float32Array, strideX:integer )\n Computes the sum of single-precision floating-point strided array elements\n using ordinary recursive summation.\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.

Loading
Loading