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