Package detail

decimal.js-light

MikeMcl22.9mMIT2.5.1

An arbitrary-precision Decimal type for JavaScript.

arbitrary, precision, arithmetic, big

readme

decimal.js-light

The light version of decimal.js, an arbitrary-precision Decimal type for JavaScript.

Build Status


This library is the newest of the family of libraries: bignumber.js, big.js, decimal.js and decimal.js-light.
The API is more or less a subset of the API of decimal.js.

API

Differences between this library and decimal.js

Size of decimal.js minified: 32.1 KB.
Size of decimal.js-light minified: 12.7 KB.

This library does not include NaN, Infinity or -0 as legitimate values, or work with values in other bases.

Here, the Decimal.round property is just the default rounding mode for toDecimalPlaces, toExponential, toFixed, toPrecision and toSignificantDigits. It does not apply to arithmetic operations, which are simply truncated at the required precision.

If rounding is required just apply it explicitly, for example

x = new Decimal(2);
y = new Decimal(3);

// decimal.js
x.dividedBy(y).toString();                       // '0.66666666666666666667'

// decimal.js-light
x.dividedBy(y).toString();                       // '0.66666666666666666666'
x.dividedBy(y).toDecimalPlaces(19).toString();   // '0.6666666666666666667'

The naturalExponential, naturalLogarithm, logarithm, and toPower methods in this library have by default a limited precision of around 100 digits. This limit can be increased at runtime using the LN10 (the natural logarithm of ten) configuration object property.

For example, if a maximum precision of 400 digits is required for these operations use

// 415 digits
Decimal.set({
  LN10: '2.302585092994045684017991454684364207601101488628772976033327900967572609677352480235997205089598298341967784042286248633409525465082806756666287369098781689482907208325554680843799894826233198528393505308965377732628846163366222287698219886746543667474404243274365155048934314939391479619404400222105101714174800368808401264708068556774321622835522011480466371565912137345074785694768346361679210180644507064800027'
});

Also, in this library the e property of a Decimal is the base 10000000 exponent, not the base 10 exponent as in decimal.js.
Use the exponent method to get the base 10 exponent.

Quickstart

Browser:

<script src='path/to/decimal.js-light'></script>

Node package manager:

$ npm install --save decimal.js-light
// Node.js
var Decimal = require('decimal.js-light');

// Adjust the global configuration if required (these are the defaults)
Decimal.set({
  precision: 20,
  rounding: Decimal.ROUND_HALF_UP,
  toExpNeg: -7,
  toExpPos: 21
});

phi = new Decimal('1.61803398874989484820458683436563811772030917980576');

phi.toFixed(10);    // '1.6180339887'

phi.times(2).minus(1).toPower(2).plus('1e-19').equals(5);    // true

See the documentation for further information.

TypeScript type declaration file contributed by TANAKA Koichi.

changelog

2.5.1

  • 30/09/2020
  • Correct initial sqrt estimate.

2.5.0

  • 16/10/2018
  • Add default export to decimal.d.ts.
  • Add Symbol.for('nodejs.util.inspect.custom') to decimal.mjs.

2.4.1

  • 24/05/2018
  • Add browser field to package.json.

2.4.0

  • 22/05/2018
  • Amend .mjs exports.
  • Remove extension from main field in package.json.

2.3.1

  • 13/11/2017
  • Add constructor properties to typings.
  • Amend LN10 section of doc/API.html.

2.3.0

  • 26/09/2017
  • Add bignumber.mjs.

2.2.5

  • 08/09/2017
  • 5 Fix import.

2.2.4

  • 15/08/2017
  • Add TypeScript type declaration file, decimal.d.ts
  • Correct toPositive and toNegative examples

2.2.3

  • 04/05/2017
  • Fix README badge

2.2.2

05/04/2017

  • Decimal.default to Decimal['default'] IE8 issue

2.2.1

10/03/2017

  • Remove tonum from documentation

2.2.0

10/01/2017

  • Add exponent method

2.0.2

12/12/2016

  • npm publish

2.0.1

12/12/2016

  • Filename-casing issue

2.0.0

11/12/2016

  • Make LN10 configurable at runtime
  • Reduce LN10 default precision
  • Remove ceil, floor, min, max and truncated
  • Rename divToInt to idiv, toSD to tosd, toDP to todp, isInt to isint, isNeg to isneg, isPos to ispos and round to toInteger
  • Rename some test files
  • Add set as alias to config
  • Support ES6 import shims
  • Add to README

1.0.4

28/02/2016

  • Add to README

1.0.3

25/02/2016

  • Add to README

1.0.2

25/02/2016

  • Correct url
  • Amend .travis.yml as Node.js v0.6 doesn't include process.hrtime which is used in testing.

1.0.0

24/02/2016

  • Initial release