feat: add ndarray/base/dtype-strings

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/ndarray/base/dtype-strings/README.md

@@ -0,0 +1,169 @@
+<!--
+
+@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.
+
+-->
+
+# Data Type Strings
+
+> List of ndarray data type strings.
+
+<!-- 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 dtypeStrings = require( '@stdlib/ndarray/base/dtype-strings' );
+```
+
+#### dtypeStrings( \[kind] )
+
+Returns a list of ndarray data type strings.
+
+```javascript
+var out = dtypeStrings();
+// e.g., returns [ 'binary', 'complex32', 'complex64', 'complex128', ... ]
+```
+
+When not provided a data type "kind", the function returns an array containing the following data type strings:
+
+-   `binary`: binary.
+-   `bool`: boolean values.
+-   `complex32`: half-precision complex floating-point numbers.
+-   `complex64`: single-precision complex floating-point numbers.
+-   `complex128`: double-precision complex floating-point numbers.
+-   `float16`: half-precision floating-point numbers.
+-   `float32`: single-precision floating-point numbers.
+-   `float64`: double-precision floating-point numbers.
+-   `generic`: values of any type.
+-   `int16`: signed 16-bit integers.
+-   `int32`: signed 32-bit integers.
+-   `int8`: signed 8-bit integers.
+-   `uint16`: unsigned 16-bit integers.
+-   `uint32`: unsigned 32-bit integers.
+-   `uint8`: unsigned 8-bit integers.
+-   `uint8c`: unsigned clamped 8-bit integers.
+
+To return the subset of data type strings belonging to a specified data type kind, provide a `kind` argument.
+
+```javascript
+var out = dtypeStrings( 'floating_point' );
+// returns [...]
+```
+
+The function supports the following data type kinds:
+
+-   `floating_point`: floating-point data types.
+-   `real_floating_point`: real-valued floating-point data types.
+-   `complex_floating_point`: complex-valued floating-point data types.
+-   `boolean`: boolean data types.
+-   `integer`: integer data types.
+-   `signed_integer`: signed integer data types.
+-   `unsigned_integer`: unsigned integer data types.
+-   `real`: real-valued data types.
+-   `numeric`: numeric data types.
+-   `typed`: typed data types.
+-   `integer_index`: integer index data types.
+-   `boolean_index`: boolean index data types.
+-   `mask_index`: mask index data types.
+-   `typed_index`: typed index data types.
+-   `index`: index data types.
+-   `all`: all data types.
+
+Additionally, the function supports extending the "kinds" listed above by appending an `_and_generic` suffix to the kind name (e.g., `real_and_generic`).
+
+```javascript
+var out = dtypeStrings( 'floating_point_and_generic' );
+// returns [...]
+```
+
+</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 contains = require( '@stdlib/array/base/assert/contains' ).factory;
+var dtypeStrings = require( '@stdlib/ndarray/base/dtype-strings' );
+
+var isdtype = contains( dtypeStrings() );
+
+var bool = isdtype( 'float64' );
+// returns true
+
+bool = isdtype( 'int16' );
+// returns true
+
+bool = isdtype( 'uint8' );
+// returns true
+
+bool = isdtype( 'beep' );
+// returns false
+```
+
+</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">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/ndarray/base/dtype-strings/benchmark/benchmark.js

@@ -0,0 +1,99 @@
+/**
+* @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 isStringArray = require( '@stdlib/assert/is-string-array' ).primitives;
+var pkg = require( './../package.json' ).name;
+var dtypes = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var out;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = dtypes();
+		if ( out.length === 0 ) {
+			b.fail( 'should return a non-empty array' );
+		}
+	}
+	b.toc();
+	if ( !isStringArray( out ) ) {
+		b.fail( 'should return an array of strings' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::kind', function benchmark( b ) {
+	var values;
+	var out;
+	var i;
+
+	values = [
+		'floating_point',
+		'integer'
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = dtypes( values[ i%values.length ] );
+		if ( out.length === 0 ) {
+			b.fail( 'should return a non-empty array' );
+		}
+	}
+	b.toc();
+	if ( !isStringArray( out ) ) {
+		b.fail( 'should return an array of strings' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::kind,generic', function benchmark( b ) {
+	var values;
+	var out;
+	var i;
+
+	values = [
+		'floating_point_and_generic',
+		'integer_and_generic',
+		'boolean_and_generic'
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = dtypes( values[ i%values.length ] );
+		if ( out.length === 0 ) {
+			b.fail( 'should return a non-empty array' );
+		}
+	}
+	b.toc();
+	if ( !isStringArray( out ) ) {
+		b.fail( 'should return an array of strings' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/ndarray/base/dtype-strings/docs/repl.txt

@@ -0,0 +1,68 @@
+
+{{alias}}( [kind] )
+    Returns a list of ndarray data type strings.
+
+    When not provided a data type "kind", the function returns an array
+    containing the following data type strings:
+
+    - float16: half-precision floating-point numbers.
+    - float32: single-precision floating-point numbers.
+    - float64: double-precision floating-point numbers.
+    - complex32: half-precision complex floating-point numbers.
+    - complex64: single-precision complex floating-point numbers.
+    - complex128: double-precision complex floating-point numbers.
+    - bool: boolean values.
+    - generic: values of any type.
+    - int16: signed 16-bit integers.
+    - int32: signed 32-bit integers.
+    - int8: signed 8-bit integers.
+    - uint16: unsigned 16-bit integers.
+    - uint32: unsigned 32-bit integers.
+    - uint8: unsigned 8-bit integers.
+    - uint8c: unsigned clamped 8-bit integers.
+    - binary: binary.
+
+    The function supports the following data type "kinds":
+
+    - floating_point: floating-point data types.
+    - real_floating_point: real-valued floating-point data types.
+    - complex_floating_point: complex-valued floating-point data types.
+    - boolean: boolean data types.
+    - integer: integer data types.
+    - signed_integer: signed integer data types.
+    - unsigned_integer: unsigned integer data types.
+    - real: real-valued data types.
+    - numeric: numeric data types.
+    - typed: typed data types.
+    - integer_index: integer index data types.
+    - boolean_index: boolean index data types.
+    - mask_index: mask index data types.
+    - typed_index: typed index data types.
+    - index: index data types.
+    - all: all data types.
+
+    Additionally, the function supports extending the "kinds" listed above by
+    appending a '_and_generic' suffix to the kind name (e.g., real_and_generic).
+
+    Parameters
+    ----------
+    kind: string (optional)
+        Data type kind.
+
+    Returns
+    -------
+    out: Array<string>
+        List of ndarray data type strings.
+
+    Examples
+    --------
+    > var out = {{alias}}()
+    [...]
+    > out = {{alias}}( 'floating_point' )
+    [...]
+    > out = {{alias}}( 'floating_point_and_generic' )
+    [...]
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/ndarray/base/dtype-strings/docs/types/index.d.ts

@@ -0,0 +1,44 @@
+/*
+* @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 { DataTypeString, DataTypeKind } from '@stdlib/types/ndarray';
+
+/**
+* Returns a list of ndarray data type strings.
+*
+* @param kind - data type kind
+* @returns list of ndarray data type strings
+*
+* @example
+* var list = dtypes();
+* // returns [...]
+*
+* @example
+* var list = dtypes( 'floating_point' );
+* // returns [...]
+*/
+declare function dtypes( kind?: DataTypeKind ): Array<DataTypeString>;
+
+
+// EXPORTS //
+
+export = dtypes;