Skip to content

docs: update REPL namespace documentation #5365

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
Feb 22, 2025
Merged

docs: update REPL namespace documentation #5365

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
18 changes: 9 additions & 9 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 @@ -2102,8 +2102,8 @@ base.strided.maxabs,"var x = [ 1.0, -2.0, 2.0 ];\nbase.strided.maxabs( x.length,
base.strided.maxabs.ndarray,"var x = [ 1.0, -2.0, 2.0 ];\nbase.strided.maxabs.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];\nbase.strided.maxabs.ndarray( 3, x, 2, 1 )\n"
base.strided.maxBy,"function accessor( v ) { return v * 2.0; };\nvar x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];\nbase.strided.maxBy( x.length, x, 1, accessor )\nx = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.maxBy( N, x, 2, accessor )\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 );\nN = base.floor( x0.length / 2 );\nbase.strided.maxBy( N, x1, 2, accessor )\n"
base.strided.maxBy.ndarray,"function accessor( v ) { return v * 2.0; };\nvar x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];\nbase.strided.maxBy.ndarray( x.length, x, 1, 0, accessor )\nx = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.maxBy.ndarray( N, x, 2, 1, accessor )\n"
base.strided.maxsorted,"var x = [ 1.0, 2.0, 3.0 ];\nbase.strided.maxsorted( x.length, x, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];\nvar N = base.floor( x.length / 2 );\nvar stride = 2;\nbase.strided.maxsorted( N, x, stride )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nN = base.floor( x0.length / 2 );\nstride = 2;\nbase.strided.maxsorted( N, x1, stride )\n"
base.strided.maxsorted.ndarray,"var x = [ 1.0, 2.0, 3.0 ];\nbase.strided.maxsorted.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.maxsorted.ndarray( N, x, 2, 1 )\n"
base.strided.maxsorted,"var x = [ 1.0, 2.0, 3.0 ];\nbase.strided.maxsorted( x.length, x, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];\nbase.strided.maxsorted( 3, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.maxsorted( 3, x1, 2 )\n"
base.strided.maxsorted.ndarray,"var x = [ 1.0, 2.0, 3.0 ];\nbase.strided.maxsorted.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ];\nbase.strided.maxsorted.ndarray( 3, x, 2, 1 )\n"
base.strided.maxViewBufferIndex,"var idx = base.strided.maxViewBufferIndex( 3, 2, 10 )\n"
base.strided.mean,"var x = [ 1.0, -2.0, 2.0 ];\nbase.strided.mean( x.length, x, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];\nvar N = base.floor( x.length / 2 );\nvar stride = 2;\nbase.strided.mean( 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.mean( N, x1, stride )\n"
base.strided.mean.ndarray,"var x =[ 1.0, -2.0, 2.0 ];\nbase.strided.mean.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.mean.ndarray( N, x, 2, 1 )\n"
Expand All @@ -2119,20 +2119,20 @@ base.strided.meanpw,"var x = [ 1.0, -2.0, 2.0 ];\nbase.strided.meanpw( x.length,
base.strided.meanpw.ndarray,"var x =[ 1.0, -2.0, 2.0 ];\nbase.strided.meanpw.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.meanpw.ndarray( N, x, 2, 1 )\n"
base.strided.meanwd,"var x = [ 1.0, -2.0, 2.0 ];\nbase.strided.meanwd( x.length, x, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];\nvar N = base.floor( x.length / 2 );\nvar stride = 2;\nbase.strided.meanwd( 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.meanwd( N, x1, stride )\n"
base.strided.meanwd.ndarray,"var x =[ 1.0, -2.0, 2.0 ];\nbase.strided.meanwd.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.meanwd.ndarray( N, x, 2, 1 )\n"
base.strided.mediansorted,"var x = [ 1.0, 2.0, 3.0 ];\nbase.strided.mediansorted( x.length, x, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.mediansorted( N, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nN = base.floor( x0.length / 2 );\nbase.strided.mediansorted( N, x1, 2 )\n"
base.strided.mediansorted.ndarray,"var x = [ 1.0, 2.0, 3.0 ];\nbase.strided.mediansorted.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.mediansorted.ndarray( N, x, 2, 1 )\n"
base.strided.mediansorted,"var x = [ 1.0, 2.0, 3.0 ];\nbase.strided.mediansorted( x.length, x, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];\nbase.strided.mediansorted( 3, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.mediansorted( 3, x1, 2 )\n"
base.strided.mediansorted.ndarray,"var x = [ 1.0, 2.0, 3.0 ];\nbase.strided.mediansorted.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ];\nbase.strided.mediansorted.ndarray( 3, x, 2, 1 )\n"
base.strided.metaDataProps,"var meta = { 'nargs': 7, 'nin': 1, 'nout': 1 };\nvar dt = [ 'float64', 'float64' ];\nvar obj = {};\nbase.strided.metaDataProps( meta, dt, obj, false );\nobj.nargs\nobj.nin\nobj.nout\nobj.types\n"
base.strided.min,"var x = [ 1.0, -2.0, 2.0 ];\nbase.strided.min( x.length, x, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];\nbase.strided.min( 3, 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.min( 3, x1, 2 )\n"
base.strided.min.ndarray,"var x = [ 1.0, -2.0, 2.0 ];\nbase.strided.min.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];\nbase.strided.min.ndarray( 3, x, 2, 1 )\n"
base.strided.minabs,"var x = [ 1.0, -2.0, 2.0 ];\nbase.strided.minabs( x.length, x, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];\nbase.strided.minabs( 3, 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.minabs( 3, x1, 2 )\n"
base.strided.minabs.ndarray,"var x = [ 1.0, -2.0, 2.0 ];\nbase.strided.minabs.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];\nbase.strided.minabs.ndarray( 3, x, 2, 1 )\n"
base.strided.minBy,"function accessor( v ) { return v * 2.0; };\nvar x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];\nbase.strided.minBy( x.length, x, 1, accessor )\nx = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.minBy( N, x, 2, accessor )\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 );\nN = base.floor( x0.length / 2 );\nbase.strided.minBy( N, x1, 2, accessor )\n"
base.strided.minBy.ndarray,"function accessor( v ) { return v * 2.0; };\nvar x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ];\nbase.strided.minBy.ndarray( x.length, x, 1, 0, accessor )\nx = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.minBy.ndarray( N, x, 2, 1, accessor )\n"
base.strided.minsorted,"var x = [ 1.0, 2.0, 3.0 ];\nbase.strided.minsorted( x.length, x, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];\nvar N = base.floor( x.length / 2 );\nvar stride = 2;\nbase.strided.minsorted( N, x, stride )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nN = base.floor( x0.length / 2 );\nstride = 2;\nbase.strided.minsorted( N, x1, stride )\n"
base.strided.minsorted.ndarray,"var x = [ 1.0, 2.0, 3.0 ];\nbase.strided.minsorted.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.minsorted.ndarray( N, x, 2, 1 )\n"
base.strided.minsorted,"var x = [ 1.0, 2.0, 3.0 ];\nbase.strided.minsorted( x.length, x, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];\nbase.strided.minsorted( 3, x, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nbase.strided.minsorted( 3, x1, 2 )\n"
base.strided.minsorted.ndarray,"var x = [ 1.0, 2.0, 3.0 ];\nbase.strided.minsorted.ndarray( x.length, x, 1, 0 )\nvar x = [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ];\nbase.strided.minsorted.ndarray( 3, x, 2, 1 )\n"
base.strided.minViewBufferIndex,"var idx = base.strided.minViewBufferIndex( 3, -2, 10 )\n"
base.strided.mskmax,"var x = [ 1.0, -2.0, 4.0, 2.0 ];\nvar mask = [ 0, 0, 1, 0 ];\nbase.strided.mskmax( x.length, x, 1, mask, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, 4.0 ];\nmask = [ 0, 0, 0, 0, 0, 0, 1 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.mskmax( N, x, 2, mask, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, 4.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nvar mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1 ] );\nvar mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 );\nN = base.floor( x0.length / 2 );\nbase.strided.mskmax( N, x1, 2, mask1, 2 )\n"
base.strided.mskmax.ndarray,"var x = [ 1.0, -2.0, 2.0, 4.0 ];\nvar mask = [ 0, 0, 0, 1 ];\nbase.strided.mskmax.ndarray( x.length, x, 1, 0, mask, 1, 0 )\nx = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, 4.0 ];\nmask = [ 0, 0, 0, 0, 0, 0, 1 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.mskmax.ndarray( N, x, 2, 1, mask, 2, 1 )\n"
base.strided.mskmax,"var x = [ 1.0, -2.0, 4.0, 2.0 ];\nvar mask = [ 0, 0, 1, 0 ];\nbase.strided.mskmax( x.length, x, 1, mask, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, 4.0 ];\nmask = [ 0, 0, 0, 0, 0, 0, 1 ];\nbase.strided.mskmax( 3, x, 2, mask, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, 4.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nvar mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1 ] );\nvar mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 );\nbase.strided.mskmax( 3, x1, 2, mask1, 2 )\n"
base.strided.mskmax.ndarray,"var x = [ 1.0, -2.0, 2.0, 4.0 ];\nvar mask = [ 0, 0, 0, 1 ];\nbase.strided.mskmax.ndarray( x.length, x, 1, 0, mask, 1, 0 )\nx = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, 4.0 ];\nmask = [ 0, 0, 0, 0, 0, 0, 1 ];\nbase.strided.mskmax.ndarray( 3, x, 2, 1, mask, 2, 1 )\n"
base.strided.mskmin,"var x = [ 1.0, -2.0, -4.0, 2.0 ];\nvar mask = [ 0, 0, 1, 0 ];\nbase.strided.mskmin( x.length, x, 1, mask, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, -4.0 ];\nmask = [ 0, 0, 0, 0, 0, 0, 1 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.mskmin( N, x, 2, mask, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, -4.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nvar mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1 ] );\nvar mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 );\nN = base.floor( x0.length / 2 );\nbase.strided.mskmin( N, x1, 2, mask1, 2 )\n"
base.strided.mskmin.ndarray,"var x = [ 1.0, -2.0, 2.0, -4.0 ];\nvar mask = [ 0, 0, 0, 1 ];\nbase.strided.mskmin.ndarray( x.length, x, 1, 0, mask, 1, 0 )\nx = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, -4.0 ];\nmask = [ 0, 0, 0, 0, 0, 0, 1 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.mskmin.ndarray( N, x, 2, 1, mask, 2, 1 )\n"
base.strided.mskrange,"var x = [ 1.0, -2.0, 4.0, 2.0 ];\nvar mask = [ 0, 0, 1, 0 ];\nbase.strided.mskrange( x.length, x, 1, mask, 1 )\nx = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, 4.0 ];\nmask = [ 0, 0, 0, 0, 0, 0, 1 ];\nvar N = base.floor( x.length / 2 );\nbase.strided.mskrange( N, x, 2, mask, 2 )\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, 4.0 ] );\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 );\nvar mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1 ] );\nvar mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 );\nN = base.floor( x0.length / 2 );\nbase.strided.mskrange( N, x1, 2, mask1, 2 )\n"
Expand Down Expand Up @@ -3556,7 +3556,7 @@ isMatrixLike,"var M = {};\nM.data = [ 0, 0, 0, 0 ];\nM.ndims = 2;\nM.shape = [ 2
isMethod,"var beep = { 'boop': function beep() { return 'beep'; } };\nvar bool = isMethod( beep, 'boop' )\nbool = isMethod( beep, 'toString' )\n"
isMethodIn,"var beep = { 'boop': true };\nvar bool = isMethodIn( beep, 'toString' )\nbool = isMethodIn( beep, 'boop' )\nbool = isMethodIn( beep, 'bop' )\n"
isMultiSlice,"var bool = isMultiSlice( new MultiSlice() )\nbool = isMultiSlice( 3.14 )\nbool = isMultiSlice( {} )\n"
isNamedTypedTupleLike,"var Point = {{alias:@stdlib/dstructs/named-typed-tuple}}( [ 'x', 'y' ] );\nvar p = new Point();\nvar bool = isNamedTypedTupleLike( p )\nbool = isNamedTypedTupleLike( [ 1, 2, 3, 4 ] )\nbool = isNamedTypedTupleLike( 3.14 )\nbool = isNamedTypedTupleLike( {} )\n"
isNamedTypedTupleLike,"var Point = namedtypedtuple( [ 'x', 'y' ] );\nvar p = new Point();\nvar bool = isNamedTypedTupleLike( p )\nbool = isNamedTypedTupleLike( [ 1, 2, 3, 4 ] )\nbool = isNamedTypedTupleLike( 3.14 )\nbool = isNamedTypedTupleLike( {} )\n"
isnan,"var bool = isnan( NaN )\nbool = isnan( new Number( NaN ) )\nbool = isnan( 3.14 )\nbool = isnan( null )\n"
isnan.isPrimitive,"var bool = isnan.isPrimitive( NaN )\nbool = isnan.isPrimitive( 3.14 )\nbool = isnan.isPrimitive( new Number( NaN ) )\n"
isnan.isObject,"var bool = isnan.isObject( NaN )\nbool = isnan.isObject( new Number( NaN ) )\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.

Loading