Skip to content

Commit

Permalink
🐛 update wiki, readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfram77 committed Nov 3, 2022
1 parent 13be4ea commit 1e085c3
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 7 deletions.
14 changes: 11 additions & 3 deletions README.md
Expand Up @@ -28,7 +28,7 @@ can be obtained. To calculate the number of ways of *ordering items*, use
Find the [magnitude] of a vector or [distance] between two points.

**Statistics**: For a list of numbers, we can calculate the [sum], [product],
[mean]. [median] gives the value lying in the middle when the numbers are
[arithmeticMean]. [median] gives the value lying in the middle when the numbers are
sorted, and [modes] gives the values which are repeated most often. The
difference between the largest and the smallest values is the [range].
[variance] is a measure of variability of numbers.
Expand Down Expand Up @@ -88,14 +88,18 @@ math.lcm(2, 3, 4);
| [lerp] | Linearly interpolate a number between two numbers. |
| | |
| [isPow] | Check if a number is a power-of-n. |
| [prevPow] | Get previous power-of-n of a number. |
| [nextPow] | Find next power-of-n of a number. |
| [prevPow] | Find largest power-of-n less than or equal to given number. |
| [nextPow] | Find smallest power-of-n greater than or equal to given number. |
| | |
| [root] | Find the nth root of a number (ⁿ√). |
| [log] | Find the logarithm of a number with a given base. |
| | |
| [properDivisors] | List all divisors of a number, except itself. |
| [aliquotSum] | Sum all proper divisors of a number. |
| [minPrimeFactor] | Find the least prime number which divides a number. |
| [maxPrimeFactor] | Find the greatest prime number which divides a number. |
| [primeFactors] | Find the prime factors of a number. |
| [primeExponentials] | Find the prime factors and respective exponents of a number. |
| [isPrime] | Check if number is prime. |
| [gcd] | Find the greatest common divisor of numbers. |
| [lcm] | Find the least common multiple of numbers. |
Expand Down Expand Up @@ -172,6 +176,10 @@ math.lcm(2, 3, 4);
[log]: https://nodef.github.io/extra-math/functions/log.html
[properDivisors]: https://nodef.github.io/extra-math/functions/properDivisors.html
[aliquotSum]: https://nodef.github.io/extra-math/functions/aliquotSum.html
[minPrimeFactor]: https://nodef.github.io/extra-math/functions/minPrimeFactor.html
[maxPrimeFactor]: https://nodef.github.io/extra-math/functions/maxPrimeFactor.html
[primeFactors]: https://nodef.github.io/extra-math/functions/primeFactors.html
[primeExponentials]: https://nodef.github.io/extra-math/functions/primeExponentials.html
[isPrime]: https://nodef.github.io/extra-math/functions/isPrime.html
[gcd]: https://nodef.github.io/extra-math/functions/gcd.html
[lcm]: https://nodef.github.io/extra-math/functions/lcm.html
Expand Down
1 change: 1 addition & 0 deletions build.js
Expand Up @@ -98,6 +98,7 @@ function generateWiki(ds) {
for (var d of ds) {
var f = `wiki/${d.name}.md`;
if (!rkind.test(d.kind)) continue;
d.description = d.description.replace(/\[📘\]\(.+?\)/g, '').trim();
if (!fs.existsSync(f)) {
var txt = build.wikiMarkdown(d, {owner, repo, useWiki});
build.writeFileText(f, txt);
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "extra-math",
"version": "1.3.17",
"version": "1.3.18",
"description": "A collection of common mathematical functions.",
"main": "index.js",
"module": "index.mjs",
Expand Down
2 changes: 1 addition & 1 deletion wiki
Submodule wiki updated from 27f255 to e08d49

0 comments on commit 1e085c3

Please sign in to comment.