Skip to content

Commit 903dd5a

Browse files
authored
docs: update REPL namespace documentation
PR-URL: #5255 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 8df3643 commit 903dd5a

File tree

16 files changed

+22
-12
lines changed

16 files changed

+22
-12
lines changed

lib/node_modules/@stdlib/namespace/alias2standalone/data/data.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1055,7 +1055,7 @@ base.strided.dinv,"@stdlib/math-strided-special-dinv"
10551055
base.strided.dmap,"@stdlib/strided-base-dmap"
10561056
base.strided.dmap2,"@stdlib/strided-base-dmap2"
10571057
base.strided.dmax,"@stdlib/stats-strided-dmax"
1058-
base.strided.dmaxabs,"@stdlib/stats-base-dmaxabs"
1058+
base.strided.dmaxabs,"@stdlib/stats-strided-dmaxabs"
10591059
base.strided.dmaxabssorted,"@stdlib/stats-base-dmaxabssorted"
10601060
base.strided.dmaxsorted,"@stdlib/stats-base-dmaxsorted"
10611061
base.strided.dmean,"@stdlib/stats-base-dmean"

lib/node_modules/@stdlib/namespace/alias2standalone/data/data.json

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

lib/node_modules/@stdlib/namespace/pkg2standalone/data/data.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1055,7 +1055,7 @@
10551055
"@stdlib/strided/base/dmap","@stdlib/strided-base-dmap"
10561056
"@stdlib/strided/base/dmap2","@stdlib/strided-base-dmap2"
10571057
"@stdlib/stats/strided/dmax","@stdlib/stats-strided-dmax"
1058-
"@stdlib/stats/strided/dmaxabs","@stdlib/stats-base-dmaxabs"
1058+
"@stdlib/stats/strided/dmaxabs","@stdlib/stats-strided-dmaxabs"
10591059
"@stdlib/stats/base/dmaxabssorted","@stdlib/stats-base-dmaxabssorted"
10601060
"@stdlib/stats/base/dmaxsorted","@stdlib/stats-base-dmaxsorted"
10611061
"@stdlib/stats/base/dmean","@stdlib/stats-base-dmean"

lib/node_modules/@stdlib/namespace/pkg2standalone/data/data.json

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

lib/node_modules/@stdlib/namespace/standalone2pkg/data/data.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1055,7 +1055,7 @@
10551055
"@stdlib/strided-base-dmap","@stdlib/strided/base/dmap"
10561056
"@stdlib/strided-base-dmap2","@stdlib/strided/base/dmap2"
10571057
"@stdlib/stats-strided-dmax","@stdlib/stats/strided/dmax"
1058-
"@stdlib/stats-base-dmaxabs","@stdlib/stats/strided/dmaxabs"
1058+
"@stdlib/stats-strided-dmaxabs","@stdlib/stats/strided/dmaxabs"
10591059
"@stdlib/stats-base-dmaxabssorted","@stdlib/stats/base/dmaxabssorted"
10601060
"@stdlib/stats-base-dmaxsorted","@stdlib/stats/base/dmaxsorted"
10611061
"@stdlib/stats-base-dmean","@stdlib/stats/base/dmean"

