Skip to content

docs: improve doctests for ndarray instances in math/special/abs #10435

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
kgryte merged 1 commit into from
Feb 24, 2026
Merged

docs: improve doctests for ndarray instances in math/special/abs #10435

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
30 changes: 5 additions & 25 deletions lib/node_modules/@stdlib/math/special/abs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,11 @@ var abs = require( '@stdlib/math/special/abs' );
Computes the [absolute value][@stdlib/math/base/special/abs] for each element in an [ndarray][@stdlib/ndarray/ctor].

```javascript
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var array = require( '@stdlib/ndarray/array' );

var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
var y = abs( x );
// returns <ndarray>

var arr = ndarray2array( y );
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
```

The function accepts the following arguments:
Expand All @@ -69,62 +65,50 @@ The function accepts the following options:
By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] determined by the function's output data type [policy][@stdlib/ndarray/output-dtype-policies]. To override the default behavior, set the `dtype` option.

```javascript
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var array = require( '@stdlib/ndarray/array' );
var getDType = require( '@stdlib/ndarray/dtype' );

var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
var y = abs( x, {
'dtype': 'generic'
});
// returns <ndarray>
// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]

var dt = getDType( y );
// returns 'generic'

var arr = ndarray2array( y );
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
```

By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having the same [order][@stdlib/ndarray/orders] as the input [ndarray][@stdlib/ndarray/ctor]. To return an [ndarray][@stdlib/ndarray/ctor] having a specific memory layout irrespective of the memory layout of the input [ndarray][@stdlib/ndarray/ctor], set the `order` option.

```javascript
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var array = require( '@stdlib/ndarray/array' );
var getOrder = require( '@stdlib/ndarray/order' );

var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
var y = abs( x, {
'order': 'column-major'
});
// returns <ndarray>
// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]

var ord = getOrder( y );
// returns 'column-major'

var arr = ndarray2array( y );
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
```

#### abs.assign( x, y )

Computes the [absolute value][@stdlib/math/base/special/abs] for each element in an [ndarray][@stdlib/ndarray/ctor] and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor].

```javascript
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var array = require( '@stdlib/ndarray/array' );

var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
var y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );

var out = abs.assign( x, y );
// returns <ndarray>
// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]

var bool = ( out === y );
// returns true

var arr = ndarray2array( out );
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
```

The function accepts the following arguments:
Expand All @@ -135,7 +119,6 @@ The function accepts the following arguments:
The function supports broadcasting an input [ndarray][@stdlib/ndarray/ctor] to the shape of the output [ndarray][@stdlib/ndarray/ctor] without performing a physical copy of the input [ndarray][@stdlib/ndarray/ctor]'s underlying data.

```javascript
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var zeros = require( '@stdlib/ndarray/zeros' );
var array = require( '@stdlib/ndarray/array' );

Expand All @@ -146,10 +129,7 @@ var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
var y = zeros( [ 2, 2, 2 ] );

var out = abs.assign( x, y );
// returns <ndarray>

var arr = ndarray2array( out );
// returns [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]
// returns <ndarray>[ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]
```

</section>
Expand Down
10 changes: 4 additions & 6 deletions lib/node_modules/@stdlib/math/special/abs/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,8 @@
--------
> var arr = [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ];
> var x = {{alias:@stdlib/ndarray/array}}( arr );
> var y = {{alias}}( x );
> {{alias:@stdlib/ndarray/to-array}}( y )
[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
> var y = {{alias}}( x )
<ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]


{{alias}}.assign( x, y )
Expand All @@ -57,11 +56,10 @@
> var x = {{alias:@stdlib/ndarray/array}}( arr );
> var sh = {{alias:@stdlib/ndarray/shape}}( x );
> var y = {{alias:@stdlib/ndarray/zeros}}( sh );
> var out = {{alias}}.assign( x, y );
> var out = {{alias}}.assign( x, y )
<ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
> var bool = ( out === y )
true
> {{alias:@stdlib/ndarray/to-array}}( y )
[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]

See Also
--------
Expand Down
23 changes: 4 additions & 19 deletions lib/node_modules/@stdlib/math/special/abs/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,13 @@ interface UnaryFunction {
* @returns output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ 1.0, -2.0 ], [ -3.0, 4.0 ] ] );
* // returns <ndarray>
*
* var y = abs( x );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
*/
( x: InputArray, options?: Options ): typedndarray<number>; // FIXME: we lose type specificity here, as the output ndarray data type is determined according to the output data type policy in conjunction with the `dtype` option

Expand All @@ -85,20 +81,16 @@ interface UnaryFunction {
* @returns output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
* var y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );
*
* var z = abs.assign( x, y );
* // returns <ndarray>
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
*
* var bool = ( z === y );
* // returns true
*
* var arr = ndarray2array( y );
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
*/
assign<T extends OutputArray = OutputArray>( x: InputArray, y: T ): T;
}
Expand All @@ -111,16 +103,12 @@ interface UnaryFunction {
* @returns output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] );
*
* var y = abs( x );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
Expand All @@ -130,13 +118,10 @@ interface UnaryFunction {
* var y = array( [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] );
*
* var z = abs.assign( x, y );
* // returns <ndarray>
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
*
* var bool = ( z === y );
* // returns true
*
* var arr = ndarray2array( y );
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
*/
declare var abs: UnaryFunction;

Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/math/special/abs/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,14 @@
* @module @stdlib/math/special/abs
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var array = require( '@stdlib/ndarray/array' );
* var abs = require( '@stdlib/math/special/abs' );
*
* var x = array( [ [ 1.0, -2.0 ], [ -3.0, 4.0 ] ] );
* // returns <ndarray>
*
* var y = abs( x );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
*/

// MODULES //
Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/math/special/abs/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,13 @@ var config = require( './config.js' );
* @returns {ndarray} output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ 1.0, -2.0 ], [ -3.0, 4.0 ] ] );
* // returns <ndarray>
*
* var y = abs( x );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
*/
var abs = ufunc( dispatch( unary, types, data, config.nargs, config.nin, config.nout ), [ config.idtypes ], config.odtypes, config.policies );
setProps( config, types, abs );
Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/math/special/abs/lib/native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,13 @@ var fallback = require( './main.js' ).assign;
* @returns {ndarray} output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ 1.0, -2.0 ], [ -3.0, 4.0 ] ] );
* // returns <ndarray>
*
* var y = abs( x );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
*/
var abs = ufunc( dispatch( addon, fallback ), [ config.idtypes ], config.odtypes, config.policies );
setProps( config, types, abs );
Expand Down