feat: add ndarray/base/binary-input-casting-dtype

lib/node_modules/@stdlib/ndarray/base/binary-input-casting-dtype/README.md

@@ -0,0 +1,150 @@
+<!--
+
+@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.
+
+-->
+
+# binaryInputCastingDataType
+
+> Resolve the input ndarray casting [data type][@stdlib/ndarray/dtypes] for a binary function.
+
+<!-- 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 binaryInputCastingDataType = require( '@stdlib/ndarray/base/binary-input-casting-dtype' );
+```
+
+#### binaryInputCastingDataType( idtype1, idtype2, odtype, policy )
+
+Resolves the input ndarray casting [data type][@stdlib/ndarray/dtypes] for a binary function according to a [data type policy][@stdlib/ndarray/input-casting-policies].
+
+```javascript
+var dt = binaryInputCastingDataType( 'int32', 'int32', 'float64', 'promoted' );
+// returns 'float64'
+```
+
+The function supports the following parameters:
+
+-   **idtype1**: first input ndarray data type.
+-   **idtype2**: second input ndarray data type.
+-   **odtype**: output ndarray data type.
+-   **policy**: input ndarray [casting policy][@stdlib/ndarray/input-casting-policies].
+
+If `policy` is a [data type][@stdlib/ndarray/dtypes], the function always returns the `policy` value (i.e., the fourth argument).
+
+```javascript
+var dt = binaryInputCastingDataType( 'float32', 'float32', 'float64', 'complex128' );
+// returns 'complex128'
+
+dt = binaryInputCastingDataType( 'int32', 'float64', 'float64', 'complex128' );
+// returns 'complex128'
+
+// ...
+```
+
+</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">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var naryFunction = require( '@stdlib/utils/nary-function' );
+var unzip = require( '@stdlib/utils/unzip' );
+var nCartesianProduct = require( '@stdlib/array/base/n-cartesian-product' );
+var dtypes = require( '@stdlib/ndarray/dtypes' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
+var inputCastingDataType = require( '@stdlib/ndarray/base/binary-input-casting-dtype' );
+
+// Get the list of real-valued data types:
+var dt = dtypes( 'real' );
+
+// Define a list of casting policies:
+var policies = [
+    'none',
+    'promoted',
+    'accumulation',
+    'output'
+];
+
+// Generate dtype-policy argument groups:
+var args = nCartesianProduct( dt, dt, policies );
+
+// Unzip the argument arrays:
+args = unzip( args );
+
+// Resolve casting data types:
+logEachMap( 'dtypes: (%10s, %10s). policy: %20s. result: %10s.', args[ 0 ], args[ 1 ], args[ 2 ], naryFunction( inputCastingDataType, 3 ) );
+```
+
+</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/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
+
+[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/input-casting-policies
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/ndarray/base/binary-input-casting-dtype/benchmark/benchmark.js

@@ -0,0 +1,160 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isDataType = require( '@stdlib/ndarray/base/assert/is-data-type' );
+var dtypes = require( '@stdlib/ndarray/dtypes' );
+var pkg = require( './../package.json' ).name;
+var resolve = require( './../lib' );
+
+
+// VARIABLES //
+
+var DTYPES = dtypes( 'numeric' );
+
+
+// MAIN //
+
+bench( pkg+':policy=none', function benchmark( b ) {
+	var out;
+	var dt1;
+	var dt2;
+	var dt3;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		dt1 = DTYPES[ i%DTYPES.length ];
+		dt2 = DTYPES[ i%DTYPES.length ];
+		dt3 = DTYPES[ (i+1)%DTYPES.length ];
+		out = resolve( dt1, dt2, dt3, 'none' );
+		if ( typeof out !== 'string' ) {
+			b.fail( 'should return a string' );
+		}
+	}
+	b.toc();
+	if ( !isDataType( out ) ) {
+		b.fail( 'should return a data type' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+':policy=promoted', function benchmark( b ) {
+	var out;
+	var dt1;
+	var dt2;
+	var dt3;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		dt1 = DTYPES[ i%DTYPES.length ];
+		dt2 = DTYPES[ i%DTYPES.length ];
+		dt3 = DTYPES[ (i+1)%DTYPES.length ];
+		out = resolve( dt1, dt2, dt3, 'promoted' );
+		if ( typeof out !== 'string' ) {
+			b.fail( 'should return a string' );
+		}
+	}
+	b.toc();
+	if ( !isDataType( out ) ) {
+		b.fail( 'should return a data type' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+':policy=accumulation', function benchmark( b ) {
+	var out;
+	var dt1;
+	var dt2;
+	var dt3;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		dt1 = DTYPES[ i%DTYPES.length ];
+		dt2 = DTYPES[ i%DTYPES.length ];
+		dt3 = DTYPES[ (i+1)%DTYPES.length ];
+		out = resolve( dt1, dt2, dt3, 'accumulation' );
+		if ( typeof out !== 'string' ) {
+			b.fail( 'should return a string' );
+		}
+	}
+	b.toc();
+	if ( !isDataType( out ) ) {
+		b.fail( 'should return a data type' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+':policy=output', function benchmark( b ) {
+	var out;
+	var dt1;
+	var dt2;
+	var dt3;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		dt1 = DTYPES[ i%DTYPES.length ];
+		dt2 = DTYPES[ i%DTYPES.length ];
+		dt3 = DTYPES[ (i+1)%DTYPES.length ];
+		out = resolve( dt1, dt2, dt3, 'output' );
+		if ( typeof out !== 'string' ) {
+			b.fail( 'should return a string' );
+		}
+	}
+	b.toc();
+	if ( !isDataType( out ) ) {
+		b.fail( 'should return a data type' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+':policy=<dtype>', function benchmark( b ) {
+	var out;
+	var dt1;
+	var dt2;
+	var dt3;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		dt1 = DTYPES[ i%DTYPES.length ];
+		dt2 = DTYPES[ i%DTYPES.length ];
+		dt3 = DTYPES[ (i+1)%DTYPES.length ];
+		out = resolve( dt1, dt2, dt3, 'int32' );
+		if ( typeof out !== 'string' ) {
+			b.fail( 'should return a string' );
+		}
+	}
+	b.toc();
+	if ( !isDataType( out ) ) {
+		b.fail( 'should return a data type' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/ndarray/base/binary-input-casting-dtype/docs/repl.txt

@@ -0,0 +1,32 @@
+
+{{alias}}( idtype, odtype, policy )
+    Resolves the input ndarray casting data type for a binary function.
+
+    Parameters
+    ----------
+    idtype1: string
+        First input ndarray data type.
+
+    idtype2: string
+        Second input ndarray data type.
+
+    odtype: string
+        Output ndarray data type.
+
+    policy: string
+        Input ndarray casting data type policy. If `policy` is a data type, the
+        function returns the `policy` value.
+
+    Returns
+    -------
+    out: string
+        Input ndarray casting data type.
+
+    Examples
+    --------
+    > var out = {{alias}}( 'float64', 'float64', 'float64', 'none' )
+    'float64'
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/ndarray/base/binary-input-casting-dtype/docs/types/index.d.ts

@@ -0,0 +1,43 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { DataType, InputCastingPolicy } from '@stdlib/types/ndarray';
+
+/**
+* Resolves the input ndarray casting data type for a binary function.
+*
+* @param idtype1 - first input ndarray data type
+* @param idtype2 - second input ndarray data type
+* @param odtype - output ndarray data type
+* @param policy - input ndarray casting data type policy
+* @returns input ndarray casting data type
+*
+* @example
+* var dt = outputDataType( 'float64', 'float64', 'float64', 'none' );
+* // returns <string>
+*/
+declare function outputDataType( idtype1: DataType, idtype2: DataType, odtype: DataType, policy: InputCastingPolicy | DataType ): DataType;
+
+
+// EXPORTS //
+
+export = outputDataType;