Package Exports
- numbers
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (numbers) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Numbers - an advanced mathematics toolkit for JavaScript and Node.js developed by Steve Kaliski, @sjkaliski
Description
Numbers provides a comprehensive set of mathematical tools that currently are not offered in JavaScript. These tools include:
- Basic calculations
- Calculus
- Matrix Operations
- Prime Numbers
- Statistics
- More...
A few things to note before using: JavaScript, like many languages, does not necessarily manage floating points as well as we'd all like it to. For example, if adding decimals, the addition tool won't return the exact value. This is an unfortunate error. Precautions have been made to account for this. After including numbers, you can set an error bound. Anything in this will be considered an "acceptable outcome."
The primary uses cases are client side operations which the DOM will recognize (e.g. 1.1px == 1px). It can be used for data analysis, calculations, etc. on the server as well.
How to use
Numbers is pretty straightforward to use.
With node, simply require it:
var numbers = require('numbers');
For example, if we wanted to estimate the integral of sin(x) from -2 to 4, we could:
Use riemann integrals (with 200 subdivisions)
var numbers = require('numbers');
var func = function(x) {
return Math.sin(x);
}
numbers.calculus.riemann(func, -2, 4, 200);
Or adaptive simpson quadrature (with epsilon .0001)
numbers.calculus.adaptiveSimpson(func, -2, 4, .0001);
Say we wanted to run some matrix calculations:
We can add two matrices
var array1 = [0, 1, 2];
var array2 = [3, 4, 5];
numbers.matrix.addition(array1, array2);
We can transpose a matrix
numbers.matrix.transpose(array);
Numeric.ly also includes some basic prime number analysis. We can check if a number is prime:
//basic check
numbers.prime.simple(number);
//elliptic analysis (good for huge numbers)
numbers.prime.elliptic(number);
The statistics tools include mean, median, mode, standard deviation, random sample generator, correlation, confidence intervals, t-test, chi-square, and more.
numbers.statistic.mean(array);
numbers.statistic.median(array);
numbers.statistic.mode(array);
numbers.statistic.standardDev(array);
numbers.statistic.randomSample(lower, upper, n);
numbers.statistic.correlation(array1, array2);
For further documentation, check out our JSDoc
Test
To execute, run:
npm test
Contributors
- Steve Kaliski - @sjkaliski
- David Byrd - @davidbyrd11
- Ethan Resnick - @studip101