powiaina_num.js 0.1.12 → 0.2.0-alpha.2

package/README.md

@@ -4,11 +4,68 @@ A JavaScript library that handles arithmetic for numbers as large as {10,9e15,1,
 
 This reaches level f<sub>ω<sup>3</sup>+1</sub>.
 
-Internally, it is represented as an sign,layer and array. Sign is 1 or -1. Array is \[n<sub>0</sub>,\[a<sub>0</sub>, a<sub>1</sub>, a<sub>2</sub>, a<sub>3</sub>], \[b<sub>0</sub>, b<sub>1</sub>, b<sub>2</sub>, b<sub>3</sub>], ...]. They together represents {10,{10,...{10,{10,{...{10, n<sub>0</sub>...}...},c<sub>0</sub>,c<sub>2</sub>,c<sub>3</sub>}...,b<sub>0</sub>,b<sub>2</sub>,b<sub>3</sub>},b<sub>0</sub>,b<sub>2</sub>,b<sub>3</sub>}.
-(b<sub>1</sub> is how many {10, ... ,b<sub>0</sub>,b<sub>2</sub>,b<sub>3</sub>}'s )
+Internally, it is represented as an sign,layer, small and array. Sign is 1 or -1. It's 10{oper.arrow, oper.expans, oper.megota}, If arrow count or expans count is Infinite, the count replaces from the next operators.
+
 Some codes snippet from [ExpantaNum.js by Naruyoko](https://github.com/Naruyoko/ExpantaNum.js)
 
-Functions are as follows `abs, neg, add, sub, mul, div, rec, pow, exp, sqrt, cbrt, root, log10, logarithm, logBase, f_lambertw, d_lambertw, lambertw, tetrate, expansion(eps), multiExpansion(mulEps), powerExpansion(powEps), explosion(els), cmp, isFinite, isInfinite, isNaN,  iteratedlog,  iteratedslog,  iteratedexp, pentate, arrow`(some missing items that have not been fully developed)
+Functions are as follows `abs, neg, add, sub, mul, div, rec, pow, sqrt, cbrt, root, log10, log, cmp, isFinite, isInfinite, isNaN`(some missing items that have not been fully developed)
+
+## Using
+
+The library exports a class,
+Create a PowiainaNum.js object like this:
+
+```javascript
+import PowiainaNum from "powiaina_num.js";
+
+let a = new PowiainaNum(); // create PN.js number with NaN
+let b = new PowiainaNum(3); // create PN.js number with number 3
+let c = new PowiainaNum("1e114514"); // create PN.js number with number 10^114514
+
+let d = new PowiainaNum(c); // create PN.js number from a PN.js number
+```
+
+Javascript operators will not work such as `+`, `-`, etc.
+You should call the equivalent functions instead.
+
+```javascript
+let a = new PowiainaNum(114514);
+let b = new PowiainaNum(1919810);
+
+// Calculate a+b:
+let c = a.add(b); // 1919810+114514
+
+// Calculate a-b:
+let c = a.sub(b);
+
+a.mul(b); // a*b
+a.div(b); // a/b
+a.pow(b); // a^b
+
+a.log10(); // log10(a)
+
+// comparing PN.js numbers
+
+a.lt(b); // a is less than b
+a.gt(b); // a is greater than b
+a.eq(b); // a is equals to b
+```
+
+## Future ideas
+
+Extend `Operator` to nearly infinite keys to reach level f<sub>ω<sup>ω</sup></sub>
+
+```typescript
+interface Operator {
+  /*P3*/ arrow: number;
+  /*P4*/ expans: number;
+  /*P5*/ megota: number;
+  /*P6*/ powiaina: number;
+  P7: number;
+  .....
+
+  repeat: number;
 
-## How does it come from
-PowiainaNum.js是我基于ExpantaNum.js的基础上修改结构而得来的。我将原先的\[number, number\]\[\]结构改成了\[number,number,number,number\]\[\]结构，并将"x"特殊值运用在里面，再修改程序逻辑而得出来。
+  valuereplaced?: -1 | 0 | 1 | 2 | ...
+}
+```