bignumber.js 使用记录
2020-12-08 本文已影响0人
袁俊亮技术博客
bignumber.js 使用记录
本文可以看做是对 bignumber.js 官方文档的翻译。
bignumber.js 是一个用于进行数学运算的库，支持任意精度。官网, 可以在官网的 console 中测试它的 API
/*
* n {number|string|BigNumber} A numeric value.
* [b] {number} The base of n. Integer, 2 to ALPHABET.length inclusive.
*/
function BigNumber(n, b) {
}
复制代码
clone()
生成一个独立的 BigNumber 构造函数
var BN = BigNumber.clone()
BN(1).div(3).toNumber() //0.3333333333333333
复制代码
config()
为这个独立的 BigNumber 构造函数设置参数
主要包括以下几个参数：
- DECIMAL_PLACES(默认值：20) 用于设置小数位数。在除法、开方、指数计算时会用到。
var BN = BigNumber.clone()
BN.config({DECIMAL_PLACES:4})
BN(1).div(3).toNumber() //0.3333，注意跟上面计算结果的区别
复制代码
- ROUNDING_MODE(默认值 4) 舍入模式，取值的意义可参照 文档
//取值范围：
BigNumber.ROUND_UP = 0; //远离0方向舍入
BigNumber.ROUND_DOWN = 1; //向0方向舍入
BigNumber.ROUND_CEIL = 2; //向正无限大舍入
BigNumber.ROUND_FLOOR = 3; //向负无限大舍入
BigNumber.ROUND_HALF_UP = 4; //四舍五入：向最接近的数字方向舍入，如果与两个相邻数字的距离相等，则向上舍入。
BigNumber.ROUND_HALF_DOWN = 5; //向最接近的数字方向舍入，如果与两个相邻数字的距离相等，则向下舍入。
BigNumber.ROUND_HALF_EVEN = 6; //向最接近数字方向舍入，如果与两个相邻数字的距离相等，则向相邻的偶数舍入
BigNumber.ROUND_HALF_CEIL = 7;
BigNumber.ROUND_HALF_FLOOR = 8;
复制代码
- EXPONENTIAL_AT(默认值 [-7,20]) 指数计数法
- RANGE(默认值 [-1e+9,1e+9])
- CRYPTO(默认值 false) 用于设置 BigNumber.random() 的随机生成算法。如果无法设置为 true，则使用 Math.random() 生成随机值。
- MODULO_MODE(默认值：ROUND_DOWN) 取模运算的模式
- POW_PRECISION(默认值：0) pow 运算结果的精度
- FORMATE(格式化对应的设置)
默认值：
BigNumber.config().FORMAT
==============================
{
decimalSeparator: "."
fractionGroupSeparator: " "
fractionGroupSize: 0
groupSeparator: ","
groupSize: 3
secondaryGroupSize: 0
}
复制代码
maximum([]),minimum([])
获取数组中的最大值 / 最小值
random([precision])
返回一个伪随机值，参数可以指定小数点位数
加法：.plus(n [, base]) ⇒ BigNumber
0.1 + 0.2 // 0.30000000000000004
x = new BigNumber(0.1)
y = x.plus(0.2) // '0.3'
BigNumber(0.7).plus(x).plus(y) // '1'
x.plus('0.1', 8) // '0.225'
复制代码
减法：.minus(n [, base]) ⇒ BigNumber
0.3 - 0.1 // 0.19999999999999998
x = new BigNumber(0.3)
x.minus(0.1) // '0.2'
x.minus(0.6, 20) // '0'
复制代码
乘法：.times(n [, base]) ⇒ BigNumber; m.ultipliedBy(n [, base]) ⇒ BigNumber;
0.6 * 3 // 1.7999999999999998
x = new BigNumber(0.6)
y = x.multipliedBy(3) // '1.8'
BigNumber('7e+500').times(y) // '1.26e+501'
x.multipliedBy('-a', 16) // '-6
复制代码
除法
普通除法运算： .div(n [, base]) ⇒ BigNumber； .dividedBy(n [, base]) ⇒ BigNumber
x = new BigNumber(355)
y = new BigNumber(113)
x.dividedBy(y) // '3.14159292035398230088'
x.div(5) // '71'
x.div(47, 16) // '5'
复制代码
注意： 除法计算结果会根据 DECIMAL_PLACES 和 ROUNDING_MODE 两个属性设置进行舍入。
除法，返回整数： .idiv(n [, base]) ⇒ BigNumber；.dividedToIntegerByv(n [, base]) ⇒ BigNumber
x = new BigNumber(355)
y = new BigNumber(113)
x.dividedBy(y) // '3.14159292035398230088'
x.div(5) // '71'
x.div(47, 16) // '5'
复制代码
取模 / 取余： .mod(n [, base]) ⇒ BigNumber；modulo.(n [, base]) ⇒ BigNumber
1 % 0.9 // 0.09999999999999998
x = new BigNumber(1)
x.modulo(0.9) // '0.1'
y = new BigNumber(33)
y.mod('a', 33) // '3'
复制代码
注意： 取模 / 取余运算受 MODULO_MODE 设置影响
指数运算： .pow(n [, m]) ⇒ BigNumber;.exponentiatedBy(n [, m]) ⇒ BigNumber
Math.pow(0.7, 2) // 0.48999999999999994
x = new BigNumber(0.7)
x.exponentiatedBy(2) // '0.49'
BigNumber(3).pow(-2) // '0.11111111111111111111'
复制代码
注意： n 代表的是指数。如果 n<0, 计算结果肯定是小数，所以计算结果会受 DECIMAL_PLACES 和 ROUNDING_MODE 影响。
开平方：.sqrt() ⇒ BigNumber；.squareRoot.() ⇒ BigNumber
x = new BigNumber(16)
x.squareRoot()
y = new BigNumber(3)
y.sqrt()
复制代码
比较大小： .comparedTo(n [, base]) ⇒ number
比较结果，参考如下表：
1 操作数>n
-1 操作数<n
0 操作数==n
null 操作数或者n不是数字
复制代码
举例：
x = new BigNumber(Infinity)
y = new BigNumber(5)
x.comparedTo(y) // 1
x.comparedTo(x.minus(1)) // 0
y.comparedTo(NaN) // null
y.comparedTo('110', 2) // -1
复制代码
精度调整
.dp([dp [, rm]]) ⇒ BigNumber|number；decimalPlaces.[dp [, rm]]) ⇒ BigNumber|number 根据 dp(decimals places) 和 rm(round mode) 对操作数进行舍入
x = new BigNumber(1234.56)
x.decimalPlaces(1) // '1234.6'
x.dp() // 2 如果不传dp，则函数返回的是操作数的小数点的位数
x.decimalPlaces(2) // '1234.56'
x.dp(10) // '1234.56'
x.decimalPlaces(0, 1) // '1234'
x.dp(0, 6) // '1235'
x.decimalPlaces(1, 1) // '1234.5'
x.dp(1, BigNumber.ROUND_HALF_EVEN) // '1234.6'
x // '1234.56'
复制代码
取整：.integerValue([rm]) ⇒ BigNumber
根据 rm(round mode) 返回操作数的整数部分
x = new BigNumber(123.456)
x.integerValue()
x.integerValue(BigNumber.ROUND_CEIL)
y = new BigNumber(-12.7)
y.integerValue()
y.integerValue(BigNumber.ROUND_DOWN)
复制代码
有效数字 .sd([d [, rm]]) ⇒ BigNumber|number；precision.([d [, rm]]) ⇒ BigNumber|number
什么是有效数字？---> 从该数的第一个非零数字起，直到末尾数字止的数字称为有效数字，如 0.618 的有效数字有三个，分别是 6,1,8。
x = new BigNumber(9876.54321)
x.precision(6) // '9876.54'
x.sd() // 9 如果省略参数d，则返回有效数字个数
x.precision(6, BigNumber.ROUND_UP) // '9876.55'
x.sd(2) // '9900' //todo
x.precision(2, 1) // '9800' //todo
y = new BigNumber(987000)
y.precision() // 3
y.sd(true) // 6,如多参数sd为true，则整数部分后边的0也会被认为是有效数字
复制代码
.toFixed([dp [, rm]]) ⇒ string
返回一个字符串，小数位根据 dp 截取或者填充。
注意： Unlike Number.prototype.toFixed, which returns exponential notation if a number is greater or equal to 1021, this method will always return normal notation.
跟 Number.prototype.toFixed(dp) 的异同
- 如果省略参数 dp，BigNumber(1.123).toFixed() 原样返回'1.123'; 而 1.123.toFixed() 会去掉所有小数位，只返回整数位'1'
- 如果操作数大于 1021，BigNumber(1021).toFixed() 会跟普通数字一样返回；10^21.toFixed() 会通过指数形式返回
Math.pow(10,20).toFixed() //"100000000000000000000"
Math.pow(10,21).toFixed() //"1e+21"
BigNumber(10).pow(20).toFixed() //"100000000000000000000"
BigNumber(10).pow(21).toFixed() //"1000000000000000000000"
复制代码
示例：
x = 3.456
y = new BigNumber(x)
x.toFixed() // '3'
y.toFixed() // '3.456'
y.toFixed(0) // '3'
x.toFixed(2) // '3.46'
y.toFixed(2) // '3.46'
y.toFixed(2, 1) // '3.45' (ROUND_DOWN)
x.toFixed(5) // '3.45600'
y.toFixed(5) // '3.45600'
复制代码
注意： toFixed() 方法与 dp() 方法的主要区别是，toFixed 返回的是字符串，如果小数位不够的话会用 0 补齐；dp() 方法返回的是 BigNumber|number，小数位不够的话会忽略
数字格式化 .toFormat([dp [, rm]]) ⇒ string
返回字符串，会根据 dp 和 rm 进行舍入, 并根据 FORMAT 属性进行格式化。
format = {
decimalSeparator: '.',
groupSeparator: ',',
groupSize: 3,
secondaryGroupSize: 0,
fractionGroupSeparator: ' ',
fractionGroupSize: 0
}
BigNumber.config({ FORMAT: format })
x = new BigNumber('123456789.123456789')
x.toFormat() // '123,456,789.123456789'
x.toFormat(1) // '123,456,789.1'
复制代码
转换为 js 基础数值类型 .toNumber() ⇒ number
效果与使用 + 运算符一致
x = new BigNumber(456.789)
x.toNumber() // 456.789
+x // 456.789
复制代码
