Skip to content

docs: update REPL namespace documentation #4244

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
Dec 26, 2024
Merged

docs: update REPL namespace documentation #4244

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

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.

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 @@ -1770,8 +1770,8 @@ base.strided.dmidrange,"\nbase.strided.dmidrange( N:integer, x:Float64Array, str
base.strided.dmidrange.ndarray,"\nbase.strided.dmidrange.ndarray( N:integer, x:Float64Array, stride:integer, \n offset:integer )\n Computes the mid-range of a double-precision floating-point strided array\n using alternative indexing semantics.\n"
base.strided.dmin,"\nbase.strided.dmin( N:integer, x:Float64Array, stride:integer )\n Computes the minimum value of a double-precision floating-point strided\n array.\n"
base.strided.dmin.ndarray,"\nbase.strided.dmin.ndarray( N:integer, x:Float64Array, stride:integer, \n offset:integer )\n Computes the minimum value of a double-precision floating-point strided\n array using alternative indexing semantics.\n"
base.strided.dminabs,"\nbase.strided.dminabs( N:integer, x:Float64Array, stride:integer )\n Computes the minimum absolute value of a double-precision floating-point\n strided array.\n"
base.strided.dminabs.ndarray,"\nbase.strided.dminabs.ndarray( N:integer, x:Float64Array, stride:integer, \n offset:integer )\n Computes the minimum absolute value of a double-precision floating-point\n strided array using alternative indexing semantics.\n"
base.strided.dminabs,"\nbase.strided.dminabs( N:integer, x:Float64Array, strideX:integer )\n Computes the minimum absolute value of a double-precision floating-point\n strided array.\n"
base.strided.dminabs.ndarray,"\nbase.strided.dminabs.ndarray( N:integer, x:Float64Array, strideX:integer, \n offsetX:integer )\n Computes the minimum absolute value of a double-precision floating-point\n strided array using alternative indexing semantics.\n"
base.strided.dminsorted,"\nbase.strided.dminsorted( N:integer, x:Float64Array, stride:integer )\n Computes the minimum value of a sorted double-precision floating-point\n strided array.\n"
base.strided.dminsorted.ndarray,"\nbase.strided.dminsorted.ndarray( N:integer, x:Float64Array, stride:integer, \n offset:integer )\n Computes the minimum value of a sorted double-precision floating-point\n strided array using alternative indexing semantics.\n"
base.strided.dmskabs,"\nbase.strided.dmskabs( N:integer, x:Float64Array, sx:integer, m:Uint8Array, \n sm:integer, y:Float64Array, sy:integer )\n Computes the absolute value for each element in a double-precision floating-\n point strided array `x` according to a strided mask array and assigns the\n results to elements in a double-precision floating-point strided array `y`.\n"
Expand Down Expand Up @@ -1826,8 +1826,8 @@ base.strided.dnanmeanwd,"\nbase.strided.dnanmeanwd( N:integer, x:Float64Array, s
base.strided.dnanmeanwd.ndarray,"\nbase.strided.dnanmeanwd.ndarray( N:integer, x:Float64Array, stride:integer, \n offset:integer )\n Computes the arithmetic mean of a double-precision floating-point strided\n array, ignoring `NaN` values and using Welford's algorithm and alternative\n indexing semantics.\n"
base.strided.dnanmin,"\nbase.strided.dnanmin( N:integer, x:Float64Array, stride:integer )\n Computes the minimum value of a double-precision floating-point strided\n array, ignoring `NaN` values.\n"
base.strided.dnanmin.ndarray,"\nbase.strided.dnanmin.ndarray( N:integer, x:Float64Array, stride:integer, \n offset:integer )\n Computes the minimum value of a double-precision floating-point strided\n array, ignoring `NaN` values and using alternative indexing semantics.\n"
base.strided.dnanminabs,"\nbase.strided.dnanminabs( N:integer, x:Float64Array, stride:integer )\n Computes the minimum absolute value of a double-precision floating-point\n strided array, ignoring `NaN` values.\n"
base.strided.dnanminabs.ndarray,"\nbase.strided.dnanminabs.ndarray( N:integer, x:Float64Array, stride:integer, \n offset:integer )\n Computes the minimum absolute value of a double-precision floating-point\n strided array, ignoring `NaN` values and using alternative indexing\n semantics.\n"
base.strided.dnanminabs,"\nbase.strided.dnanminabs( N:integer, x:Float64Array, strideX:integer )\n Computes the minimum absolute value of a double-precision floating-point\n strided array, ignoring `NaN` values.\n"
base.strided.dnanminabs.ndarray,"\nbase.strided.dnanminabs.ndarray( N:integer, x:Float64Array, strideX:integer, \n offsetX:integer )\n Computes the minimum absolute value of a double-precision floating-point\n strided array, ignoring `NaN` values and using alternative indexing\n semantics.\n"
base.strided.dnanmskmax,"\nbase.strided.dnanmskmax( N:integer, x:Float64Array, strideX:integer, \n mask:Uint8Array, strideMask:integer )\n Computes the maximum value of a double-precision floating-point strided\n array according to a mask, ignoring `NaN` values.\n"
base.strided.dnanmskmax.ndarray,"\nbase.strided.dnanmskmax.ndarray( N:integer, x:Float64Array, strideX:integer, \n offsetX:integer, mask:Uint8Array, strideMask:integer, offsetMask:integer )\n Computes the maximum value of a double-precision floating-point strided\n array according to a mask, ignoring `NaN` values and using alternative\n indexing semantics.\n"
base.strided.dnanmskmin,"\nbase.strided.dnanmskmin( N:integer, x:Float64Array, strideX:integer, \n mask:Uint8Array, strideMask:integer )\n Computes the minimum value of a double-precision floating-point strided\n array according to a mask, ignoring `NaN` values.\n"
Expand Down Expand Up @@ -1884,8 +1884,8 @@ base.strided.dnrm2,"\nbase.strided.dnrm2( N:integer, x:Float64Array, stride:inte
base.strided.dnrm2.ndarray,"\nbase.strided.dnrm2.ndarray( N:integer, x:Float64Array, stride:integer, \n offset:integer )\n Computes the L2-norm of a double-precision floating-point vector using\n alternative indexing semantics.\n"
base.strided.dramp,"\nbase.strided.dramp( N:integer, x:Float64Array, strideX:integer, y:Float64Array, \n strideY:integer )\n Evaluates the ramp function for each element in a double-precision floating-\n point strided array `x` and assigns the results to elements in a double-\n precision floating-point strided array `y`.\n"
base.strided.dramp.ndarray,"\nbase.strided.dramp.ndarray( N:integer, x:Float64Array, strideX:integer, \n offsetX:integer, y:Float64Array, strideY:integer, offsetY:integer )\n Evaluates the ramp function for each element in a double-precision floating-\n point strided array `x` and assigns the results to elements in a double-\n precision floating-point strided array `y` using alternative indexing\n semantics.\n"
base.strided.drange,"\nbase.strided.drange( N:integer, x:Float64Array, stride:integer )\n Computes the range of a double-precision floating-point strided array.\n"
base.strided.drange.ndarray,"\nbase.strided.drange.ndarray( N:integer, x:Float64Array, stride:integer, \n offset:integer )\n Computes the range of a double-precision floating-point strided array using\n alternative indexing semantics.\n"
base.strided.drange,"\nbase.strided.drange( N:integer, x:Float64Array, strideX:integer )\n Computes the range of a double-precision floating-point strided array.\n"
base.strided.drange.ndarray,"\nbase.strided.drange.ndarray( N:integer, x:Float64Array, strideX:integer, \n offsetX:integer )\n Computes the range of a double-precision floating-point strided array using\n alternative indexing semantics.\n"
base.strided.drev,"\nbase.strided.drev( N:integer, x:Float64Array, strideX:integer )\n Reverses a double-precision floating-point strided array in-place.\n"
base.strided.drev.ndarray,"\nbase.strided.drev.ndarray( N:integer, x:Float64Array, strideX:integer, \n offsetX:integer )\n Reverses a double-precision floating-point strided array in-place using\n alternative indexing semantics.\n"
base.strided.drsqrt,"\nbase.strided.drsqrt( N:integer, x:Float64Array, strideX:integer, \n y:Float64Array, strideY:integer )\n Computes the reciprocal square root for each element in a double-precision\n floating-point strided array `x` and assigns the results to elements in a\n double-precision floating-point strided array `y`.\n"
Expand Down Expand Up @@ -2395,8 +2395,8 @@ base.strided.snansumkbn,"\nbase.strided.snansumkbn( N:integer, x:Float32Array, s
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.snansumkbn2,"\nbase.strided.snansumkbn2( N:integer, x:Float32Array, stride: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, 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.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"
base.strided.snansumors.ndarray,"\nbase.strided.snansumors.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 ordinary recursive summation and alternative\n indexing 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"
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 @@ -1771,8 +1771,8 @@ base.strided.dmidrange,"base.strided.dmidrange( N, x, stride )"
base.strided.dmidrange.ndarray,"base.strided.dmidrange.ndarray( N, x, stride, offset )"
base.strided.dmin,"base.strided.dmin( N, x, stride )"
base.strided.dmin.ndarray,"base.strided.dmin.ndarray( N, x, stride, offset )"
base.strided.dminabs,"base.strided.dminabs( N, x, stride )"
base.strided.dminabs.ndarray,"base.strided.dminabs.ndarray( N, x, stride, offset )"
base.strided.dminabs,"base.strided.dminabs( N, x, strideX )"
base.strided.dminabs.ndarray,"base.strided.dminabs.ndarray( N, x, strideX, offsetX )"
base.strided.dminsorted,"base.strided.dminsorted( N, x, stride )"
base.strided.dminsorted.ndarray,"base.strided.dminsorted.ndarray( N, x, stride, offset )"
base.strided.dmskabs,"base.strided.dmskabs( N, x, sx, m, sm, y, sy )"
Expand Down Expand Up @@ -1827,8 +1827,8 @@ base.strided.dnanmeanwd,"base.strided.dnanmeanwd( N, x, stride )"
base.strided.dnanmeanwd.ndarray,"base.strided.dnanmeanwd.ndarray( N, x, stride, offset )"
base.strided.dnanmin,"base.strided.dnanmin( N, x, stride )"
base.strided.dnanmin.ndarray,"base.strided.dnanmin.ndarray( N, x, stride, offset )"
base.strided.dnanminabs,"base.strided.dnanminabs( N, x, stride )"
base.strided.dnanminabs.ndarray,"base.strided.dnanminabs.ndarray( N, x, stride, offset )"
base.strided.dnanminabs,"base.strided.dnanminabs( N, x, strideX )"
base.strided.dnanminabs.ndarray,"base.strided.dnanminabs.ndarray( N, x, strideX, offsetX )"
base.strided.dnanmskmax,"base.strided.dnanmskmax( N, x, strideX, mask, strideMask )"
base.strided.dnanmskmax.ndarray,"base.strided.dnanmskmax.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask )"
base.strided.dnanmskmin,"base.strided.dnanmskmin( N, x, strideX, mask, strideMask )"
Expand Down Expand Up @@ -1885,8 +1885,8 @@ base.strided.dnrm2,"base.strided.dnrm2( N, x, stride )"
base.strided.dnrm2.ndarray,"base.strided.dnrm2.ndarray( N, x, stride, offset )"
base.strided.dramp,"base.strided.dramp( N, x, strideX, y, strideY )"
base.strided.dramp.ndarray,"base.strided.dramp.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )"
base.strided.drange,"base.strided.drange( N, x, stride )"
base.strided.drange.ndarray,"base.strided.drange.ndarray( N, x, stride, offset )"
base.strided.drange,"base.strided.drange( N, x, strideX )"
base.strided.drange.ndarray,"base.strided.drange.ndarray( N, x, strideX, offsetX )"
base.strided.drev,"base.strided.drev( N, x, strideX )"
base.strided.drev.ndarray,"base.strided.drev.ndarray( N, x, strideX, offsetX )"
base.strided.drsqrt,"base.strided.drsqrt( N, x, strideX, y, strideY )"
Expand Down Expand Up @@ -2396,8 +2396,8 @@ base.strided.snansumkbn,"base.strided.snansumkbn( N, x, stride )"
base.strided.snansumkbn.ndarray,"base.strided.snansumkbn.ndarray( N, x, stride, offset )"
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.snansumors,"base.strided.snansumors( N, x, strideX )"
base.strided.snansumors.ndarray,"base.strided.snansumors.ndarray( N, x, strideX, offsetX )"
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 )"
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 @@ -1771,8 +1771,8 @@ base.strided.dmidrange,"base.strided.dmidrange( N:integer, x:Float64Array, strid
base.strided.dmidrange.ndarray,"base.strided.dmidrange.ndarray( N:integer, x:Float64Array, stride:integer, offset:integer )"
base.strided.dmin,"base.strided.dmin( N:integer, x:Float64Array, stride:integer )"
base.strided.dmin.ndarray,"base.strided.dmin.ndarray( N:integer, x:Float64Array, stride:integer, offset:integer )"
base.strided.dminabs,"base.strided.dminabs( N:integer, x:Float64Array, stride:integer )"
base.strided.dminabs.ndarray,"base.strided.dminabs.ndarray( N:integer, x:Float64Array, stride:integer, offset:integer )"
base.strided.dminabs,"base.strided.dminabs( N:integer, x:Float64Array, strideX:integer )"
base.strided.dminabs.ndarray,"base.strided.dminabs.ndarray( N:integer, x:Float64Array, strideX:integer, offsetX:integer )"
base.strided.dminsorted,"base.strided.dminsorted( N:integer, x:Float64Array, stride:integer )"
base.strided.dminsorted.ndarray,"base.strided.dminsorted.ndarray( N:integer, x:Float64Array, stride:integer, offset:integer )"
base.strided.dmskabs,"base.strided.dmskabs( N:integer, x:Float64Array, sx:integer, m:Uint8Array, sm:integer, y:Float64Array, sy:integer )"
Expand Down Expand Up @@ -1827,8 +1827,8 @@ base.strided.dnanmeanwd,"base.strided.dnanmeanwd( N:integer, x:Float64Array, str
base.strided.dnanmeanwd.ndarray,"base.strided.dnanmeanwd.ndarray( N:integer, x:Float64Array, stride:integer, offset:integer )"
base.strided.dnanmin,"base.strided.dnanmin( N:integer, x:Float64Array, stride:integer )"
base.strided.dnanmin.ndarray,"base.strided.dnanmin.ndarray( N:integer, x:Float64Array, stride:integer, offset:integer )"
base.strided.dnanminabs,"base.strided.dnanminabs( N:integer, x:Float64Array, stride:integer )"
base.strided.dnanminabs.ndarray,"base.strided.dnanminabs.ndarray( N:integer, x:Float64Array, stride:integer, offset:integer )"
base.strided.dnanminabs,"base.strided.dnanminabs( N:integer, x:Float64Array, strideX:integer )"
base.strided.dnanminabs.ndarray,"base.strided.dnanminabs.ndarray( N:integer, x:Float64Array, strideX:integer, offsetX:integer )"
base.strided.dnanmskmax,"base.strided.dnanmskmax( N:integer, x:Float64Array, strideX:integer, mask:Uint8Array, strideMask:integer )"
base.strided.dnanmskmax.ndarray,"base.strided.dnanmskmax.ndarray( N:integer, x:Float64Array, strideX:integer, offsetX:integer, mask:Uint8Array, strideMask:integer, offsetMask:integer )"
base.strided.dnanmskmin,"base.strided.dnanmskmin( N:integer, x:Float64Array, strideX:integer, mask:Uint8Array, strideMask:integer )"
Expand Down Expand Up @@ -1885,8 +1885,8 @@ base.strided.dnrm2,"base.strided.dnrm2( N:integer, x:Float64Array, stride:intege
base.strided.dnrm2.ndarray,"base.strided.dnrm2.ndarray( N:integer, x:Float64Array, stride:integer, offset:integer )"
base.strided.dramp,"base.strided.dramp( N:integer, x:Float64Array, strideX:integer, y:Float64Array, strideY:integer )"
base.strided.dramp.ndarray,"base.strided.dramp.ndarray( N:integer, x:Float64Array, strideX:integer, offsetX:integer, y:Float64Array, strideY:integer, offsetY:integer )"
base.strided.drange,"base.strided.drange( N:integer, x:Float64Array, stride:integer )"
base.strided.drange.ndarray,"base.strided.drange.ndarray( N:integer, x:Float64Array, stride:integer, offset:integer )"
base.strided.drange,"base.strided.drange( N:integer, x:Float64Array, strideX:integer )"
base.strided.drange.ndarray,"base.strided.drange.ndarray( N:integer, x:Float64Array, strideX:integer, offsetX:integer )"
base.strided.drev,"base.strided.drev( N:integer, x:Float64Array, strideX:integer )"
base.strided.drev.ndarray,"base.strided.drev.ndarray( N:integer, x:Float64Array, strideX:integer, offsetX:integer )"
base.strided.drsqrt,"base.strided.drsqrt( N:integer, x:Float64Array, strideX:integer, y:Float64Array, strideY:integer )"
Expand Down Expand Up @@ -2396,8 +2396,8 @@ base.strided.snansumkbn,"base.strided.snansumkbn( N:integer, x:Float32Array, str
base.strided.snansumkbn.ndarray,"base.strided.snansumkbn.ndarray( N:integer, x:Float32Array, stride:integer, offset:integer )"
base.strided.snansumkbn2,"base.strided.snansumkbn2( N:integer, x:Float32Array, stride:integer )"
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.snansumors,"base.strided.snansumors( N:integer, x:Float32Array, strideX:integer )"
base.strided.snansumors.ndarray,"base.strided.snansumors.ndarray( N:integer, x:Float32Array, strideX:integer, offsetX: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 )"
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