Skip to content

Commit e43aaa9

Browse files
docs: update REPL namespace documentation
PR-URL: #3917 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>
1 parent 1a202e3 commit e43aaa9

File tree

10 files changed

+21
-17
lines changed

10 files changed

+21
-17
lines changed

lib/node_modules/@stdlib/repl/code-blocks/data/data.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4124,6 +4124,7 @@ ndat,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nndat( x, 0, 1 )\nndat( x, 1, 0 )
41244124
ndempty,"var arr = ndempty( [ 2, 2 ] )\nvar sh = arr.shape\nvar dt = arr.dtype\n"
41254125
ndemptyLike,"var x = base.ndzeros( 'float64', [ 2, 2 ], 'row-major' )\nvar sh = x.shape\nvar dt = x.dtype\nvar y = ndemptyLike( x )\nsh = y.shape\ndt = y.dtype\n"
41264126
ndfilter,"var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\nfunction f( v ) { return v > 2.0; };\nvar y = ndfilter( x, f );\nndarray2array( y )\n"
4127+
ndfilterMap,"var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\nfunction f( v ) { if ( v > 2.0 ) { return v * 10.0; } };\nvar y = ndfilterMap( x, f );\nndarray2array( y )\n"
41274128
ndims,"var n = ndims( ndzeros( [ 3, 3, 3 ] ) )\n"
41284129
nditerColumnEntries,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar it = nditerColumnEntries( x );\nvar v = it.next().value;\nv[ 0 ]\nndarray2array( v[ 1 ] )\nv = it.next().value;\nv[ 0 ]\nndarray2array( v[ 1 ] )\n"
41294130
nditerColumns,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar it = nditerColumns( x );\nvar v = it.next().value;\nndarray2array( v )\nv = it.next().value;\nndarray2array( v )\n"

lib/node_modules/@stdlib/repl/code-blocks/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/help/data/data.csv

Lines changed: 6 additions & 6 deletions
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/help/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/info/data/data.csv

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1970,8 +1970,8 @@ base.strided.dstdevyc,"\nbase.strided.dstdevyc( N:integer, correction:number, x:
19701970
base.strided.dstdevyc.ndarray,"\nbase.strided.dstdevyc.ndarray( N:integer, correction:number, x:Float64Array, \n stride:integer, offset:integer )\n Computes the standard deviation of a double-precision floating-point strided\n array using a one-pass algorithm proposed by Youngs and Cramer and\n alternative indexing semantics.\n"
19711971
base.strided.dsum,"\nbase.strided.dsum( N:integer, x:Float64Array, stride:integer )\n Computes the sum of double-precision floating-point strided array elements.\n"
19721972
base.strided.dsum.ndarray,"\nbase.strided.dsum.ndarray( N:integer, x:Float64Array, stride:integer, \n offset:integer )\n Computes the sum of double-precision floating-point strided array elements\n using alternative indexing semantics.\n"
1973-
base.strided.dsumkbn,"\nbase.strided.dsumkbn( N:integer, x:Float64Array, stride:integer )\n Computes the sum of double-precision floating-point strided array elements\n using an improved Kahan–Babuška algorithm.\n"
1974-
base.strided.dsumkbn.ndarray,"\nbase.strided.dsumkbn.ndarray( N:integer, x:Float64Array, stride:integer, \n offset:integer )\n Computes the sum of double-precision floating-point strided array elements\n using an improved Kahan–Babuška algorithm and alternative indexing\n semantics.\n"
1973+
base.strided.dsumkbn,"\nbase.strided.dsumkbn( N:integer, x:Float64Array, strideX:integer )\n Computes the sum of double-precision floating-point strided array elements\n using an improved Kahan–Babuška algorithm.\n"
1974+
base.strided.dsumkbn.ndarray,"\nbase.strided.dsumkbn.ndarray( N:integer, x:Float64Array, strideX:integer, \n offsetX:integer )\n Computes the sum of double-precision floating-point strided array elements\n using an improved Kahan–Babuška algorithm and alternative indexing\n semantics.\n"
19751975
base.strided.dsumkbn2,"\nbase.strided.dsumkbn2( N:integer, x:Float64Array, stride:integer )\n Computes the sum of double-precision floating-point strided array elements\n using a second-order iterative Kahan–Babuška algorithm.\n"
19761976
base.strided.dsumkbn2.ndarray,"\nbase.strided.dsumkbn2.ndarray( N:integer, x:Float64Array, stride:integer, \n offset:integer )\n Computes the sum of double-precision floating-point strided array elements\n using a second-order iterative Kahan–Babuška algorithm and alternative\n indexing semantics.\n"
19771977
base.strided.dsumors,"\nbase.strided.dsumors( N:integer, x:Float64Array, stride:integer )\n Computes the sum of double-precision floating-point strided array elements\n using ordinary recursive summation.\n"
@@ -4125,6 +4125,7 @@ ndat,"\nndat( x:ndarray[, ...indices:integer] )\n Returns an ndarray element.
41254125
ndempty,"\nndempty( shape:ArrayLikeObject<integer>|integer[, options:Object] )\n Returns an uninitialized ndarray having a specified shape and data type.\n"
41264126
ndemptyLike,"\nndemptyLike( x:ndarray[, options:Object] )\n Returns an uninitialized ndarray having the same shape and data type as a\n provided input ndarray.\n"
41274127
ndfilter,"\nndfilter( x:ndarray[, options:Object], predicate:Function[, thisArg:any] )\n Returns a shallow copy of an ndarray containing only those elements which\n pass a test implemented by a predicate function.\n"
4128+
ndfilterMap,"\nndfilterMap( x:ndarray[, options:Object], fcn:Function[, thisArg:any] )\n Filters and maps elements in an input ndarray to elements in a new output\n ndarray according to a callback function.\n"
41284129
ndims,"\nndims( x:ndarray )\n Returns the number of ndarray dimensions.\n"
41294130
nditerColumnEntries,"\nnditerColumnEntries( x:ndarray[, options:Object] )\n Returns an iterator which returns [index, column] pairs for each column in a\n matrix (or stack of matrices).\n"
41304131
nditerColumns,"\nnditerColumns( x:ndarray[, options:Object] )\n Returns an iterator which iterates over each column in a matrix (or stack of\n matrices).\n"

