index.js (1614B)
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 * Round a complex number to the nearest multiple of `10^n` toward positive infinity. 23 * 24 * @module @stdlib/math/base/special/cceiln 25 * 26 * @example 27 * var cceiln = require( '@stdlib/math/base/special/cceiln' ); 28 * 29 * // Round components to 2 decimal places: 30 * var v = cceiln( -3.141592653589793, 3.141592653589793, -2 ); 31 * // returns [ -3.14, 3.15 ] 32 * 33 * // If n = 0, `cceiln` behaves like `cceil`: 34 * v = cceiln( 9.99999, 0.1, 0 ); 35 * // returns [ 10.0, 1.0 ] 36 * 37 * // Round components to the nearest thousand: 38 * v = cceiln( 12368.0, -12368.0, 3 ); 39 * // returns [ 13000.0, -12000.0 ] 40 * 41 * v = cceiln( NaN, NaN, 2 ); 42 * // returns [ NaN, NaN ] 43 * 44 * @example 45 * var cceiln = require( '@stdlib/math/base/special/cceiln' ); 46 * 47 * var out = [ 0.0, 0.0 ]; 48 * 49 * var v = cceiln( out, -3.141592653589793, 3.141592653589793, -2 ); 50 * // returns [ -3.14, 3.15 ] 51 * 52 * var bool = ( v === out ); 53 * // returns true 54 */ 55 56 // MODULES // 57 58 var cceiln = require( './main.js' ); 59 60 61 // EXPORTS // 62 63 module.exports = cceiln;