wink-statistics/src/get-valid-fd.js

Fast and Numerically Stable Statistical Analysis Utilities

//     wink-statistics
//     Fast and Numerically Stable Statistical Analysis Utilities.
//
//     Copyright (C) GRAYPE Systems Private Limited
//
//     This file is part of “wink-statistics”.
//
//     Permission is hereby granted, free of charge, to any person obtaining a
//     copy of this software and associated documentation files (the "Software"),
//     to deal in the Software without restriction, including without limitation
//     the rights to use, copy, modify, merge, publish, distribute, sublicense,
//     and/or sell copies of the Software, and to permit persons to whom the
//     Software is furnished to do so, subject to the following conditions:
//
//     The above copyright notice and this permission notice shall be included
//     in all copies or substantial portions of the Software.
//
//     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
//     OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
//     THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//     FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
//     DEALINGS IN THE SOFTWARE.

var isFiniteInteger = require( 'wink-helpers' ).validate.isFiniteInteger;

// ### getValidatFD
/**
 * Returns valid fraction digits: either `fractionDigits` if it is a valid is a
 * valid finite integer, or **4** — default fraction digits.
 *
 * @private
 *
 * @param {number} fractionDigits i.e. number of digits to round in a fraction.
 * @return {number} — valid fraction digits.
 *
*/
var getValidFD = function ( fractionDigits ) {
  return ( isFiniteInteger( fractionDigits ) ) ? fractionDigits : 4;
};

module.exports = getValidFD;