mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-25 15:07:57 +00:00
112 lines
3.5 KiB
Markdown
112 lines
3.5 KiB
Markdown
|
|
|
|
[http://mathjs.org](http://mathjs.org)
|
|
|
|
Math.js is an extensive math library for JavaScript and Node.js.
|
|
It features a flexible expression parser and offers an integrated solution
|
|
to work with real and complex numbers, units, and matrices.
|
|
Powerful and easy to use.
|
|
|
|
|
|
## Features
|
|
|
|
- Supports numbers, complex numbers, units, strings, arrays, and matrices.
|
|
- Is compatible with JavaScript's built-in Math library.
|
|
- Contains a flexible expression parser.
|
|
- Supports chained operations.
|
|
- Comes with a large set of built-in functions and constants.
|
|
- Has no dependencies. Runs on any JavaScript engine.
|
|
- Can be used as a command line application as well.
|
|
- Is easily extensible.
|
|
|
|
|
|
## Usage
|
|
|
|
Math.js can be installed using npm or bower, or by [downloading](http://mathjs.org/#install_or_download) the library.
|
|
The library can be used in both node.js and in the browser.
|
|
See the [Getting Started](https://github.com/josdejong/mathjs/blob/master/docs/getting_started.md) for a more detailed tutorial. To install math.js using npm:
|
|
|
|
npm install mathjs
|
|
|
|
Math.js can be used similar to JavaScript's built-in Math library. Besides that,
|
|
math.js can evaluate
|
|
[expressions](https://github.com/josdejong/mathjs/blob/master/docs/expressions.md)
|
|
and supports
|
|
[chained operations](https://github.com/josdejong/mathjs/blob/master/docs/chained_operations.md).
|
|
|
|
```js
|
|
// create an instance of math.js
|
|
var math = require('mathjs')();
|
|
|
|
// functions and constants
|
|
math.round(math.e, 3); // 2.718
|
|
math.atan2(3, -3) / math.pi; // 0.75
|
|
math.log(1000, 10); // 3
|
|
math.sqrt(-4); // 2i
|
|
math.pow([[-1, 2], [3, 1]], 2); // [[7, 0], [0, 7]]
|
|
|
|
// expressions
|
|
math.eval('12 / (2.3 + 0.7)'); // 4
|
|
math.eval('5.08 cm in inch'); // 2 inch
|
|
math.eval('sin(45 deg) ^ 2'); // 0.5
|
|
math.eval('9 / 3 + 2i'); // 3 + 2i
|
|
math.eval('det([-1, 2; 3, 1])'); // -7
|
|
|
|
// chained operations
|
|
math.select(3)
|
|
.add(4)
|
|
.multiply(2)
|
|
.done(); // 14
|
|
```
|
|
|
|
|
|
## Documentation
|
|
|
|
- [Getting Started](https://github.com/josdejong/mathjs/blob/master/docs/getting_started.md)
|
|
- [Examples](https://github.com/josdejong/mathjs/tree/master/examples/)
|
|
- [Documentation](https://github.com/josdejong/mathjs/blob/master/docs/index.md)
|
|
- [History](https://github.com/josdejong/mathjs/blob/master/HISTORY.md)
|
|
|
|
|
|
## Build
|
|
|
|
First clone the project from github:
|
|
|
|
git clone git://github.com/josdejong/mathjs.git
|
|
|
|
The project uses [jake](https://github.com/mde/jake) as build tool.
|
|
To be able to run jake from the command line, jake must be installed globally:
|
|
|
|
sudo npm install -g jake
|
|
|
|
Then, the project can be build by executing jake in the root of the project:
|
|
|
|
cd mathjs
|
|
jake
|
|
|
|
This will build the library math.js and math.min.js from the source files and
|
|
put them in the folder dist.
|
|
|
|
|
|
## Test
|
|
|
|
To execute tests for the library, run:
|
|
|
|
npm test
|
|
|
|
|
|
## License
|
|
|
|
Copyright (C) 2013 Jos de Jong <wjosdejong@gmail.com>
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License. |