All files / base/assert/is-complex-floating-point-data-type/lib main.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
 
/**
* @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 contains = require( '@stdlib/array/base/assert/contains' ).factory;
var dtypes = require( '@stdlib/array/dtypes' );
 
 
// MAIN //
 
/**
* Tests whether an input value is a supported array complex-valued floating-point data type.
*
* @name isComplexFloatingPointDataType
* @type {Function}
* @param {*} v - value to test
* @returns {boolean} 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
*/
var isComplexFloatingPointDataType = contains( dtypes( 'complex_floating_point' ) ); // eslint-disable-line id-length
 
 
// EXPORTS //
 
module.exports = isComplexFloatingPointDataType;