time-to-botec

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

index.js (1360B)

      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 * Evaluate the signum function of a complex number.
     23 *
     24 * @module @stdlib/math/base/special/csignum
     25 *
     26 * @example
     27 * var csignum = require( '@stdlib/math/base/special/csignum' );
     28 *
     29 * var v = csignum( -4.2, 5.5 );
     30 * // returns [ -0.6069136033622302, 0.79476781392673 ]
     31 *
     32 * v = csignum( 0.0, 0.0 );
     33 * // returns [ 0.0, 0.0 ]
     34 *
     35 * v = csignum( NaN, NaN );
     36 * // returns [ NaN, NaN ]
     37 *
     38 * @example
     39 * var csignum = require( '@stdlib/math/base/special/csignum' );
     40 *
     41 * var out = new Array( 2 );
     42 *
     43 * var v = csignum( out, -4.2, 5.5 );
     44 * // returns [ -0.6069136033622302, 0.79476781392673 ]
     45 *
     46 * var bool = ( v === out );
     47 * // returns true
     48 */
     49 
     50 // MODULES //
     51 
     52 var csignum = require( './main.js' );
     53 
     54 
     55 // EXPORTS //
     56 
     57 module.exports = csignum;