time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

main.js (1551B)


      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 
     26 
     27 // MAIN //
     28 
     29 /**
     30 * Tests if a value is a complex number-like object.
     31 *
     32 * @param {*} value - value to test
     33 * @returns {boolean} boolean indicating if a value is a complex number-like object.
     34 *
     35 * @example
     36 * var Complex128 = require( '@stdlib/complex/float64' );
     37 * var Complex64 = require( '@stdlib/complex/float32' );
     38 *
     39 * var x = new Complex128( 4.0, 2.0 );
     40 * var bool = isComplexLike( x );
     41 * // returns true
     42 *
     43 * x = new Complex64( 4.0, 2.0 );
     44 * bool = isComplexLike( x );
     45 * // returns true
     46 */
     47 function isComplexLike( value ) {
     48 	if ( value instanceof Complex128 || value instanceof Complex64 ) {
     49 		return true;
     50 	}
     51 	return (
     52 		typeof value === 'object' &&
     53 		value !== null &&
     54 		typeof value.re === 'number' &&
     55 		typeof value.im === 'number'
     56 	);
     57 }
     58 
     59 
     60 // EXPORTS //
     61 
     62 module.exports = isComplexLike;