|
1 | | -abs,"\nabs( x[, options] )\n Computes the absolute value.\n\n If provided a number, the function returns a number.\n\n If provided an ndarray or array-like object, the function performs element-\n wise computation.\n\n If provided an array-like object, the function returns an array-like object\n having the same length and data type as `x`.\n\n If provided an ndarray, the function returns an ndarray having the same\n shape and data type as `x`.\n\n Parameters\n ----------\n x: ndarray|ArrayLikeObject|number\n Input value.\n\n options: Object (optional)\n Options.\n\n options.order: string (optional)\n Output array order (either row-major (C-style) or column-major (Fortran-\n style)). Only applicable when the input array is an ndarray. By default,\n the output array order is inferred from the input array.\n\n options.dtype: string (optional)\n Output array data type. Only applicable when the input array is either\n an ndarray or array-like object. By default, the output array data type\n is inferred from the input array.\n\n Returns\n -------\n y: ndarray|ArrayLikeObject|number\n Results.\n\n Examples\n --------\n // Provide a number:\n > var y = abs( -1.0 )\n 1.0\n\n // Provide an array-like object:\n > var x = new Float64Array( [ -1.0, -2.0 ] );\n > y = abs( x )\n <Float64Array>[ 1.0, 2.0 ]\n\n > x = [ -1.0, -2.0 ];\n > y = abs( x )\n [ 1.0, 2.0 ]\n\n // Provide an ndarray:\n > x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );\n > y = abs( x )\n <ndarray>\n > y.get( 0, 1 )\n 2.0\n\n\nabs.assign( x, y )\n Computes the absolute value and assigns results to a provided output array.\n\n Parameters\n ----------\n x: ndarray|ArrayLikeObject\n Input array.\n\n y: ndarray|ArrayLikeObject\n Output array. Must be the same data \"kind\" (i.e., ndarray or array-like\n object) as the input array.\n\n Returns\n -------\n y: ndarray|ArrayLikeObject\n Output array.\n\n Examples\n --------\n // Provide an array-like object:\n > var x = new Float64Array( [ -1.0, -2.0 ] );\n > var y = new Float64Array( x.length );\n > var out = abs.assign( x, y )\n <Float64Array>[ 1.0, 2.0 ]\n > var bool = ( out === y )\n true\n\n > x = [ -1.0, -2.0 ];\n > y = [ 0.0, 0.0 ];\n > out = abs.assign( x, y )\n [ 1.0, 2.0 ]\n > bool = ( out === y )\n true\n\n // Provide an ndarray:\n > x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );\n > y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );\n > out = abs.assign( x, y )\n <ndarray>\n > out.get( 0, 1 )\n 2.0\n > bool = ( out === y )\n true\n\n" |
2 | | -abs.assign,"\nabs.assign( x, y )\n Computes the absolute value and assigns results to a provided output array.\n\n Parameters\n ----------\n x: ndarray|ArrayLikeObject\n Input array.\n\n y: ndarray|ArrayLikeObject\n Output array. Must be the same data \"kind\" (i.e., ndarray or array-like\n object) as the input array.\n\n Returns\n -------\n y: ndarray|ArrayLikeObject\n Output array.\n\n Examples\n --------\n // Provide an array-like object:\n > var x = new Float64Array( [ -1.0, -2.0 ] );\n > var y = new Float64Array( x.length );\n > var out = abs.assign( x, y )\n <Float64Array>[ 1.0, 2.0 ]\n > var bool = ( out === y )\n true\n\n > x = [ -1.0, -2.0 ];\n > y = [ 0.0, 0.0 ];\n > out = abs.assign( x, y )\n [ 1.0, 2.0 ]\n > bool = ( out === y )\n true\n\n // Provide an ndarray:\n > x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );\n > y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );\n > out = abs.assign( x, y )\n <ndarray>\n > out.get( 0, 1 )\n 2.0\n > bool = ( out === y )\n true" |
| 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 (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 ] ]" |
3 | 3 | 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" |
4 | 4 | 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" |
5 | 5 | 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" |
|
0 commit comments