main.js (1587B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var Complex128 = require( '@stdlib/complex/float64' ); 24 var Complex64 = require( '@stdlib/complex/float32' ); 25 var constructorName = require( '@stdlib/utils/constructor-name' ); 26 27 28 // MAIN // 29 30 /** 31 * Tests if a value is a 64-bit or 128-bit complex number. 32 * 33 * @param {*} value - value to test 34 * @returns {boolean} boolean indicating if a value is a 64-bit or 128-bit complex number 35 * 36 * @example 37 * var Complex128 = require( '@stdlib/complex/float64' ); 38 * var Complex64 = require( '@stdlib/complex/float32' ); 39 * 40 * var x = new Complex128( 4.0, 2.0 ); 41 * var bool = isComplex( x ); 42 * // returns true 43 * 44 * x = new Complex64( 4.0, 2.0 ); 45 * bool = isComplex( x ); 46 * // returns true 47 */ 48 function isComplex( value ) { 49 var type; 50 if ( value instanceof Complex128 || value instanceof Complex64 ) { 51 return true; 52 } 53 type = constructorName( value ); 54 return ( type === 'Complex64' || type === 'Complex128' ); 55 } 56 57 58 // EXPORTS // 59 60 module.exports = isComplex;