All the notations that are included in current version of Antimatter Dimensions and the upcoming Reality Update.
See it in action here
The simplest way to use this package is to include these scripts in your HTML page:
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/break_infinity.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@antimatter-dimensions/notations"></script>You can also grab specific versions here:
- https://github.com/Patashu/break_infinity.js/releases
- https://github.com/antimatter-dimensions/notations/releases
npm install @antimatter-dimensions/notations
There is no default export. The correct way to import notations is:
import * as ADNotations from "@antimatter-dimensions/notations";All the notations are included inside ADNotations object:
const scientific = new ADNotations.ScientificNotation();The main method that notations provide is format(value, places, placesUnder1000)
valuecan beDecimal,numberorstringwhich you want to formatplacesis used to format mantissa when number is greater than 1000placesUnder1000is used to format the number when it is lesser than 1000
const scientific = new ADNotations.ScientificNotation();
// Outputs "1000.00"
console.log(scientific.format(1000, 2, 2));
// Outputs "1.00e100,000"
console.log(scientific.format("1e100", 2, 0));
// Outputs "1e100,000"
console.log(scientific.format(new Decimal(1e100), 0, 0));You can configure some formatting aspects via ADNotations.Settings object:
const scientific = new ADNotations.ScientificNotation();
// Outputs "1e100,000"
console.log(scientific.format("1e100000", 2, 2));
// Outputs "1e100000"
ADNotations.Settings.exponentCommas.show = false;
console.log(scientific.format("1e100000", 2, 2));
// Outputs "Infinite"
ADNotations.Settings.isInfinite = decimal => decimal.gte(1e100);
console.log(scientific.format(1e101, 2, 2));Configuration settings:
Settings.isInfinite- function that determines if aDecimalvalue is infinite (default isdecimal => decimal.gte(Decimal.MAX_VALUE))Settings.exponentCommas.show- show commas in formatted output (default is true)Settings.exponentCommas.min- lower bound for exponent to be formatted with commas (default is 100000)Settings.exponentCommas.max- upper bound for exponent to be formatted with commas (default is 1000000000)
Creating your own notations is very simple! Just extend base class Notation
and implement the required methods get name() and formatDecimal:
class SimpleNotation extends ADNotations.Notation {
get name() {
return "Simple";
}
formatDecimal(value, places) {
return `Mantissa: ${value.mantissa.toFixed(places)}, Exponent: ${value.exponent}`;
}
}You can also extend existing notations (like CancerNotation does) and override
other methods, but this is a more advanced case which you can figure out by
looking at the source code of existing notations.
First, clone the repo
git clone https://github.com/antimatter-dimensions/notations.git
cd notations
Then install npm dependencies
npm install
And then run build command which will build all targets to the dist directory.
npm run build
Special thanks to the authors of notations:
- Scientific: https://github.com/iblobtouch
- Engineering: https://github.com/iblobtouch
- Letters: https://github.com/iblobtouch
- Standard: https://github.com/1234abcdcba4321
- Cancer: haha hevi screw u 😂😂😂
- Mixed Scientific: https://github.com/IvarK
- Mixed Engineering: https://github.com/IvarK
- Logarithm: https://github.com/IvarK
- Brackets: https://github.com/JCBoorgo
- Infinity: https://github.com/omsi6
- Roman: https://github.com/Razenpok
- Dots: https://github.com/garnet420
- Zalgo: https://github.com/cyip92
- Hex: https://github.com/dan-simon
- Imperial: https://github.com/garnet420, https://github.com/realrapidjazz
- Clock: https://github.com/Razenpok, https://github.com/garnet420
- Prime: https://github.com/Ikerstreamer
- Bar: https://github.com/earthernsence
- Shi: https://github.com/dan-simon
- Blind: https://github.com/earthernsence
Additional thanks to https://github.com/omsi6 for the scaffolding of docs page.