index.js (1217B)
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 numeric value to the nearest multiple of `10^n`. 23 * 24 * @module @stdlib/math/base/special/roundn 25 * 26 * @example 27 * var roundn = require( '@stdlib/math/base/special/roundn' ); 28 * 29 * // Round a value to 2 decimal places: 30 * var v = roundn( 3.141592653589793, -2 ); 31 * // returns 3.14 32 * 33 * // If n = 0, `roundn` behaves like `round`: 34 * v = roundn( 3.141592653589793, 0 ); 35 * // returns 3.0 36 * 37 * // Round a value to the nearest thousand: 38 * v = roundn( 12368.0, 3 ); 39 * // returns 12000.0 40 */ 41 42 // MODULES // 43 44 var roundn = require( './roundn.js' ); 45 46 47 // EXPORTS // 48 49 module.exports = roundn;