Skip to content

Commit 33a845a

Browse files
authored
docs: update REPL namespace documentation
PR-URL: #10478 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 500788a commit 33a845a

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
abs,"var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ];\nvar x = array( arr );\nvar y = abs( x );\nndarray2array( y )\n"
2-
abs.assign,"var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ];\nvar x = array( arr );\nvar sh = ndarrayShape( x );\nvar y = ndzeros( sh );\nvar out = abs.assign( x, y );\nvar bool = ( out === y )\nndarray2array( y )\n"
1+
abs,"var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ];\nvar x = array( arr );\nvar y = abs( x )\n"
2+
abs.assign,"var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ];\nvar x = array( arr );\nvar sh = ndarrayShape( x );\nvar y = ndzeros( sh );\nvar out = abs.assign( x, y )\nvar bool = ( out === y )\n"
33
acartesianPower,"var x = [ 1, 2 ];\nvar out = acartesianPower( x, 2 )\n"
44
acartesianProduct,"var x1 = [ 1, 2 ];\nvar x2 = [ 3, 4 ];\nvar out = acartesianProduct( x1, x2 )\n"
55
acartesianSquare,"var out = acartesianSquare( [ 1, 2 ] )\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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
abs,"\nabs( x[, options] )\n Computes the absolute value for each element in an ndarray.\n\n The function returns an ndarray having the same shape as the input ndarray.\n\n Parameters\n ----------\n x: ndarray\n Input array. Must have a numeric or \"generic\" data type.\n\n options: Object (optional)\n Options.\n\n options.dtype: string|DataType (optional)\n Output array data type. Must be a real-valued or \"generic\" data type.\n\n options.order: string (optional)\n Output array order. Must be either row-major (C-style) or column-major\n (Fortran-style). By default, the order of the output array is the same\n as the input array.\n\n Returns\n -------\n y: ndarray\n Output array containing element-wise results.\n\n Examples\n --------\n > var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ];\n > var x = array( arr );\n > var y = abs( x );\n > ndarray2array( y )\n [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]\n\n\nabs.assign( x, y )\n Computes the absolute value for each element in an ndarray and assigns\n results to a provided output ndarray.\n\n Parameters\n ----------\n x: ndarray\n Input array. Must have a numeric or \"generic\" data type.\n\n y: ndarray\n Output array.\n\n Returns\n -------\n y: ndarray\n Output array.\n\n Examples\n --------\n > var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ];\n > var x = array( arr );\n > var sh = ndarrayShape( x );\n > var y = ndzeros( sh );\n > var out = abs.assign( x, y );\n > var bool = ( out === y )\n true\n > ndarray2array( y )\n [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]\n\n"
2-
abs.assign,"\nabs.assign( x, y )\n Computes the absolute value for each element in an ndarray and assigns\n results to a provided output ndarray.\n\n Parameters\n ----------\n x: ndarray\n Input array. Must have a numeric or \"generic\" data type.\n\n y: ndarray\n Output array.\n\n Returns\n -------\n y: ndarray\n Output array.\n\n Examples\n --------\n > var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ];\n > var x = array( arr );\n > var sh = ndarrayShape( x );\n > var y = ndzeros( sh );\n > var out = abs.assign( x, y );\n > var bool = ( out === y )\n true\n > ndarray2array( y )\n [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]"
1+
abs,"\nabs( x[, options] )\n Computes the absolute value for each element in an ndarray.\n\n The function returns an ndarray having the same shape as the input ndarray.\n\n Parameters\n ----------\n x: ndarray\n Input array. Must have a numeric or \"generic\" data type.\n\n options: Object (optional)\n Options.\n\n options.dtype: string|DataType (optional)\n Output array data type. Must be a real-valued or \"generic\" data type.\n\n options.order: string (optional)\n Output array order. Must be either row-major (C-style) or column-major\n (Fortran-style). By default, the order of the output array is the same\n as the input array.\n\n Returns\n -------\n y: ndarray\n Output array containing element-wise results.\n\n Examples\n --------\n > var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ];\n > var x = array( arr );\n > var y = abs( x )\n <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]\n\n\nabs.assign( x, y )\n Computes the absolute value for each element in an ndarray and assigns\n results to a provided output ndarray.\n\n Parameters\n ----------\n x: ndarray\n Input array. Must have a numeric or \"generic\" data type.\n\n y: ndarray\n Output array.\n\n Returns\n -------\n y: ndarray\n Output array.\n\n Examples\n --------\n > var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ];\n > var x = array( arr );\n > var sh = ndarrayShape( x );\n > var y = ndzeros( sh );\n > var out = abs.assign( x, y )\n <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]\n > var bool = ( out === y )\n true\n\n"
2+
abs.assign,"\nabs.assign( x, y )\n Computes the absolute value for each element in an ndarray and assigns\n results to a provided output ndarray.\n\n Parameters\n ----------\n x: ndarray\n Input array. Must have a numeric or \"generic\" data type.\n\n y: ndarray\n Output array.\n\n Returns\n -------\n y: ndarray\n Output array.\n\n Examples\n --------\n > var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ];\n > var x = array( arr );\n > var sh = ndarrayShape( x );\n > var y = ndzeros( sh );\n > var out = abs.assign( x, y )\n <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]\n > var bool = ( out === y )\n true"
33
acartesianPower,"\nacartesianPower( x, n )\n Returns the Cartesian power.\n\n If provided an empty array, the function returns an empty array.\n\n If `n` is less than or equal to zero, the function returns an empty array.\n\n Parameters\n ----------\n x: ArrayLikeObject\n Input array.\n\n n: integer\n Power.\n\n Returns\n -------\n out: Array<Array>\n Cartesian product.\n\n Examples\n --------\n > var x = [ 1, 2 ];\n > var out = acartesianPower( x, 2 )\n [ [ 1, 1 ], [ 1, 2 ], [ 2, 1 ], [ 2, 2 ] ]\n\n See Also\n --------\n acartesianProduct, acartesianSquare\n"
44
acartesianProduct,"\nacartesianProduct( x1, x2 )\n Returns the Cartesian product.\n\n If provided one or more empty arrays, the function returns an empty array.\n\n Parameters\n ----------\n x1: ArrayLikeObject\n First input array.\n\n x2: ArrayLikeObject\n Second input array.\n\n Returns\n -------\n out: Array<Array>\n Cartesian product.\n\n Examples\n --------\n > var x1 = [ 1, 2 ];\n > var x2 = [ 3, 4 ];\n > var out = acartesianProduct( x1, x2 )\n [ [ 1, 3 ], [ 1, 4 ], [ 2, 3 ], [ 2, 4 ] ]\n\n See Also\n --------\n acartesianPower, acartesianSquare\n"
55
acartesianSquare,"\nacartesianSquare( x )\n Returns the Cartesian square.\n\n If provided an empty array, the function returns an empty array.\n\n Parameters\n ----------\n x: ArrayLikeObject\n Input array.\n\n Returns\n -------\n out: Array<Array>\n Cartesian product.\n\n Examples\n --------\n > var out = acartesianSquare( [ 1, 2 ] )\n [ [ 1, 1 ], [ 1, 2 ], [ 2, 1 ], [ 2, 2 ] ]\n\n See Also\n --------\n acartesianPower, acartesianProduct\n"

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

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

0 commit comments

Comments
 (0)