lib/node_modules/@stdlib/namespace/standalone2pkg/data/data.json

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,8 @@ base.cmul,"var z1 = new Complex128( 5.0, 3.0 )\nvar z2 = new Complex128( -2.0, 1
249249
base.cmul.assign,"var out = new Float64Array( 2 );\nbase.cmul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 )\n"
250250
base.cmul.strided,"var z1 = new Float64Array( [ 5.0, 3.0 ] );\nvar z2 = new Float64Array( [ -2.0, 1.0 ] );\nvar out = new Float64Array( 2 );\nbase.cmul.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 )\n"
251251
base.cmulf,"var z1 = new Complex64( 5.0, 3.0 )\nvar z2 = new Complex64( -2.0, 1.0 )\nvar out = base.cmulf( z1, z2 )\nvar re = realf( out )\nvar im = imagf( out )\n"
252+
base.cmulf.assign,"var out = new Float32Array( 2 );\nbase.cmulf.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 )\n"
253+
base.cmulf.strided,"var z1 = new Float32Array( [ 5.0, 3.0 ] );\nvar z2 = new Float32Array( [ -2.0, 1.0 ] );\nvar out = new Float32Array( 2 );\nbase.cmulf.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 )\n"
252254
base.cneg,"var z = new Complex128( -4.2, 5.5 )\nvar v = base.cneg( z )\nvar re = real( v )\nvar im = imag( v )\n"
253255
base.cnegf,"var z = new Complex64( -4.0, 5.0 )\nvar v = base.cnegf( z )\nvar re = realf( v )\nvar im = imagf( v )\n"
254256
base.codePointAt,"var out = base.codePointAt( 'last man standing', 4, false )\nout = base.codePointAt( 'presidential election', 8, true )\nout = base.codePointAt( 'अनुच्छेद', 2, false )\nout = base.codePointAt( '🌷', 1, true )\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: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,9 @@ base.clampf,"\nbase.clampf( v, min, max )\n Restricts a single-precision floa
248248
base.cmul,"\nbase.cmul( z1, z2 )\n Multiplies two double-precision complex floating-point numbers.\n\n Parameters\n ----------\n z1: Complex128\n Complex number.\n\n z2: Complex128\n Complex number.\n\n Returns\n -------\n out: Complex128\n Result.\n\n Examples\n --------\n > var z1 = new Complex128( 5.0, 3.0 )\n <Complex128>\n > var z2 = new Complex128( -2.0, 1.0 )\n <Complex128>\n > var out = base.cmul( z1, z2 )\n <Complex128>\n > var re = real( out )\n -13.0\n > var im = imag( out )\n -1.0\n\n\nbase.cmul.assign( re1, im1, re2, im2, out, strideOut, offsetOut )\n Multiplies two double-precision complex floating-point numbers and assigns\n results to a provided output array.\n\n Parameters\n ----------\n re1: number\n Real component of the first complex number.\n\n im1: number\n Imaginary component of the first complex number.\n\n re2: number\n Real component of the second complex number.\n\n im2: number\n Imaginary component of the second complex number.\n\n out: ArrayLikeObject\n Output array.\n\n strideOut: integer\n Stride length.\n\n offsetOut: integer\n Starting index.\n\n Returns\n -------\n out: ArrayLikeObject\n Output array.\n\n Examples\n --------\n > var out = new Float64Array( 2 );\n > base.cmul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 )\n <Float64Array>[ -13.0, -1.0 ]\n\n\nbase.cmul.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo )\n Multiplies two double-precision complex floating-point numbers stored in\n real-valued strided array views and assigns results to a provided strided\n output array.\n\n Parameters\n ----------\n z1: ArrayLikeObject\n First complex number view.\n\n sz1: integer\n Stride length for `z1`.\n\n oz1: integer\n Starting index for `z1`.\n\n z2: ArrayLikeObject\n Second complex number view.\n\n sz2: integer\n Stride length for `z2`.\n\n oz2: integer\n Starting index for `z2`.\n\n out: ArrayLikeObject\n Output array.\n\n so: integer\n Stride length for `out`.\n\n oo: integer\n Starting index for `out`.\n\n Returns\n -------\n out: ArrayLikeObject\n Output array.\n\n Examples\n --------\n > var z1 = new Float64Array( [ 5.0, 3.0 ] );\n > var z2 = new Float64Array( [ -2.0, 1.0 ] );\n > var out = new Float64Array( 2 );\n > base.cmul.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 )\n <Float64Array>[ -13.0, -1.0 ]\n\n See Also\n --------\n base.cadd, base.cdiv, base.csub\n"
249249
base.cmul.assign,"\nbase.cmul.assign( re1, im1, re2, im2, out, strideOut, offsetOut )\n Multiplies two double-precision complex floating-point numbers and assigns\n results to a provided output array.\n\n Parameters\n ----------\n re1: number\n Real component of the first complex number.\n\n im1: number\n Imaginary component of the first complex number.\n\n re2: number\n Real component of the second complex number.\n\n im2: number\n Imaginary component of the second complex number.\n\n out: ArrayLikeObject\n Output array.\n\n strideOut: integer\n Stride length.\n\n offsetOut: integer\n Starting index.\n\n Returns\n -------\n out: ArrayLikeObject\n Output array.\n\n Examples\n --------\n > var out = new Float64Array( 2 );\n > base.cmul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 )\n <Float64Array>[ -13.0, -1.0 ]"
250250
base.cmul.strided,"\nbase.cmul.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo )\n Multiplies two double-precision complex floating-point numbers stored in\n real-valued strided array views and assigns results to a provided strided\n output array.\n\n Parameters\n ----------\n z1: ArrayLikeObject\n First complex number view.\n\n sz1: integer\n Stride length for `z1`.\n\n oz1: integer\n Starting index for `z1`.\n\n z2: ArrayLikeObject\n Second complex number view.\n\n sz2: integer\n Stride length for `z2`.\n\n oz2: integer\n Starting index for `z2`.\n\n out: ArrayLikeObject\n Output array.\n\n so: integer\n Stride length for `out`.\n\n oo: integer\n Starting index for `out`.\n\n Returns\n -------\n out: ArrayLikeObject\n Output array.\n\n Examples\n --------\n > var z1 = new Float64Array( [ 5.0, 3.0 ] );\n > var z2 = new Float64Array( [ -2.0, 1.0 ] );\n > var out = new Float64Array( 2 );\n > base.cmul.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 )\n <Float64Array>[ -13.0, -1.0 ]\n\n See Also\n --------\n base.cadd, base.cdiv, base.csub"
251-
base.cmulf,"\nbase.cmulf( z1, z2 )\n Multiplies two single-precision complex floating-point numbers.\n\n Parameters\n ----------\n z1: Complex64\n Complex number.\n\n z2: Complex64\n Complex number.\n\n Returns\n -------\n out: Complex64\n Result.\n\n Examples\n --------\n > var z1 = new Complex64( 5.0, 3.0 )\n <Complex64>\n > var z2 = new Complex64( -2.0, 1.0 )\n <Complex64>\n > var out = base.cmulf( z1, z2 )\n <Complex64>\n > var re = realf( out )\n -13.0\n > var im = imagf( out )\n -1.0\n\n See Also\n --------\n base.caddf, base.cmul, base.csubf\n"
251+
base.cmulf,"\nbase.cmulf( z1, z2 )\n Multiplies two single-precision complex floating-point numbers.\n\n Parameters\n ----------\n z1: Complex64\n Complex number.\n\n z2: Complex64\n Complex number.\n\n Returns\n -------\n out: Complex64\n Result.\n\n Examples\n --------\n > var z1 = new Complex64( 5.0, 3.0 )\n <Complex64>\n > var z2 = new Complex64( -2.0, 1.0 )\n <Complex64>\n > var out = base.cmulf( z1, z2 )\n <Complex64>\n > var re = realf( out )\n -13.0\n > var im = imagf( out )\n -1.0\n\n\nbase.cmulf.assign( re1, im1, re2, im2, out, strideOut, offsetOut )\n Multiplies two single-precision complex floating-point numbers and assigns\n results to a provided output array.\n\n Parameters\n ----------\n re1: number\n Real component of the first complex number.\n\n im1: number\n Imaginary component of the first complex number.\n\n re2: number\n Real component of the second complex number.\n\n im2: number\n Imaginary component of the second complex number.\n\n out: ArrayLikeObject\n Output array.\n\n strideOut: integer\n Stride length.\n\n offsetOut: integer\n Starting index.\n\n Returns\n -------\n out: ArrayLikeObject\n Output array.\n\n Examples\n --------\n > var out = new Float32Array( 2 );\n > base.cmulf.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 )\n <Float32Array>[ -13.0, -1.0 ]\n\n\nbase.cmulf.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo )\n Multiplies two single-precision complex floating-point numbers stored in\n real-valued strided array views and assigns results to a provided strided\n output array.\n\n Parameters\n ----------\n z1: ArrayLikeObject\n First complex number view.\n\n sz1: integer\n Stride length for `z1`.\n\n oz1: integer\n Starting index for `z1`.\n\n z2: ArrayLikeObject\n Second complex number view.\n\n sz2: integer\n Stride length for `z2`.\n\n oz2: integer\n Starting index for `z2`.\n\n out: ArrayLikeObject\n Output array.\n\n so: integer\n Stride length for `out`.\n\n oo: integer\n Starting index for `out`.\n\n Returns\n -------\n out: ArrayLikeObject\n Output array.\n\n Examples\n --------\n > var z1 = new Float32Array( [ 5.0, 3.0 ] );\n > var z2 = new Float32Array( [ -2.0, 1.0 ] );\n > var out = new Float32Array( 2 );\n > base.cmulf.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 )\n <Float32Array>[ -13.0, -1.0 ]\n\n See Also\n --------\n base.caddf, base.cmul, base.csubf\n"
252+
base.cmulf.assign,"\nbase.cmulf.assign( re1, im1, re2, im2, out, strideOut, offsetOut )\n Multiplies two single-precision complex floating-point numbers and assigns\n results to a provided output array.\n\n Parameters\n ----------\n re1: number\n Real component of the first complex number.\n\n im1: number\n Imaginary component of the first complex number.\n\n re2: number\n Real component of the second complex number.\n\n im2: number\n Imaginary component of the second complex number.\n\n out: ArrayLikeObject\n Output array.\n\n strideOut: integer\n Stride length.\n\n offsetOut: integer\n Starting index.\n\n Returns\n -------\n out: ArrayLikeObject\n Output array.\n\n Examples\n --------\n > var out = new Float32Array( 2 );\n > base.cmulf.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 )\n <Float32Array>[ -13.0, -1.0 ]"
253+
base.cmulf.strided,"\nbase.cmulf.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo )\n Multiplies two single-precision complex floating-point numbers stored in\n real-valued strided array views and assigns results to a provided strided\n output array.\n\n Parameters\n ----------\n z1: ArrayLikeObject\n First complex number view.\n\n sz1: integer\n Stride length for `z1`.\n\n oz1: integer\n Starting index for `z1`.\n\n z2: ArrayLikeObject\n Second complex number view.\n\n sz2: integer\n Stride length for `z2`.\n\n oz2: integer\n Starting index for `z2`.\n\n out: ArrayLikeObject\n Output array.\n\n so: integer\n Stride length for `out`.\n\n oo: integer\n Starting index for `out`.\n\n Returns\n -------\n out: ArrayLikeObject\n Output array.\n\n Examples\n --------\n > var z1 = new Float32Array( [ 5.0, 3.0 ] );\n > var z2 = new Float32Array( [ -2.0, 1.0 ] );\n > var out = new Float32Array( 2 );\n > base.cmulf.strided( z1, 1, 0, z2, 1, 0, out, 1, 0 )\n <Float32Array>[ -13.0, -1.0 ]\n\n See Also\n --------\n base.caddf, base.cmul, base.csubf"
252254
base.cneg,"\nbase.cneg( z )\n Negates a double-precision complex floating-point number.\n\n Parameters\n ----------\n z: Complex128\n Complex number.\n\n Returns\n -------\n out: Complex128\n Result.\n\n Examples\n --------\n > var z = new Complex128( -4.2, 5.5 )\n <Complex128>\n > var v = base.cneg( z )\n <Complex128>\n > var re = real( v )\n 4.2\n > var im = imag( v )\n -5.5\n\n See Also\n --------\n base.cabs\n"
253255
base.cnegf,"\nbase.cnegf( z )\n Negates a single-precision complex floating-point number.\n\n Parameters\n ----------\n z: Complex64\n Complex number.\n\n Returns\n -------\n out: Complex64\n Result.\n\n Examples\n --------\n > var z = new Complex64( -4.0, 5.0 )\n <Complex64>\n > var v = base.cnegf( z )\n <Complex64>\n > var re = realf( v )\n 4.0\n > var im = imagf( v )\n -5.0\n\n See Also\n --------\n base.cneg, base.cabsf\n"
254256
base.codePointAt,"\nbase.codePointAt( str, idx, backward )\n Returns a Unicode code point from a string at a specified position.\n\n Parameters\n ----------\n str: string\n Input string.\n\n idx: integer\n Position. If less than `0`, the string position is determined relative\n to the end of the input string.\n\n backward: boolean\n Backward iteration for low surrogates.\n\n Returns\n -------\n out: integer\n Unicode code point.\n\n Examples\n --------\n > var out = base.codePointAt( 'last man standing', 4, false )\n 32\n > out = base.codePointAt( 'presidential election', 8, true )\n 116\n > out = base.codePointAt( 'अनुच्छेद', 2, false )\n 2369\n > out = base.codePointAt( '🌷', 1, true )\n 127799\n"

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: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,8 @@ base.cmul,"\nbase.cmul( z1:Complex128, z2:Complex128 )\n Multiplies two doubl
249249
base.cmul.assign,"\nbase.cmul.assign( re1:number, im1:number, re2:number, im2:number, \n out:ArrayLikeObject, strideOut:integer, offsetOut:integer )\n Multiplies two double-precision complex floating-point numbers and assigns\n results to a provided output array.\n"
250250
base.cmul.strided,"\nbase.cmul.strided( z1:ArrayLikeObject, sz1:integer, oz1:integer, \n z2:ArrayLikeObject, sz2:integer, oz2:integer, out:ArrayLikeObject, \n so:integer, oo:integer )\n Multiplies two double-precision complex floating-point numbers stored in\n real-valued strided array views and assigns results to a provided strided\n output array.\n"
251251
base.cmulf,"\nbase.cmulf( z1:Complex64, z2:Complex64 )\n Multiplies two single-precision complex floating-point numbers.\n"
252+
base.cmulf.assign,"\nbase.cmulf.assign( re1:number, im1:number, re2:number, im2:number, \n out:ArrayLikeObject, strideOut:integer, offsetOut:integer )\n Multiplies two single-precision complex floating-point numbers and assigns\n results to a provided output array.\n"
253+
base.cmulf.strided,"\nbase.cmulf.strided( z1:ArrayLikeObject, sz1:integer, oz1:integer, \n z2:ArrayLikeObject, sz2:integer, oz2:integer, out:ArrayLikeObject, \n so:integer, oo:integer )\n Multiplies two single-precision complex floating-point numbers stored in\n real-valued strided array views and assigns results to a provided strided\n output array.\n"
252254
base.cneg,"\nbase.cneg( z )\n Negates a double-precision complex floating-point number.\n"
253255
base.cnegf,"\nbase.cnegf( z )\n Negates a single-precision complex floating-point number.\n"
254256
base.codePointAt,"\nbase.codePointAt( str:string, idx:integer, backward:boolean )\n Returns a Unicode code point from a string at a specified position.\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: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,8 @@ base.cmul,"base.cmul( z1, z2 )"
249249
base.cmul.assign,"base.cmul.assign( re1, im1, re2, im2, out, strideOut, offsetOut )"
250250
base.cmul.strided,"base.cmul.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo )"
251251
base.cmulf,"base.cmulf( z1, z2 )"
252+
base.cmulf.assign,"base.cmulf.assign( re1, im1, re2, im2, out, strideOut, offsetOut )"
253+
base.cmulf.strided,"base.cmulf.strided( z1, sz1, oz1, z2, sz2, oz2, out, so, oo )"
252254
base.cneg,"base.cneg( z )"
253255
base.cnegf,"base.cnegf( z )"
254256
base.codePointAt,"base.codePointAt( str, idx, backward )"

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: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,8 @@ base.cmul,"base.cmul( z1:Complex128, z2:Complex128 )"
249249
base.cmul.assign,"base.cmul.assign( re1:number, im1:number, re2:number, im2:number, out:ArrayLikeObject, strideOut:integer, offsetOut:integer )"
250250
base.cmul.strided,"base.cmul.strided( z1:ArrayLikeObject, sz1:integer, oz1:integer, z2:ArrayLikeObject, sz2:integer, oz2:integer, out:ArrayLikeObject, so:integer, oo:integer )"
251251
base.cmulf,"base.cmulf( z1:Complex64, z2:Complex64 )"
252+
base.cmulf.assign,"base.cmulf.assign( re1:number, im1:number, re2:number, im2:number, out:ArrayLikeObject, strideOut:integer, offsetOut:integer )"
253+
base.cmulf.strided,"base.cmulf.strided( z1:ArrayLikeObject, sz1:integer, oz1:integer, z2:ArrayLikeObject, sz2:integer, oz2:integer, out:ArrayLikeObject, so:integer, oo:integer )"
252254
base.cneg,"base.cneg( z )"
253255
base.cnegf,"base.cnegf( z )"
254256
base.codePointAt,"base.codePointAt( str:string, idx:integer, backward:boolean )"

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)