Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -3524,6 +3524,8 @@ A total of 558 issues were closed in this release:
 
 <details>
 
+-   [`f5ac8bf`](https://github.com/stdlib-js/stdlib/commit/f5ac8bf84a07bc581e7be667b9548c1dfe185eaf) - **docs:** update return annotations to use ndarray instance notation for `stats/nanmax` [(#9122)](https://github.com/stdlib-js/stdlib/pull/9122) _(by Sachin Pangal)_
+-   [`6ef2522`](https://github.com/stdlib-js/stdlib/commit/6ef252265ac04446eb43ea78093b0caac5f04bce) - **docs:** update return annotations to use ndarray instance notation for `stats/meankbn` [(#9093)](https://github.com/stdlib-js/stdlib/pull/9093) _(by Pratik, Athan Reines)_
 -   [`e23bad7`](https://github.com/stdlib-js/stdlib/commit/e23bad75d0635153bd643441192b3d3817bc33f3) - **docs:** update return annotations to use ndarray instance notation for `stats/mean` [(#9092)](https://github.com/stdlib-js/stdlib/pull/9092) _(by Pratik, Athan Reines)_
 -   [`5e0faf8`](https://github.com/stdlib-js/stdlib/commit/5e0faf88ff77013e8f29fb29d73eeec9f7cc64d7) - **docs:** update return annotations to use ndarray instance notation for `stats/meankbn2` [(#9100)](https://github.com/stdlib-js/stdlib/pull/9100) _(by Pratik, Athan Reines)_
 -   [`ef6af24`](https://github.com/stdlib-js/stdlib/commit/ef6af24d7711c680e58d393a70b16f65ee675ad5) - **docs:** update return annotations to use ndarray instance notation for `stats/minsorted` [(#9089)](https://github.com/stdlib-js/stdlib/pull/9089) _(by Sachin Pangal)_

meankbn/README.md

@@ -61,10 +61,7 @@ var array = require( '@stdlib/ndarray/array' );
 var x = array( [ 1.0, 2.0, -2.0, 4.0 ] );
 
 var y = meankbn( x );
-// returns <ndarray>
-
-var v = y.get();
-// returns 1.25
+// returns <ndarray>[ 1.25 ]
 ```
 
 The function has the following parameters:
@@ -81,81 +78,58 @@ The function accepts the following options:
 By default, the function performs a reduction over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform a reduction over specific dimensions, provide a `dims` option.
 
 ```javascript
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var array = require( '@stdlib/ndarray/array' );
 
 var x = array( [ 1.0, 2.0, -2.0, 4.0 ], {
     'shape': [ 2, 2 ],
     'order': 'row-major'
 });
-var v = ndarray2array( x );
-// returns [ [ 1.0, 2.0 ], [ -2.0, 4.0 ] ]
+// returns <ndarray>[ [ 1.0, 2.0 ], [ -2.0, 4.0 ] ]
 
 var y = meankbn( x, {
     'dims': [ 0 ]
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ -0.5, 3.0 ]
+// returns <ndarray>[ -0.5, 3.0 ]
 
 y = meankbn( x, {
     'dims': [ 1 ]
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ 1.5, 1.0 ]
+// returns <ndarray>[ 1.5, 1.0 ]
 
 y = meankbn( x, {
     'dims': [ 0, 1 ]
 });
-// returns <ndarray>
-
-v = y.get();
-// returns 1.25
+// returns <ndarray>[ 1.25 ]
 ```
 
 By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`.
 
 ```javascript
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var array = require( '@stdlib/ndarray/array' );
 
 var x = array( [ 1.0, 2.0, -2.0, 4.0 ], {
     'shape': [ 2, 2 ],
     'order': 'row-major'
 });
-
-var v = ndarray2array( x );
-// returns [ [ 1.0, 2.0 ], [ -2.0, 4.0 ] ]
+// returns <ndarray>[ [ 1.0, 2.0 ], [ -2.0, 4.0 ] ]
 
 var y = meankbn( x, {
     'dims': [ 0 ],
     'keepdims': true
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ -0.5, 3.0 ] ]
+// returns <ndarray>[ [ -0.5, 3.0 ] ]
 
 y = meankbn( x, {
     'dims': [ 1 ],
     'keepdims': true
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ 1.5 ], [ 1.0 ] ]
+// returns <ndarray>[ [ 1.5 ], [ 1.0 ] ]
 
 y = meankbn( x, {
     'dims': [ 0, 1 ],
     'keepdims': true
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ 1.25 ] ]
+// returns <ndarray>[ [ 1.25 ] ]
 ```
 
 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.
@@ -189,10 +163,7 @@ var x = array( [ 1.0, 2.0, -2.0, 4.0 ] );
 var y = zeros( [] );
 
 var out = meankbn.assign( x, y );
-// returns <ndarray>
-
-var v = out.get();
-// returns 1.25
+// returns <ndarray>[ 1.25 ]
 
 var bool = ( out === y );
 // returns true

meankbn/docs/repl.txt

@@ -32,9 +32,8 @@
     Examples
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
-    > var y = {{alias}}( x );
-    > var v = y.get()
-    -1.5
+    > var y = {{alias}}( x )
+    <ndarray>[ -1.5 ]
 
 
 {{alias}}.assign( x, out[, options] )
@@ -68,11 +67,9 @@
     > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
     > var out = {{alias:@stdlib/ndarray/zeros}}( [] );
     > var y = {{alias}}.assign( x, out )
-    <ndarray>
+    <ndarray>[ -1.5 ]
     > var bool = ( out === y )
     true
-    > var v = out.get()
-    -1.5
 
     See Also
     --------

meankbn/docs/types/index.d.ts

@@ -75,10 +75,7 @@ interface Unary {
 	* var x = array( [ 1.0, 2.0, -2.0, 4.0 ] );
 	*
 	* var y = meankbn( x );
-	* // returns <ndarray>
-	*
-	* var v = y.get();
-	* // returns 1.25
+	* // returns <ndarray>[ 1.25 ]
 	*/
 	<T = unknown, U = unknown>( x: InputArray<T>, options?: Options ): OutputArray<U>; // NOTE: we lose type specificity here, but retaining specificity would likely be difficult and/or tedious to completely enumerate, as the output ndarray data type is dependent on how `x` interacts with output data type policy and whether that policy has been overridden by `options.dtype`.
 
@@ -98,10 +95,7 @@ interface Unary {
 	* var y = zeros( [] );
 	*
 	* var out = meankbn.assign( x, y );
-	* // returns <ndarray>
-	*
-	* var v = out.get();
-	* // returns 1.25
+	* // returns <ndarray>[ 1.25 ]
 	*
 	* var bool = ( out === y );
 	* // returns true
@@ -122,10 +116,7 @@ interface Unary {
 * var x = array( [ 1.0, 2.0, -2.0, 4.0 ] );
 *
 * var y = meankbn( x );
-* // returns <ndarray>
-*
-* var v = y.get();
-* // returns 1.25
+* // returns <ndarray>[ 1.25 ]
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
@@ -135,10 +126,7 @@ interface Unary {
 * var y = zeros( [] );
 *
 * var out = meankbn.assign( x, y );
-* // returns <ndarray>
-*
-* var v = out.get();
-* // returns 1.25
+* // returns <ndarray>[ 1.25 ]
 *
 * var bool = ( out === y );
 * // returns true

meankbn/lib/index.js

@@ -45,10 +45,7 @@
 *
 * // Perform reduction:
 * var out = meankbn( x );
-* // returns <ndarray>
-*
-* var v = out.get();
-* // returns 6.5
+* // returns <ndarray>[ 6.5 ]
 */
 
 // MODULES //

meankbn/lib/main.js

@@ -88,10 +88,7 @@ var table = {
 *
 * // Perform reduction:
 * var out = meankbn( x );
-* // returns <ndarray>
-*
-* var v = out.get();
-* // returns 6.5
+* // returns <ndarray>[ 6.5 ]
 */
 var meankbn = factory( table, [ idtypes ], odtypes, policies );
 

nanmax/README.md

@@ -40,10 +40,7 @@ var array = require( '@stdlib/ndarray/array' );
 var x = array( [ -1.0, 2.0, NaN ] );
 
 var y = nanmax( x );
-// returns <ndarray>
-
-var v = y.get();
-// returns 2.0
+// returns <ndarray>[ 2.0 ]
 ```
 
 The function has the following parameters:
@@ -60,81 +57,58 @@ The function accepts the following options:
 By default, the function performs a reduction over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform a reduction over specific dimensions, provide a `dims` option.
 
 ```javascript
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var array = require( '@stdlib/ndarray/array' );
 
 var x = array( [ -1.0, 2.0, NaN, 4.0 ], {
     'shape': [ 2, 2 ],
     'order': 'row-major'
 });
-var v = ndarray2array( x );
-// returns [ [ -1.0, 2.0 ], [ NaN, 4.0 ] ]
+// returns <ndarray>[ [ -1.0, 2.0 ], [ NaN, 4.0 ] ]
 
 var y = nanmax( x, {
     'dims': [ 0 ]
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ -1.0, 4.0 ]
+// returns <ndarray>[ -1.0, 4.0 ]
 
 y = nanmax( x, {
     'dims': [ 1 ]
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ 2.0, 4.0 ]
+// returns <ndarray>[ 2.0, 4.0 ]
 
 y = nanmax( x, {
     'dims': [ 0, 1 ]
 });
-// returns <ndarray>
-
-v = y.get();
-// returns 4.0
+// returns <ndarray>[ 4.0 ]
 ```
 
 By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`.
 
 ```javascript
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var array = require( '@stdlib/ndarray/array' );
 
 var x = array( [ -1.0, 2.0, NaN, 4.0 ], {
     'shape': [ 2, 2 ],
     'order': 'row-major'
 });
-
-var v = ndarray2array( x );
-// returns [ [ -1.0, 2.0 ], [ NaN, 4.0 ] ]
+// returns <ndarray>[ [ -1.0, 2.0 ], [ NaN, 4.0 ] ]
 
 var y = nanmax( x, {
     'dims': [ 0 ],
     'keepdims': true
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ -1.0, 4.0 ] ]
+// returns <ndarray>[ [ -1.0, 4.0 ] ]
 
 y = nanmax( x, {
     'dims': [ 1 ],
     'keepdims': true
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ 2.0 ], [ 4.0 ] ]
+// returns <ndarray>[ [ 2.0 ], [ 4.0 ] ]
 
 y = nanmax( x, {
     'dims': [ 0, 1 ],
     'keepdims': true
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ 4.0 ] ]
+// returns <ndarray>[ [ 4.0 ] ]
 ```
 
 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.
@@ -150,7 +124,7 @@ var x = array( [ -1.0, 2.0, NaN ], {
 var y = nanmax( x, {
     'dtype': 'float64'
 });
-// returns <ndarray>
+// returns <ndarray>[ 2.0 ]
 
 var dt = String( getDType( y ) );
 // returns 'float64'
@@ -168,10 +142,7 @@ var x = array( [ -1.0, 2.0, NaN ] );
 var y = zeros( [] );
 
 var out = nanmax.assign( x, y );
-// returns <ndarray>
-
-var v = out.get();
-// returns 2.0
+// returns <ndarray>[ 2.0 ]
 
 var bool = ( out === y );
 // returns true

nanmax/docs/repl.txt

@@ -31,9 +31,8 @@
     Examples
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, NaN, -4.0 ] );
-    > var y = {{alias}}( x );
-    > var v = y.get()
-    2.0
+    > var y = {{alias}}( x )
+    <ndarray>[ 2.0 ]
 
 
 {{alias}}.assign( x, out[, options] )
@@ -66,11 +65,9 @@
     > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, NaN, -4.0 ] );
     > var out = {{alias:@stdlib/ndarray/zeros}}( [] );
     > var y = {{alias}}.assign( x, out )
-    <ndarray>
+    <ndarray>[ 2.0 ]
     > var bool = ( out === y )
     true
-    > var v = out.get()
-    2.0
 
     See Also
     --------