Merge pull request #432 from LingDong-/docs/stdlib

docs: add script for building standard lib docs

Author: LingDong-

README.md

@@ -207,9 +207,10 @@ Arrays are 1-indexed.
 
 ### Advance Features
 
+- [Standard Library](./documentation/Standard-Lib.md)
 - [Try...Catch](./documentation/Try-Catch.md)
 - [Nested Function Calls](./documentation/Nested-Function-Calls.md)
-- [Importing and Standard Library](./documentation/Importing.md)
+- [Importing](./documentation/Importing.md)
 
 ## Renderer
 

documentation/Standard-Lib.md

@@ -0,0 +1,85 @@
+<!-- GENERATED FILE, DO NOT MODIFY-->
+
+[Back to README](../README.md)
+
+# Standard Library Cheatsheet
+
+Last updated: Mon, 30 Dec 2019 15:32:37 GMT
+
+
+## Usage
+
+```
+吾嘗觀「「算經」」之書。方悟「正弦」「餘弦」「圓周率」之義。
+```
+
+## [易經](../lib/易經.wy)
+
+| Wenyan | Javascript Equivalent |
+|---|---|
+
+## [算經](../lib/算經.wy)
+
+| Wenyan | Javascript Equivalent |
+|---|---|
+| [`圓周率`](../lib/算經.wy#L166) | `Math.PI` |
+| [`倍圓周率`](../lib/算經.wy#L169) | `Math.PI * 2` |
+| [`半圓周率`](../lib/算經.wy#L172) | `Math.PI / 2` |
+| [`四分圓周率`](../lib/算經.wy#L175) | `Math.PI / 4` |
+| [`自然常數`](../lib/算經.wy#L177) | `Math.E` |
+| [`歐拉常數`](../lib/算經.wy#L179) | `0.5772156649015329` |
+| [`黃金分割數`](../lib/算經.wy#L181) | `1.618033988749895` |
+| [`二之平方根`](../lib/算經.wy#L183) | `Math.SQRT2` |
+| [`二之對數`](../lib/算經.wy#L185) | `Math.LN2` |
+| [`十之對數`](../lib/算經.wy#L187) | `Math.LN10` |
+| [`不可算數乎`](../lib/算經.wy#L190) | `Number.isNaN` |
+| [`浮點移位`](../lib/算經.wy#L392) | `x * Math.pow(2, y), y is integer` |
+| [`析浮點數`](../lib/算經.wy#L428) | `N/A` |
+| [`正弦`](../lib/算經.wy#L472) | `Math.sin` |
+| [`餘弦`](../lib/算經.wy#L502) | `Math.cos` |
+| [`反正弦`](../lib/算經.wy#L510) | `Math.asin` |
+| [`反餘弦`](../lib/算經.wy#L537) | `Math.acos` |
+| [`正切`](../lib/算經.wy#L544) | `Math.tan` |
+| [`反正切`](../lib/算經.wy#L581) | `Math.atan` |
+| [`勾股求角`](../lib/算經.wy#L615) | `Math.atan2` |
+| [`勾股求弦`](../lib/算經.wy#L633) | `Math.hypot` |
+| [`對數`](../lib/算經.wy#L670) | `Math.log` |
+| [`指數`](../lib/算經.wy#L713) | `Math.exp` |
+| [`冪`](../lib/算經.wy#L749) | `Math.pow` |
+| [`平方根`](../lib/算經.wy#L773) | `Math.sqrt` |
+| [`絕對`](../lib/算經.wy#L834) | `Math.abs` |
+| [`取頂`](../lib/算經.wy#L839) | `Math.ceil` |
+| [`取底`](../lib/算經.wy#L844) | `Math.floor` |
+| [`取整`](../lib/算經.wy#L859) | `Math.round, but rounded away from zero when the fractional part is exactly 0.5` |
+| [`捨餘`](../lib/算經.wy#L873) | `Math.trunc` |
+| [`正負`](../lib/算經.wy#L883) | `Math.sign` |
+
+## [籌經](../lib/籌經.wy)
+
+| Wenyan | Javascript Equivalent |
+|---|---|
+| [`求和`](../lib/籌經.wy#L1) | `reduce((a,b)=>a+b)` |
+
+## [位經](../lib/js/位經.wy)
+
+| Wenyan | Javascript Equivalent |
+|---|---|
+
+
+
+
+## Help update this cheatsheet
+
+This cheatsheet is generated direct from stdlibs. There are still a lot of functions are not listed above. If you would like to hep update this cheatsheet, here is the steps.
+
+Add comments in the stdlib files (one line above the function/value), the format should look like this:
+```
+注曰「「餘弦。同Javascript之Math.cos也。」」
+```
+
+After you fill the comments, you need to update the document by running
+```bash
+npm run docs:update
+```
+
+Check the output document out and submit a pull request. Thank you!

lib/js/位經.wy

@@ -1,31 +1,39 @@
+疏曰「「左移。同犀之x<<y也。」」
 今有一術。名之曰「左移」。欲行是術。必先得二數。曰「甲」。曰「乙」。乃行是術曰。
 	施「(x=>y=>(x<<y))」於「甲」。於「乙」。名之曰「丙」。乃得「丙」。
 是謂「左移」之術也。
 
+疏曰「「右移。同犀之x>>y也。」」
 今有一術。名之曰「右移」。欲行是術。必先得二數。曰「甲」。曰「乙」。乃行是術曰。
 	施「(x=>y=>(x>>y))」於「甲」。於「乙」。名之曰「丙」。乃得「丙」。
 是謂「右移」之術也。
 
+疏曰「「補零右移。同犀之x>>>y也。」」
 今有一術。名之曰「補零右移」。欲行是術。必先得二數。曰「甲」。曰「乙」。乃行是術曰。
 	施「(x=>y=>(x>>>y))」於「甲」。於「乙」。名之曰「丙」。乃得「丙」。
 是謂「補零右移」之術也。
 
+疏曰「「位与。同犀之x&y也。」」
 今有一術。名之曰「位与」。欲行是術。必先得二數。曰「甲」。曰「乙」。乃行是術曰。
 	施「(x=>y=>(x&y))」於「甲」。於「乙」。名之曰「丙」。乃得「丙」。
 是謂「位与」之術也。
 
+疏曰「「位或。同犀之x|y也。」」
 今有一術。名之曰「位或」。欲行是術。必先得二數。曰「甲」。曰「乙」。乃行是術曰。
 	施「(x=>y=>(x|y))」於「甲」。於「乙」。名之曰「丙」。乃得「丙」。
 是謂「位或」之術也。
 
+疏曰「「异或。同犀之x^y也。」」
 今有一術。名之曰「异或」。欲行是術。必先得二數。曰「甲」。曰「乙」。乃行是術曰。
 	施「(x=>y=>(x^y))」於「甲」。於「乙」。名之曰「丙」。乃得「丙」。
 是謂「异或」之術也。
 
+疏曰「「与非。同犀之~(x&y)也。」」
 今有一術。名之曰「与非」。欲行是術。必先得二數。曰「甲」。曰「乙」。乃行是術曰。
 	施「(x=>y=>(~(x&y)))」於「甲」。於「乙」。名之曰「丙」。乃得「丙」。
 是謂「与非」之術也。
 
+疏曰「「位變。同犀之~x也。」」
 今有一術。名之曰「位變」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	施「(x=>y=>(~x))」於「甲」。名之曰「乙」。乃得「乙」。
 是謂「位變」之術也。

lib/算經.wy

@@ -163,20 +163,31 @@
 是謂「盤古」之術也。
 施「盤古」。
 
+注曰「「圓周率。同Javascript之Math.PI也。」」
 今有一數。曰「假圓周率」。名之曰「圓周率」。注曰「「圓周率者。三又一分四釐一毫有奇也。」」
 乘二於「圓周率」。名之曰「假倍圓周率」。
+注曰「「倍圓周率。同Javascript之Math.PI * 2也。」」
 今有一數。曰「假倍圓周率」。名之曰「倍圓周率」。
 除二於「圓周率」。名之曰「假半圓周率」。
+注曰「「半圓周率。同Javascript之Math.PI / 2也。」」
 今有一數。曰「假半圓周率」。名之曰「半圓周率」。
 除四於「圓周率」。名之曰「假四分圓周率」。
+注曰「「四分圓周率。同Javascript之Math.PI / 4也。」」
 今有一數。曰「假四分圓周率」。名之曰「四分圓周率」。
+注曰「「自然常數。同Javascript之Math.E也。」」
 今有一數。曰「假自然常數」。名之曰「自然常數」。注曰「「自然常數者。二又七分一釐八毫有奇也。」」
+注曰「「歐拉常數。同Javascript之0.5772156649015329也。」」
 今有一數。曰「假歐拉常數」。名之曰「歐拉常數」。注曰「「歐拉常數者。五分七釐七毫二絲有奇也。」」
+注曰「「黃金分割數。同Javascript之1.618033988749895也。」」
 今有一數。曰「假黃金分割數」。名之曰「黃金分割數」。注曰「「黃金分割數者。一又六分一釐八毫有奇也。」」
+注曰「「二之平方根。同Javascript之Math.SQRT2也。」」
 今有一數。曰「假二之平方根」。名之曰「二之平方根」。注曰「「二之平方根者。一又四分一釐四毫有奇也。」」
+注曰「「二之對數。同Javascript之Math.LN2也。」」
 今有一數。曰「假二之對數」。名之曰「二之對數」。注曰「「二之對數者。六分九釐三毫一絲有奇也。」」
+注曰「「十之對數。同Javascript之Math.LN10也。」」
 今有一數。曰「假十之對數」。名之曰「十之對數」。注曰「「十之對數者。二又三分零釐二毫有奇也。」」
 
+注曰「「不可算數乎。同Javascript之Number.isNaN也。」」
 今有一術。名之曰「不可算數乎」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	若「甲」等於「甲」者。乃得陰。
 	若非。乃得陽也。
@@ -378,6 +389,7 @@
 	云云。
 是謂「求多項式」之術也。
 
+注曰「「浮點移位。同Javascript之x * Math.pow(2, y), y is integer也。」」
 今有一術。名之曰「浮點移位」。欲行是術。必先得二數。曰「本」。曰「位」。乃行是術曰。
 	注曰「「位正則進位。負則退位。」」
 	若「位」不大於「至大指」者。若「位」不小於「至小指」者。
@@ -413,6 +425,7 @@
 	云云。
 是謂「浮點移位」之術也。
 
+注曰「「析浮點數。同Javascript之N/A也。」」
 今有一術。名之曰「析浮點數」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	注曰「「是術得一物。物有三數。曰符。曰位。曰本。符者。正負也。位者。進退位也。本者。本數也。」」
 	注曰「「設計算機二進。若施是術於負六。乃得符負一。位二。本一又五分。」」
@@ -456,6 +469,7 @@
 	云云。
 是謂「析浮點數」之術也。
 
+注曰「「正弦。同Javascript之Math.sin也。」」
 今有一術。名之曰「正弦」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「數小甚矣。乃得其身。否則以泰勒展開求之。復以週期性得其餘。」」
 
@@ -485,14 +499,15 @@
 
 是謂「正弦」之術也。
 
+注曰「「餘弦。同Javascript之Math.cos也。」」
 今有一術。名之曰「餘弦」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「餘弦者。蓋正弦之變化所得。」」
 
 	加「甲」以「半圓周率」。取一以施「正弦」。乃得矣。
 
 是謂「餘弦」之術也。
 
-
+注曰「「反正弦。同Javascript之Math.asin也。」」
 今有一術。名之曰「反正弦」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「Abramowitz & Stegun 書中所述之法」」
 	若「甲」小於零者。
@@ -519,14 +534,14 @@
 
 是謂「反正弦」之術也。
 
-
+注曰「「反餘弦。同Javascript之Math.acos也。」」
 今有一術。名之曰「反餘弦」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「反餘弦者。蓋反正弦之變化所得。」」
 	減零以「甲」。取一以施「反正弦」。加其以「半圓周率」。乃得矣。
 
 是謂「反餘弦」之術也。
 
-
+注曰「「正切。同Javascript之Math.tan也。」」
 今有一術。名之曰「正切」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「數小甚矣。乃得其身。居零與二十二度三十分之間者。以泰勒展開求之。其餘或以三角恆等式。或以週期性可得。」」
 
@@ -563,7 +578,7 @@
 
 是謂「正切」之術也。
 
-
+注曰「「反正切。同Javascript之Math.atan也。」」
 今有一術。名之曰「反正切」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「數小甚矣。乃得其身。小於二減根號三者。以泰勒展開求之。其餘以三角恆等式變化可得。」」
 
@@ -597,6 +612,7 @@
 是謂「反正切」之術也。
 
 
+注曰「「勾股求角。同Javascript之Math.atan2也。」」
 今有一術。名之曰「勾股求角」。欲行是術。必先得二數曰「甲」。曰「乙」。乃行是術曰。
 	注曰「「反正切之分類討論也」」
 
@@ -614,6 +630,7 @@
 是謂「勾股求角」之術也。
 
 
+注曰「「勾股求弦。同Javascript之Math.hypot也。」」
 今有一術。名之曰「勾股求弦」。欲行是術。必先得二數曰「勾」。曰「股」。乃行是術曰。
 	施「絕對」於「勾」。名之曰「甲」。
 	施「絕對」於「股」。名之曰「乙」。
@@ -650,6 +667,7 @@
 	除一以十九。充「對數多項式甲」以其。
 注曰「「 x^2 * f(x^2) = atanh(x)/x - 1 」」
 
+注曰「「對數。同Javascript之Math.log也。」」
 今有一術。名之曰「對數」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「自然對數。」」
 	有爻陽。名之曰「非常」。
@@ -692,6 +710,7 @@
 	除負一千三百八十二以六億三千八百五十一萬二千八百七十五。充「指數多項式甲」以其。
 注曰「「 x^2 * f(x^2) = x/tanh(x) - 1 」」
 
+注曰「「指數。同Javascript之Math.exp也。」」
 今有一術。名之曰「指數」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「自然指數。」」
 	有爻陽。名之曰「非常」。
@@ -727,6 +746,7 @@
 	施「浮點移位」於「庚」。於「移位數」。乃得矣。
 是謂「指數」之術也。
 
+注曰「「冪。同Javascript之Math.pow也。」」
 今有一術。名之曰「冪」。欲行是術。必先得二數。曰「底」。曰「指」。乃行是術曰。
 	注曰「「小數部借指數算之。整數部死算可矣。」」
 
@@ -750,6 +770,7 @@
 減一於「二之平方根」。乘其以二。名之曰「平方根常數乙」。
 乘「上位冪」於「微位冪」。乘其以「進制」。乘其以「進制」。名之曰「平方根下溢界」。
 
+注曰「「平方根。同Javascript之Math.sqrt也。」」
 今有一術。名之曰「平方根」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	有爻陽。名之曰「非常」。
 	若「甲」不小於「平方根下溢界」者。若「甲」小於「巨位冪」者。
@@ -810,14 +831,17 @@
 	乃得「乙」。
 是謂「平方根」之術也。
 
+注曰「「絕對。同Javascript之Math.abs也。」」
 今有一術。名之曰「絕對」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	施「正負」於「甲」。名之曰「符」。乘「符」於「甲」。乃得矣。
 是謂「絕對」之術也。
 
+注曰「「取頂。同Javascript之Math.ceil也。」」
 今有一術。名之曰「取頂」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	乘負一於「甲」。取一以施「取底」。乘其以負一。乃得矣。
 是謂「取頂」之術也。
 
+注曰「「取底。同Javascript之Math.floor也。」」
 今有一術。名之曰「取底」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	施「正負」於「甲」。名之曰「符」。乘「符」於「甲」。名之曰「乙」。
 	注曰「「JavaScript者。除負以正。所餘負也。Python者。除負以正。所餘正也。」」
@@ -832,6 +856,7 @@
 		乃得「甲」也。
 是謂「取底」之術也。
 
+注曰「「取整。同Javascript之Math.round, but rounded away from zero when the fractional part is exactly 0.5也。」」
 今有一術。名之曰「取整」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	施「正負」於「甲」。名之曰「符」。乘「符」於「甲」。名之曰「乙」。
 	除「乙」以一。所餘幾何。名之曰「丙」。
@@ -845,6 +870,7 @@
 		乃得「甲」也。
 是謂「取整」之術也。
 
+注曰「「捨餘。同Javascript之Math.trunc也。」」
 今有一術。名之曰「捨餘」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	施「正負」於「甲」。名之曰「符」。乘「符」於「甲」。名之曰「乙」。
 	除「乙」以一。所餘幾何。名之曰「丙」。
@@ -854,6 +880,7 @@
 		乃得「甲」也。
 是謂「捨餘」之術也。
 
+注曰「「正負。同Javascript之Math.sign也。」」
 今有一術。名之曰「正負」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	若「甲」大於零者。乃得一也。
 	若「甲」小於零者。乃得負一也。

lib/籌經.wy

@@ -1,3 +1,4 @@
+注曰「「求和。同Javascript之reduce((a,b)=>a+b)也。」」
 今有一術。名之曰「求和」。欲行是術。必先得一列。曰「列」。乃行是術曰。
 吾有一數。曰零。名之曰「和」。凡「列」中之「數」。加「和」以「數」。
 名之曰「和」。云云。乃得「和」。是謂「求和」之術也。

package.json

@@ -25,6 +25,7 @@
     "publish": "bump --commit && node ./tools/publish.js",
     "publish:ci": "node ./tools/publish.js",
     "release": "bump --commit --tag && git push --follow-tags",
+    "docs:update": "node ./tools/stdlib_doc.js",
     "make_ide": "node ./tools/make_ide.js",
     "make_site": "node ./tools/make_site.js",
     "ide:dev": "nodemon --ignore build,dist ./tools/make_ide.js",