built-in-math-eval

[![Build Status][travis-image]][travis-url]
[![NPM][npm-image]][npm-url]
[![Coverage Status][coveralls-image]][coveralls-url]


> Evaluate mathematical expression with the built-in math object

Table of Contents generated with DocToc

- Description
- Installation
- API
- code = compile(expression)
- [return.eval([scope])](#returnevalscope)
- Examples

Description

This module evaluates the generated code from math-codegen
for the built in Math namespace providing the necessary adapter methods

Installation

``sh
$ npm install --save built-in-math-eval
`

API

`javascript
var compile = require('built-in-math-eval');
`

$3

params
* expression {string} the expression to be parsed

returns {Object}
* return.eval {function} The compiled function to be called with some scope variables

#### return.eval([scope])

params
* scope {Object}

An optional object which holds some variables to be used in the expression,
all variables are casted to Number

returns {*} a number or a boolean value depending on the operation made

Examples

Also have a look at test/index.js

`javascript
var compile = require('built-in-math-eval');

// > 3
compile('1 + 2').eval()

// > 8
compile('2^3').eval()

// > 8
compile('x^3').eval({ x: 2 })

// > 1
compile('cos(x)').eval({ x: 0 })

// > 8
compile('2x^2').eval({ x: 2 })

// > 3.1415
compile('PI').eval()
``

2015 © Mauricio Poppe

[npm-image]: https://img.shields.io/npm/v/built-in-math-eval.svg?style=flat
[npm-url]: https://npmjs.org/package/built-in-math-eval
[travis-image]: https://travis-ci.org/mauriciopoppe/built-in-math-eval.svg?branch=master
[travis-url]: https://travis-ci.org/mauriciopoppe/built-in-math-eval
[coveralls-image]: https://coveralls.io/repos/mauriciopoppe/built-in-math-eval/badge.svg
[coveralls-url]: https://coveralls.io/r/mauriciopoppe/built-in-math-eval