npm package: @stdlib/stats-nanmax-by
Description: Compute the maximum value along one or more ndarray dimensions according to a callback function, ignoring NaN values.
Author: The Stdlib Authors
Latest version: 0.1.1

<!--

@license Apache-2.0

Copyright (c) 2025 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->


<details>
  <summary>
    About stdlib...
  </summary>
  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
</details>

# nanmaxBy

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->

> Compute the maximum value along one or more [ndarray][@stdlib/ndarray/ctor] dimensions according to a callback function, ignoring `NaN` values.

<section class="installation">

## Installation

```bash
npm install @stdlib/stats-nanmax-by
```

</section>

<section class="usage">

## Usage

```javascript
var nanmaxBy = require( '@stdlib/stats-nanmax-by' );
```

#### nanmaxBy( x\[, options], clbk\[, thisArg] )

Computes the maximum value along one or more [ndarray][@stdlib/ndarray/ctor] dimensions according to a callback function, ignoring `NaN` values.

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

var x = array( [ -1.0, 2.0, NaN ] );

function clbk( v ) {
    return v * 2.0;
}

var y = nanmaxBy( x, clbk );
// returns <ndarray>[ 4.0 ]
```

The function has the following parameters:

-   **x**: input [ndarray][@stdlib/ndarray/ctor].
-   **options**: function options (_optional_).
-   **clbk**: callback function.
-   **thisArg**: callback function execution context (_optional_).

The invoked callback is provided three arguments:

-   **value**: current array element.
-   **index**: current array element index.
-   **array**: input ndarray.

To set the callback execution context, provide a `thisArg`.

<!-- eslint-disable no-invalid-this -->

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

var x = array( [ -1.0, 2.0, NaN ] );

function clbk( v ) {
    this.count += 1;
    return v * 2.0;
}

var ctx = {
    'count': 0
};
var y = nanmaxBy( x, clbk, ctx );
// returns <ndarray>[ 4.0 ]

var count = ctx.count;
// returns 3
```

The function accepts the following options:

-   **dims**: list of dimensions over which to perform a reduction. If not provided, the function performs a reduction over all elements in a provided input [ndarray][@stdlib/ndarray/ctor].
-   **dtype**: output ndarray [data type][@stdlib/ndarray/dtypes]. Must be a real-valued or "generic" [data type][@stdlib/ndarray/dtypes].
-   **keepdims**: boolean indicating whether the reduced dimensions should be included in the returned [ndarray][@stdlib/ndarray/ctor] as singleton dimensions. Default: `false`.

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 array = require( '@stdlib/ndarray-array' );

function clbk( v ) {
    return v * 100.0;
}

var x = array( [ -1.0, 2.0, NaN, 4.0 ], {
    'shape': [ 2, 2 ],
    'order': 'row-major'
});
// returns <ndarray>[ [ -1.0, 2.0 ], [ NaN, 4.0 ] ]

var opts = {
    'dims': [ 0 ]
};
var y = nanmaxBy( x, opts, clbk );
// returns <ndarray>[ -100.0, 400.0 ]

opts = {
    'dims': [ 1 ]
};
y = nanmaxBy( x, opts, clbk );
// returns <ndarray>[ 200.0, 400.0 ]

opts = {
    'dims': [ 0, 1 ]
};
y = nanmaxBy( x, opts, clbk );
// returns <ndarray>[ 400.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 array = require( '@stdlib/ndarray-array' );

function clbk( v ) {
    return v * 100.0;
}

var x = array( [ -1.0, 2.0, NaN, 4.0 ], {
    'shape': [ 2, 2 ],
    'order': 'row-major'
});
// returns <ndarray>[ [ -1.0, 2.0 ], [ NaN, 4.0 ] ]

var opts = {
    'dims': [ 0 ],
    'keepdims': true
};
var y = nanmaxBy( x, opts, clbk );
// returns <ndarray>[ [ -100.0, 400.0 ] ]

opts = {
    'dims': [ 1 ],
    'keepdims': true
};
y = nanmaxBy( x, opts, clbk );
// returns <ndarray>[ [ 200.0 ], [ 400.0 ] ]

opts = {
    'dims': [ 0, 1 ],
    'keepdims': true
};
y = nanmaxBy( x, opts, clbk );
// returns <ndarray>[ [ 400.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.

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

function clbk( v ) {
    return v * 100.0;
}

