docs: update REPL docs

stdlib-js · Aug 17, 2024 · 5f8d50d · 5f8d50d · stdlib-bot · Aug 17, 2024
1 parent df3ed1e
commit 5f8d50d
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 4 deletions.
diff --git a/lib/node_modules/@stdlib/repl/code-blocks/data/data.csv b/lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
@@ -4101,6 +4101,7 @@ ndarrayDispatch,"var t = [ 'float64', 'float64', 'float32', 'float32' ];\nvar d
 ndarrayFlag,"var out = ndarrayFlag( ndzeros( [ 3, 3, 3 ] ), 'READONLY' )\n"
 ndarrayFlags,"var out = ndarrayFlags( ndzeros( [ 3, 3, 3 ] ) )\n"
 ndarrayIndexModes,"var out = ndarrayIndexModes()\n"
+ndarraylike2ndarray,"var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar out = ndarraylike2ndarray( arr )\n"
 ndarrayMinDataType,"var dt = ndarrayMinDataType( 3.141592653589793 )\ndt = ndarrayMinDataType( 3 )\ndt = ndarrayMinDataType( -3 )\ndt = ndarrayMinDataType( '-3' )\n"
 ndarrayMostlySafeCasts,"var out = ndarrayMostlySafeCasts( 'float32' )\n"
 ndarrayNextDataType,"var out = ndarrayNextDataType( 'float32' )\n"

diff --git a/lib/node_modules/@stdlib/repl/code-blocks/data/data.json b/lib/node_modules/@stdlib/repl/code-blocks/data/data.json
diff --git a/lib/node_modules/@stdlib/repl/info/data/data.csv b/lib/node_modules/@stdlib/repl/info/data/data.csv
@@ -4102,6 +4102,7 @@ ndarrayDispatch,"\nndarrayDispatch( fcns:Function|ArrayLikeObject<Function>, \n
 ndarrayFlag,"\nndarrayFlag( x:ndarray, name:string|symbol )\n    Returns a specified flag for a provided ndarray.\n"
 ndarrayFlags,"\nndarrayFlags( x:ndarray )\n    Returns the flags of a provided ndarray.\n"
 ndarrayIndexModes,"\nndarrayIndexModes()\n    Returns a list of ndarray index modes.\n"
+ndarraylike2ndarray,"\nndarraylike2ndarray( x:ndarrayLike[, options:Object] )\n    Converts an ndarray-like object to an ndarray.\n"
 ndarrayMinDataType,"\nndarrayMinDataType( value:any )\n    Returns the minimum ndarray data type of the closest \"kind\" necessary for\n    storing a provided scalar value.\n"
 ndarrayMostlySafeCasts,"\nndarrayMostlySafeCasts( [dtype:any] )\n    Returns a list of ndarray data types to which a provided ndarray data type\n    can be safely cast and, for floating-point data types, can be downcast.\n"
 ndarrayNextDataType,"\nndarrayNextDataType( [dtype:any] )\n    Returns the next larger ndarray data type of the same kind.\n"

diff --git a/lib/node_modules/@stdlib/repl/info/data/data.json b/lib/node_modules/@stdlib/repl/info/data/data.json
diff --git a/lib/node_modules/@stdlib/repl/signature/data/data.csv b/lib/node_modules/@stdlib/repl/signature/data/data.csv
@@ -4154,6 +4154,7 @@ ndarrayDispatch,"ndarrayDispatch( fcns, types, data, nargs, nin, nout )"
 ndarrayFlag,"ndarrayFlag( x, name )"
 ndarrayFlags,"ndarrayFlags( x )"
 ndarrayIndexModes,"ndarrayIndexModes()"
+ndarraylike2ndarray,"ndarraylike2ndarray( x[, options] )"
 ndarrayMinDataType,"ndarrayMinDataType( value )"
 ndarrayMostlySafeCasts,"ndarrayMostlySafeCasts( [dtype] )"
 ndarrayNextDataType,"ndarrayNextDataType( [dtype] )"

diff --git a/lib/node_modules/@stdlib/repl/signature/data/data.json b/lib/node_modules/@stdlib/repl/signature/data/data.json
diff --git a/lib/node_modules/@stdlib/repl/typed-signature/data/data.csv b/lib/node_modules/@stdlib/repl/typed-signature/data/data.csv
@@ -4154,6 +4154,7 @@ ndarrayDispatch,"ndarrayDispatch( fcns:Function|ArrayLikeObject<Function>, types
 ndarrayFlag,"ndarrayFlag( x:ndarray, name:string|symbol )"
 ndarrayFlags,"ndarrayFlags( x:ndarray )"
 ndarrayIndexModes,"ndarrayIndexModes()"
+ndarraylike2ndarray,"ndarraylike2ndarray( x:ndarrayLike[, options:Object] )"
 ndarrayMinDataType,"ndarrayMinDataType( value:any )"
 ndarrayMostlySafeCasts,"ndarrayMostlySafeCasts( [dtype:any] )"
 ndarrayNextDataType,"ndarrayNextDataType( [dtype:any] )"

diff --git a/lib/node_modules/@stdlib/repl/typed-signature/data/data.json b/lib/node_modules/@stdlib/repl/typed-signature/data/data.json
Package	Statements	Branches	Functions	Lines
array/base	$\color{green}1626/1626$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}1626/1626$ $\color{green}+100.00\%$
blas	$\color{green}114/114$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}114/114$ $\color{green}+100.00\%$
blas/base	$\color{green}789/789$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}789/789$ $\color{green}+100.00\%$
lapack/base	$\color{green}96/96$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}96/96$ $\color{green}+100.00\%$
math/base/special/besselj0	$\color{red}491/501$ $\color{green}+98.00\%$	$\color{red}40/46$ $\color{green}+86.96\%$	$\color{green}6/6$ $\color{green}+100.00\%$	$\color{red}491/501$ $\color{green}+98.00\%$
math/base/special/besselj1	$\color{red}499/507$ $\color{green}+98.42\%$	$\color{red}42/48$ $\color{green}+87.50\%$	$\color{green}6/6$ $\color{green}+100.00\%$	$\color{red}499/507$ $\color{green}+98.42\%$
math/base/special/bessely0	$\color{red}586/599$ $\color{green}+97.83\%$	$\color{red}45/54$ $\color{green}+83.33\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{red}586/599$ $\color{green}+97.83\%$
math/base/special/gamma-delta-ratio	$\color{red}339/341$ $\color{green}+99.41\%$	$\color{red}32/33$ $\color{green}+96.97\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{red}339/341$ $\color{green}+99.41\%$
ndarray	$\color{green}501/501$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}501/501$ $\color{green}+100.00\%$
ndarray/base	$\color{green}883/883$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}883/883$ $\color{green}+100.00\%$
ndarray/base/map	$\color{red}5098/10996$ $\color{green}+46.36\%$	$\color{green}44/44$ $\color{green}+100.00\%$	$\color{red}0/43$ $\color{green}+0.00\%$	$\color{red}5098/10996$ $\color{green}+46.36\%$
ndarray/iter	$\color{green}168/168$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}168/168$ $\color{green}+100.00\%$
repl/code-blocks	$\color{green}95/95$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}95/95$ $\color{green}+100.00\%$
repl/info	$\color{green}95/95$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}95/95$ $\color{green}+100.00\%$
repl/signature	$\color{green}99/99$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}99/99$ $\color{green}+100.00\%$
repl/typed-signature	$\color{green}99/99$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}99/99$ $\color{green}+100.00\%$
string	$\color{green}550/550$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}550/550$ $\color{green}+100.00\%$