<!--

@license Apache-2.0

Copyright (c) 2026 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.

-->

# consensusOrder

> Resolve the most common underlying storage layout.

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- Package usage documentation. -->

<section class="usage">

## Usage

```javascript
var consensusOrder = require( '@stdlib/ndarray/base/consensus-order' );
```

#### consensusOrder( strides )

Resolves the most common underlying storage [layout][@stdlib/ndarray/order].

```javascript
// Define the strides for input arrays:
var stridesX = [ 2, 1 ]; // row-major
var stridesY = [ 4, 2 ]; // row-major

// Define the strides for an output array:
var stridesZ = [ 1, 2 ]; // column-major

// Resolve the most common layout:
var o = consensusOrder( [ stridesX, stridesY, stridesZ ] );
// returns 'row-major'
```

The function accepts the following arguments:

-   **strides**: list of stride arrays.

</section>

<!-- /.usage -->

<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

## Notes

-   In the event of a tie or when all input array strides are "disorganized" (i.e., neither row- nor column-major), the function returns the [default layout][@stdlib/ndarray/defaults].

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

<!-- eslint-disable max-len -->

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

```javascript
var array = require( '@stdlib/ndarray/array' );
var getStrides = require( '@stdlib/ndarray/strides' );
var consensusOrder = require( '@stdlib/ndarray/base/consensus-order' );

// Create ndarrays:
var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
var y = array( [ [ 5, 6 ], [ 7, 8 ] ] );
var z = array( [ [ 0, 0 ], [ 0, 0 ] ] );

// Resolve the most common layout:
var o = consensusOrder( [ getStrides( x ), getStrides( y ), getStrides( z ) ] );
// returns <string>

console.log( o );
```

</section>

<!-- /.examples -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">

</section>

<!-- /.references -->

<!-- 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="links">

[@stdlib/ndarray/order]: https://github.com/stdlib-js/ndarray/tree/main/order

[@stdlib/ndarray/defaults]: https://github.com/stdlib-js/ndarray/tree/main/defaults

</section>

<!-- /.links -->
