time-to-botec

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

croundn.js (1653B)


      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 roundn = require( './../../../../base/special/roundn' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Rounds a complex number to the nearest multiple of `10^n`.
     30 *
     31 * @private
     32 * @param {(Array|TypedArray|Object)} out - output array
     33 * @param {number} re - real component
     34 * @param {number} im - imaginary component
     35 * @param {integer} n - integer power of 10
     36 * @returns {(Array|TypedArray|Object)} output array
     37 *
     38 * @example
     39 * var out = new Array( 2 );
     40 * var v = croundn( out, -3.141592653589793, 3.141592653589793, -2 );
     41 * // returns [ -3.14, 3.14 ]
     42 *
     43 * @example
     44 * var out = new Array( 2 );
     45 * var v = croundn( out, 9.99999, 0.1, 0 );
     46 * // returns [ 10.0, 0.0 ]
     47 *
     48 * @example
     49 * var out = new Array( 2 );
     50 * var v = croundn( out, 0.0, 0.0, -2 );
     51 * // returns [ 0.0, 0.0 ]
     52 *
     53 * @example
     54 * var out = new Array( 2 );
     55 * var v = croundn( out, NaN, NaN, -2 );
     56 * // returns [ NaN, NaN ]
     57 */
     58 function croundn( out, re, im, n ) {
     59 	out[ 0 ] = roundn( re, n );
     60 	out[ 1 ] = roundn( im, n );
     61 	return out;
     62 }
     63 
     64 
     65 // EXPORTS //
     66 
     67 module.exports = croundn;