lib/node_modules/@stdlib/repl/info/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/signature/data/data.csv

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1971,8 +1971,8 @@ base.strided.dstdevyc,"base.strided.dstdevyc( N, correction, x, stride )"
19711971
base.strided.dstdevyc.ndarray,"base.strided.dstdevyc.ndarray( N, correction, x, stride, offset )"
19721972
base.strided.dsum,"base.strided.dsum( N, x, stride )"
19731973
base.strided.dsum.ndarray,"base.strided.dsum.ndarray( N, x, stride, offset )"
1974-
base.strided.dsumkbn,"base.strided.dsumkbn( N, x, stride )"
1975-
base.strided.dsumkbn.ndarray,"base.strided.dsumkbn.ndarray( N, x, stride, offset )"
1974+
base.strided.dsumkbn,"base.strided.dsumkbn( N, x, strideX )"
1975+
base.strided.dsumkbn.ndarray,"base.strided.dsumkbn.ndarray( N, x, strideX, offsetX )"
19761976
base.strided.dsumkbn2,"base.strided.dsumkbn2( N, x, stride )"
19771977
base.strided.dsumkbn2.ndarray,"base.strided.dsumkbn2.ndarray( N, x, stride, offset )"
19781978
base.strided.dsumors,"base.strided.dsumors( N, x, stride )"
@@ -4177,6 +4177,7 @@ ndat,"ndat( x[, ...indices] )"
41774177
ndempty,"ndempty( shape[, options] )"
41784178
ndemptyLike,"ndemptyLike( x[, options] )"
41794179
ndfilter,"ndfilter( x[, options], predicate[, thisArg] )"
4180+
ndfilterMap,"ndfilterMap( x[, options], fcn[, thisArg] )"
41804181
ndims,"ndims( x )"
41814182
nditerColumnEntries,"nditerColumnEntries( x[, options] )"
41824183
nditerColumns,"nditerColumns( x[, options] )"

lib/node_modules/@stdlib/repl/signature/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/typed-signature/data/data.csv

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1971,8 +1971,8 @@ base.strided.dstdevyc,"base.strided.dstdevyc( N:integer, correction:number, x:Fl
19711971
base.strided.dstdevyc.ndarray,"base.strided.dstdevyc.ndarray( N:integer, correction:number, x:Float64Array, stride:integer, offset:integer )"
19721972
base.strided.dsum,"base.strided.dsum( N:integer, x:Float64Array, stride:integer )"
19731973
base.strided.dsum.ndarray,"base.strided.dsum.ndarray( N:integer, x:Float64Array, stride:integer, offset:integer )"
1974-
base.strided.dsumkbn,"base.strided.dsumkbn( N:integer, x:Float64Array, stride:integer )"
1975-
base.strided.dsumkbn.ndarray,"base.strided.dsumkbn.ndarray( N:integer, x:Float64Array, stride:integer, offset:integer )"
1974+
base.strided.dsumkbn,"base.strided.dsumkbn( N:integer, x:Float64Array, strideX:integer )"
1975+
base.strided.dsumkbn.ndarray,"base.strided.dsumkbn.ndarray( N:integer, x:Float64Array, strideX:integer, offsetX:integer )"
19761976
base.strided.dsumkbn2,"base.strided.dsumkbn2( N:integer, x:Float64Array, stride:integer )"
19771977
base.strided.dsumkbn2.ndarray,"base.strided.dsumkbn2.ndarray( N:integer, x:Float64Array, stride:integer, offset:integer )"
19781978
base.strided.dsumors,"base.strided.dsumors( N:integer, x:Float64Array, stride:integer )"
@@ -4177,6 +4177,7 @@ ndat,"ndat( x:ndarray[, ...indices:integer] )"
41774177
ndempty,"ndempty( shape:ArrayLikeObject<integer>|integer[, options:Object] )"
41784178
ndemptyLike,"ndemptyLike( x:ndarray[, options:Object] )"
41794179
ndfilter,"ndfilter( x:ndarray[, options:Object], predicate:Function[, thisArg:any] )"
4180+
ndfilterMap,"ndfilterMap( x:ndarray[, options:Object], fcn:Function[, thisArg:any] )"
41804181
ndims,"ndims( x:ndarray )"
41814182
nditerColumnEntries,"nditerColumnEntries( x:ndarray[, options:Object] )"
41824183
nditerColumns,"nditerColumns( x:ndarray[, options:Object] )"

lib/node_modules/@stdlib/repl/typed-signature/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)