time-to-botec

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

index.js (1185B)

      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 /**
     22 * Test if a value is a 64-bit or 128-bit complex number.
     23 *
     24 * @module @stdlib/assert/is-complex
     25 *
     26 * @example
     27 * var Complex128 = require( '@stdlib/complex/float64' );
     28 * var Complex64 = require( '@stdlib/complex/float32' );
     29 * var isComplex = require( '@stdlib/assert/is-complex' );
     30 *
     31 * var x = new Complex128( 4.0, 2.0 );
     32 * var bool = isComplex( x );
     33 * // returns true
     34 *
     35 * x = new Complex64( 4.0, 2.0 );
     36 * bool = isComplex( x );
     37 * // returns true
     38 */
     39 
     40 // MODULES //
     41 
     42 var isComplex = require( './main.js' );
     43 
     44 
     45 // EXPORTS //
     46 
     47 module.exports = isComplex;