1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104

//! A mathematical expression parsing and evaluation library.
//!
//! # Evaluating an expression with variables
//!
//! `eval` is perfect for cases when you just need to evaluate an expression
//! once, with a given a set of variables.
//!
//! ```
//! #[macro_use] extern crate asciimath;
//! use asciimath::eval;
//!
//! let expression = "(x + y * 4) ^ 3";
//! let variables = scope!{
//!    "x" => 8,
//!    "y" => 12.25
//! };
//!
//! assert_eq!(Ok(185193.0), eval(expression, &variables));
//! ```
//!
//!
//! # Compiling Expressions for Repeated Evaluation
//!
//! The example below demonstrates parsing and evaluation of an expression
//! with two sets of variables.
//!
//! The Scope is passed to the compiler for disambiguation in cases of
//! implicit multiplication and function calls.
//!
//! ```
//! #[macro_use] extern crate asciimath;
//! use asciimath::{compile,Evaluate};
//!
//! let scope_one = scope!{
//!    "x" => 8,
//!    "y" => 12.25
//! };
//! let scope_two = scope!{
//!    "x" => 3,
//!    "y" => 0
//! };
//! let expression = compile("(x + y * 4) ^ 3", &scope_one).unwrap();
//!
//! assert_eq!(Ok(185193.0), expression.eval_with(&scope_one));
//! assert_eq!(Ok(27.0), expression.eval_with(&scope_two));
//! ```
//!
//! # Custom Functions
//!
//! A lot of effort has been put into making custom functions as easy to write
//! as possible.
//!
//! ```
//! #[macro_use] extern crate asciimath;
//! use asciimath::{eval,CustomFn};
//!
//! let my_sum: CustomFn = |args| Ok(args.iter().sum());
//!
//! let scope = scope!{
//!   "x" => 1,
//!   "my_sum" => my_sum,
//! };
//!
//! assert_eq!(Ok(6.0), eval("my_sum(x, 2, 3)",&scope));
//! ```
//!
//! # Builtins
//!
//! Functions:
//! - `cos(x)`
//! - `tan(x)`
//! - `max(a,b,c,...)`
//! - `min(a,b,c,...)`
//! - `abs(x)`
//! - `sqrt(x)`
//! - `cbrt(x)`
//! - `log(base, x)`
//! - `log_10(x)`
//! - `ln(x)`
//! - `floor(x)`
//! - `ceil(x)`
//!
//! Constants:
//! - PI
//! - E (Euler's number)
//! - INFINITY
//! - NEG_INFINITY

#[macro_use]
extern crate lazy_static;

#[macro_use]
mod macros;
mod ast;
mod constants;
mod error;
mod lexer;
mod parser;
mod tokens;

pub use ast::{Evaluate, Scope};
pub use constants::CustomFn;
pub use error::Error;
pub use parser::{compile, eval};