Auto-generated commit

base/assert/is-complex-floating-point-data-type/README.md

@@ -0,0 +1,153 @@
+<!--
+
+@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.
+
+-->
+
+# isComplexFloatingPointDataType
+
+> Test if an input value is a supported array complex-valued floating-point data type.
+
+<!-- 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
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var isComplexFloatingPointDataType = require( '@stdlib/array/base/assert/is-complex-floating-point-data-type' );
+```
+
+#### isComplexFloatingPointDataType( value )
+
+Tests if an input `value` is a supported array complex-valued floating-point data type.
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var bool = isComplexFloatingPointDataType( 'complex128' );
+// returns true
+
+bool = isComplexFloatingPointDataType( 'uint32' );
+// returns false
+```
+
+</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-disable id-length -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var isComplexFloatingPointDataType = require( '@stdlib/array/base/assert/is-complex-floating-point-data-type' );
+
+var bool = isComplexFloatingPointDataType( 'complex128' );
+// returns true
+
+bool = isComplexFloatingPointDataType( 'complex64' );
+// returns true
+
+bool = isComplexFloatingPointDataType( 'float32' );
+// returns false
+
+bool = isComplexFloatingPointDataType( 'float64' );
+// returns false
+
+bool = isComplexFloatingPointDataType( 'generic' );
+// returns false
+
+bool = isComplexFloatingPointDataType( 'int16' );
+// returns false
+
+bool = isComplexFloatingPointDataType( 'int32' );
+// returns false
+
+bool = isComplexFloatingPointDataType( 'int8' );
+// returns false
+
+bool = isComplexFloatingPointDataType( 'uint16' );
+// returns false
+
+bool = isComplexFloatingPointDataType( 'uint32' );
+// returns false
+
+bool = isComplexFloatingPointDataType( 'uint8' );
+// returns false
+
+bool = isComplexFloatingPointDataType( 'uint8c' );
+// returns false
+
+bool = isComplexFloatingPointDataType( '' );
+// returns false
+
+bool = isComplexFloatingPointDataType( 'foo' );
+// 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 -->

base/assert/is-complex-floating-point-data-type/benchmark/benchmark.js

@@ -0,0 +1,72 @@
+/**
+* @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' );
+var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
+var pkg = require( './../package.json' ).name;
+var isComplexFloatingPointDataType = require( './../lib' ); // eslint-disable-line id-length
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var values;
+	var out;
+	var v;
+	var i;
+
+	values = [
+		'binary',
+		'complex128',
+		'complex64',
+		'float32',
+		'float64',
+		'generic',
+		'int16',
+		'int32',
+		'int8',
+		'uint16',
+		'uint32',
+		'uint8',
+		'uint8c',
+		'foo',
+		'bar',
+		'',
+		'beep',
+		'boop'
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = values[ i%values.length ];
+		out = isComplexFloatingPointDataType( v );
+		if ( typeof out !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( !isBoolean( out ) ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

base/assert/is-complex-floating-point-data-type/docs/repl.txt

@@ -0,0 +1,44 @@
+
+{{alias}}( value )
+    Tests if an input value is a supported array complex-valued floating-point
+    data type.
+
+    Parameters
+    ----------
+    value: any
+        Value to test.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating if an input value is a supported array complex-valued
+        floating-point data type.
+
+    Examples
+    --------
+    > var bool = {{alias}}( 'complex64' )
+    true
+    > bool = {{alias}}( 'float64' )
+    false
+    > bool = {{alias}}( 'int16' )
+    false
+    > bool = {{alias}}( 'int32' )
+    false
+    > bool = {{alias}}( 'int8' )
+    false
+    > bool = {{alias}}( 'uint16' )
+    false
+    > bool = {{alias}}( 'uint32' )
+    false
+    > bool = {{alias}}( 'uint8' )
+    false
+    > bool = {{alias}}( 'uint8c' )
+    false
+    > bool = {{alias}}( '' )
+    false
+    > bool = {{alias}}( 'beep' )
+    false
+
+    See Also
+    --------
+

base/assert/is-complex-floating-point-data-type/docs/types/index.d.ts

@@ -0,0 +1,72 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Tests whether an input value is a supported array complex-valued floating-point data type.
+*
+* @param v - value to test
+* @returns boolean indicating whether an input value is a supported array complex-valued floating-point data type
+*
+* @example
+* var bool = isComplexFloatingPointDataType( 'complex64' );
+* // returns true
+*
+* bool = isComplexFloatingPointDataType( 'complex128' );
+* // returns true
+*
+* bool = isComplexFloatingPointDataType( 'float32' );
+* // returns false
+*
+* bool = isComplexFloatingPointDataType( 'float64' );
+* // returns false
+*
+* bool = isComplexFloatingPointDataType( 'generic' );
+* // returns false
+*
+* bool = isComplexFloatingPointDataType( 'int16' );
+* // returns false
+*
+* bool = isComplexFloatingPointDataType( 'int32' );
+* // returns false
+*
+* bool = isComplexFloatingPointDataType( 'int8' );
+* // returns false
+*
+* bool = isComplexFloatingPointDataType( 'uint16' );
+* // returns false
+*
+* bool = isComplexFloatingPointDataType( 'uint32' );
+* // returns false
+*
+* bool = isComplexFloatingPointDataType( 'uint8' );
+* // returns false
+*
+* bool = isComplexFloatingPointDataType( 'uint8c' );
+* // returns false
+*
+* bool = isComplexFloatingPointDataType( 'foo' );
+* // returns false
+*/
+declare function isComplexFloatingPointDataType( v: any ): boolean;
+
+
+// EXPORTS //
+
+export = isComplexFloatingPointDataType;

base/assert/is-complex-floating-point-data-type/docs/types/test.ts

@@ -0,0 +1,34 @@
+/*
+* @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.
+*/
+
+import isComplexFloatingPointDataType = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isComplexFloatingPointDataType( 'float32' ); // $ExpectType boolean
+	isComplexFloatingPointDataType( 'foo' ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isComplexFloatingPointDataType(); // $ExpectError
+	isComplexFloatingPointDataType( undefined, 123 ); // $ExpectError
+}