<!--

@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.

-->

# ndarray2localeString

> Serialize an [ndarray][@stdlib/ndarray/ctor] as a locale-aware string.

<!-- 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 ndarray2localeString = require( '@stdlib/ndarray/to-locale-string' );
```

#### ndarray2localeString( x\[, locales\[, options]] )

Serializes an [ndarray][@stdlib/ndarray/ctor] as a locale-aware string.

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

var x = array( [ 1, 2, 3, 4 ], {
    'shape': [ 2, 2 ]
});
// returns <ndarray>

var str = ndarray2localeString( x );
// returns <string>
```

The function supports the following parameters:

-   **x**: input ndarray.
-   **locales**: a [BCP 47][bcp-47] language tag or an array of such strings (_optional_).
-   **options**: configuration options (_optional_).

</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

-   The function does **not** serialize data outside of the buffer region defined by the [ndarray][@stdlib/ndarray/ctor] view.
-   For ndarrays with more than `100` elements, the function abbreviates the data, showing only the first three and last three values.

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

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

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

// Create a 2x3 ndarray:
var x = array( [ 1234.567, 9876.543, 1111.222, 3333.444, 5555.666, 7777.888 ], {
    'shape': [ 2, 3 ],
    'dtype': 'generic'
});

// Serialize using the default locale:
var str = ndarray2localeString( x );
// e.g., returns 'ndarray( \'generic\', [ 1,234.567, 9,876.543, 1,111.222, 3,333.444, 5,555.666, 7,777.888 ], [ 2, 3 ], [ 3, 1 ], 0, \'row-major\' )'

// Serialize using the English (US) locale:
str = ndarray2localeString( x, 'en-US' );
// returns 'ndarray( \'generic\', [ 1,234.567, 9,876.543, 1,111.222, 3,333.444, 5,555.666, 7,777.888 ], [ 2, 3 ], [ 3, 1 ], 0, \'row-major\' )'

// Serialize using the German locale:
str = ndarray2localeString( x, 'de-DE' );
// returns 'ndarray( \'generic\', [ 1.234,567, 9.876,543, 1.111,222, 3.333,444, 5.555,666, 7.777,888 ], [ 2, 3 ], [ 3, 1 ], 0, \'row-major\' )'

// Serialize with a maximum number of fraction digits:
str = ndarray2localeString( x, 'en-US', {
    'maximumFractionDigits': 0
});
// returns 'ndarray( \'generic\', [ 1,235, 9,877, 1,111, 3,333, 5,556, 7,778 ], [ 2, 3 ], [ 3, 1 ], 0, \'row-major\' )'
```

</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/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor

[bcp-47]: https://tools.ietf.org/html/rfc5646

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->
