Auto-generated commit

Author: stdlib-bot

CONTRIBUTORS

@@ -73,6 +73,7 @@ Shivam <11shivam00@gmail.com>
 Shraddheya Shendre <shendreshraddheya@gmail.com>
 Shubh Mehta <93862397+Shubh942@users.noreply.github.com>
 Shubham Mishra <shubh622005@gmail.com>
+Sivam Das <100067002+Sivam2313@users.noreply.github.com>
 Snehil Shah <130062020+Snehil-Shah@users.noreply.github.com>
 Soumajit Chatterjee <121816890+soumajit23@users.noreply.github.com>
 Spandan Barve <contact@marsian.dev>

README.md

@@ -2225,6 +2225,27 @@ im = imagf( z );
 // returns 6.0
 ```
 
+<a name="method-to-locale-string"></a>
+
+#### Complex64Array.prototype.toLocaleString( \[locales\[, options]] )
+
+Serializes an array as a locale-specific string.
+
+```javascript
+var arr = new Complex64Array( 2 );
+
+arr.set( [ 1.0, 1.0 ], 0 );
+arr.set( [ 2.0, 2.0 ], 1 );
+
+var str = arr.toLocaleString();
+// returns '1 + 1i,2 + 2i'
+```
+
+The method supports the following arguments:
+
+-   **locales**: a string with a BCP 47 language tag or an array of such strings.
+-   **options**: configuration properties.
+
 <a name="method-to-reversed"></a>
 
 #### Complex64Array.prototype.toReversed()

benchmark/benchmark.to_locale_string.js

@@ -0,0 +1,50 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench-harness' );
+var pkg = require( './../package.json' ).name;
+var Complex64Array = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+':toLocaleString', function benchmark( b ) {
+	var out;
+	var arr;
+	var i;
+
+	arr = new Complex64Array( [ 1, 2, 3, 4, 5, 6 ] );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = arr.toLocaleString();
+		if ( typeof out !== 'string' ) {
+			b.fail( 'should return a string' );
+		}
+	}
+	b.toc();
+	if ( typeof out !== 'string' ) {
+		b.fail( 'should return a string' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

benchmark/benchmark.to_locale_string.length.js

@@ -0,0 +1,102 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench-harness' );
+var pow = require( '@stdlib/math-base-special-pow' );
+var Complex64 = require( '@stdlib/complex-float32' );
+var pkg = require( './../package.json' ).name;
+var Complex64Array = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var arr;
+	var i;
+
+	arr = [];
+	for ( i = 0; i < len; i++ ) {
+		arr.push( new Complex64( i, i ) );
+	}
+	arr = new Complex64Array( arr );
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = arr.toLocaleString();
+			if ( typeof out !== 'string' ) {
+				b.fail( 'should return a string' );
+			}
+		}
+		b.toc();
+		if ( typeof out !== 'string' ) {
+			b.fail( 'should return a string' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':toLocaleString:len='+len, f );
+	}
+}
+
+main();

dist/index.js

@@ -30,6 +30,16 @@ import ArrayBuffer = require( '@stdlib/array-buffer' );
 // Define a union type representing both iterable and non-iterable iterators:
 type Iterator = Iter | IterableIterator;
 
+/**
+* Locale-specific configuration options.
+*/
+interface LocaleOptions<T = unknown> {
+	/**
+	* Configuration property.
+	*/
+	[ key: string | symbol | number ]: T | undefined;
+};
+
 /**
 * Callback invoked for each element in a source object.
 *
@@ -1221,6 +1231,24 @@ declare class Complex64Array implements Complex64ArrayInterface {
 	*/
 	subarray( begin?: number, end?: number ): Complex64Array;
 
+	/**
+	* Serializes an array as a locale-specific string.
+	*
+	* @param locales - locale identifier(s)
+	* @param options - configuration options
+	* @returns string
+	*
+	* @example
+	* var arr = new Complex64Array( 2 );
+	*
+	* arr.set( [ 1.0, 1.0 ], 0 );
+	* arr.set( [ 2.0, 2.0 ], 1 );
+	*
+	* var str = arr.toLocaleString();
+	* // returns '1 + 1i,2 + 2i'
+	*/
+	toLocaleString( locales?: string | Array<string>, options?: LocaleOptions ): string;
+
 	/**
 	* Returns a new typed array containing the elements in reversed order.
 	*

dist/index.js.map

@@ -28,6 +28,7 @@ var isCollection = require( '@stdlib/assert-is-collection' );
 var isArrayBuffer = require( '@stdlib/assert-is-arraybuffer' );
 var isObject = require( '@stdlib/assert-is-object' );
 var isArray = require( '@stdlib/assert-is-array' );
+var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;
 var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
 var isFunction = require( '@stdlib/assert-is-function' );
 var isComplexLike = require( '@stdlib/assert-is-complex-like' );
@@ -2491,6 +2492,59 @@ setReadOnly( Complex64Array.prototype, 'subarray', function subarray( begin, end
 	return new this.constructor( buf.buffer, offset, ( len < 0 ) ? 0 : len );
 });
 
+/**
+* Serializes an array as a locale-specific string.
+*
+* @name toLocaleString
+* @memberof Complex64Array.prototype
+* @type {Function}
+* @param {(string|Array<string>)} [locales] - locale identifier(s)
+* @param {Object} [options] - configuration options
+* @throws {TypeError} `this` must be a complex number array
+* @throws {TypeError} first argument must be a string or an array of strings
+* @throws {TypeError} options argument must be an object
+* @returns {string} string representation
+*
+* @example
+* var arr = new Complex64Array( 2 );
+*
+* arr.set( [ 1.0, 1.0 ], 0 );
+* arr.set( [ 2.0, 2.0 ], 1 );
+*
+* var str = arr.toLocaleString();
+* // returns '1 + 1i,2 + 2i'
+*/
+setReadOnly( Complex64Array.prototype, 'toLocaleString', function toLocaleString( locales, options ) {
+	var opts;
+	var loc;
+	var out;
+	var buf;
+	var i;
+	if ( !isComplexArray( this ) ) {
+		throw new TypeError( 'invalid invocation. `this` is not a complex number array.' );
+	}
+	if ( arguments.length === 0 ) {
+		loc = [];
+	} else if ( isString( locales ) || isStringArray( locales ) ) {
+		loc = locales;
+	} else {
+		throw new TypeError( 'invalid argument. First argument must be a string or an array of strings. Value: `' + locales + '`.' );
+	}
+	if ( arguments.length < 2 ) {
+		opts = {};
+	} else if ( isObject( options ) ) {
+		opts = options;
+	} else {
+		throw new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' );
+	}
+	buf = this._buffer;
+	out = [];
+	for ( i = 0; i < this._length; i++ ) {
+		out.push( getComplex64( buf, i ).toLocaleString( loc, opts ) );
+	}
+	return out.join( ',' );
+});
+
 /**
 * Returns a new typed array containing the elements in reversed order.
 *

docs/types/index.d.ts

@@ -52,6 +52,7 @@
     "@stdlib/assert-is-nonnegative-integer": "^0.2.1",
     "@stdlib/assert-is-object": "^0.2.1",
     "@stdlib/assert-is-string": "^0.2.1",
+    "@stdlib/assert-is-string-array": "^0.2.1",
     "@stdlib/complex-float32": "^0.2.1",
     "@stdlib/complex-imagf": "^0.2.1",
     "@stdlib/complex-realf": "^0.2.1",