var x = array( [ -1.0, 2.0, NaN ], {
    'dtype': 'generic'
});

var opts = {
    'dtype': 'float64'
};
var y = nanmaxBy( x, opts, clbk );
// returns <ndarray>[ 200.0 ]

var dt = String( getDType( y ) );
// returns 'float64'
```

#### nanmaxBy.assign( x, out\[, options], clbk\[, thisArg] )

Computes the maximum value along one or more [ndarray][@stdlib/ndarray/ctor] dimensions according to a callback function, ignoring `NaN` values, and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor].

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

function clbk( v ) {
    return v * 100.0;
}

var x = array( [ -1.0, 2.0, NaN ] );
var y = zeros( [] );

var out = nanmaxBy.assign( x, y, clbk );
// returns <ndarray>[ 200.0 ]

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

The method has the following parameters:

-   **x**: input [ndarray][@stdlib/ndarray/ctor].
-   **out**: output [ndarray][@stdlib/ndarray/ctor].
-   **options**: function options (_optional_).
-   **clbk**: callback function.
-   **thisArg**: callback execution context (_optional_).

The method accepts the following options:

-   **dims**: list of dimensions over which to perform a reduction. If not provided, the function performs a reduction over all elements in a provided input [ndarray][@stdlib/ndarray/ctor].

</section>

<!-- /.usage -->

<section class="notes">

## Notes

-   A provided callback function should return a numeric value.
-   If a provided callback function returns `NaN`, the value is ignored.
-   If a provided callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is **ignored**.
-   Setting the `keepdims` option to `true` can be useful when wanting to ensure that the output [ndarray][@stdlib/ndarray/ctor] is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with ndarrays having the same shape as the input [ndarray][@stdlib/ndarray/ctor].
-   The output data type [policy][@stdlib/ndarray/output-dtype-policies] only applies to the main function and specifies that, by default, the function must return an [ndarray][@stdlib/ndarray/ctor] having a real-valued or "generic" [data type][@stdlib/ndarray/dtypes]. For the `assign` method, the output [ndarray][@stdlib/ndarray/ctor] is allowed to have any supported output [data type][@stdlib/ndarray/dtypes].

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var filledarrayBy = require( '@stdlib/array-filled-by' );
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var getDType = require( '@stdlib/ndarray-dtype' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var ndarray = require( '@stdlib/ndarray-ctor' );
var nanmaxBy = require( '@stdlib/stats-nanmax-by' );

// Define a function for generating an object having a random value:
function random() {
    return {
        'value': discreteUniform( 0, 20 )
    };
}

// Generate an array of random objects:
var xbuf = filledarrayBy( 25, 'generic', random );

// Wrap in an ndarray:
var x = new ndarray( 'generic', xbuf, [ 5, 5 ], [ 5, 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );

// Define an accessor function:
function accessor( v ) {
    return v.value * 100;
}

// Perform a reduction:
var opts = {
    'dims': [ 0 ]
};
var y = nanmaxBy( x, opts, accessor );

// Resolve the output array data type:
var dt = getDType( y );
console.log( dt );

// Print the results:
console.log( ndarray2array( y ) );
```

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->


<section class="main-repo" >

* * *

## Notice

This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## License

See [LICENSE][stdlib-license].


## Copyright

Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].

</section>

<!-- /.stdlib -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-nanmax-by.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-nanmax-by

[test-image]: https://github.com/stdlib-js/stats-nanmax-by/actions/workflows/test.yml/badge.svg?branch=v0.1.1
[test-url]: https://github.com/stdlib-js/stats-nanmax-by/actions/workflows/test.yml?query=branch:v0.1.1

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-nanmax-by/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-nanmax-by?branch=main

<!--

[dependencies-image]: https://img.shields.io/david/stdlib-js/stats-nanmax-by.svg
[dependencies-url]: https://david-dm.org/stdlib-js/stats-nanmax-by/main

-->

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/stats-nanmax-by/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-nanmax-by/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-nanmax-by/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-nanmax-by/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-nanmax-by/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-nanmax-by/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-nanmax-by/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-nanmax-by/main/LICENSE

[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor

[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray-dtypes

[@stdlib/ndarray/output-dtype-policies]: https://www.npmjs.com/package/@stdlib/ndarray-output-dtype-policies

[@stdlib/ndarray/base/broadcast-shapes]: https://www.npmjs.com/package/@stdlib/ndarray-base-broadcast-shapes

</section>

<!-- /.links -->