formula

Formula

使用 Go 实现的数学表达式解析计算引擎库，它小巧，无任何依赖，具有扩展性(比如可以注册自己的函数到引擎中)，比较完整的完成了数学表达式解析执行，包括词法分析、语法分析、构建AST、运行。

能够处理的表达式样例：

• 1+127-21+(3-4)*6/2.5
• (88+(1+8)*6)/2+99
• 123_345_456 * 1.5 - 2 ^ 4
• -4 * 6 + 2e2 - 1.6e-3
• sin(pi/2)+cos(45-45*1)+tan(pi/4)
• 99+abs(-1)-ceil(88.8)+floor(88.8)
• max(min(2^3, 3^2), 10*1.5-7)

Method Support

Usage

e.g. 1 常规用法： 直接调用解析执行函数 :

import "github.com/cbwfree/micro-game/formula"

func main() {
s := "1 + 2 * 6 / 4 + (456 - 8 * 9.2) - (2 + 4 ^ 5)"
// call top level function
r, err := formula.ParseAndExec(s)
if err != nil {
fmt.Println(err)
}
fmt.Printf("%s = %v", s, r)
}

e.g. 2 高级用法： 依次调用函数，手动执行 :

import "github.com/cbwfree/micro-game/formula"

func main() {
s := "1 + 2 * 6 / 4 + (456 - 8 * 9.2) - (2 + 4 ^ 5)"
exec(s)
}

// call engine
// one by one
func exec(exp string) {
// input text -> []token
toks, err := formula.Parse(exp)
if err != nil {
fmt.Println("ERROR: " + err.Error())
return
}
// []token -> AST Tree
ast := formula.NewAST(toks, exp)
if ast.Err != nil {
fmt.Println("ERROR: " + ast.Err.Error())
return
}
// AST builder
ar := ast.ParseExpression()
if ast.Err != nil {
fmt.Println("ERROR: " + ast.Err.Error())
return
}
fmt.Printf("ExprAST: %+v\n", ar)
// AST traversal -> result
r := formula.ExprASTResult(ar)
fmt.Println("progressing ...\t", r)
fmt.Printf("%s = %v\n", exp, r)
}

编译运行，应该可以看到如下输出：

ExprAST: {Op:- Lhs:{Op:+ Lhs:{Op:+ Lhs:{Val:1} Rhs:{Op:/ Lhs:{Op:* Lhs:{Val:2} Rhs:{Val:6}} Rhs:{Val:4}}} Rhs:{Op:- Lhs:{Val:456} Rhs:{Op:* Lhs:{Val:8} Rhs:{Val:9.2}}}} Rhs:{Op:+ Lhs:{Val:2} Rhs:{Op:^ Lhs:{Val:4} Rhs:{Val:5}}}}
progressing ...  -639.6
1+2*6/4+(456-8*9.2)-(2+4^5) = -639.6

TrigonometricMode

三角函数的参数类型默认为弧度RadianMode，e.g. sin(pi/2) = 1.

你可以通过设置 TrigonometricMode 调整参数类型，可选 弧度RadianMode、角度AngleMode，e.g. :

import "github.com/cbwfree/micro-game/formula"

func main() {
s := "1 + sin(90)"
formula.TrigonometricMode = formula.AngleMode
formula.ParseAndExec(s) // will return 2, nil
s = "1 + sin(pi/2)"
formula.TrigonometricMode = formula.RadianMode
formula.ParseAndExec(s) // will return 2, nil
}

Register Function

math-engine 提供了自定义函数注册到引擎的能力。你可以把常用的函数注册到引擎中，然后就能像内置函数一样在输入的数学表达式中使用。

e.g

  // RegFunction is Top level function
  // the same function name only needs to be registered once.
  // double is register function name.
  // 1 is a number of parameter signatures.
  // func(expr ...formula.ExprAST) float64 is your function.
  formula.RegFunction("double", 1, func(expr ...formula.ExprAST) float64 {
    // you can use the index value directly according to the number of parameters
    // without worrying about crossing the boundary.
    // use ExprASTResult to get the result of the ExprAST structure.
    return formula.ExprASTResult(expr[0]) * 2
  })

然后你就可以在输入的表达式中使用这个函数 double:

//exp := "double(6) + 2"
r, err := formula.ParseAndExec("double(6) + 2")
if err != nil {
  panic(err)
}
fmt.Printf("double(6) + 2 = %f\n", r) // will print ： double(6) + 2 = 14.000000

注意事项：

• 注册的函数名只能是英文字母和数字，且必须英文字母开头（区分大小写）;
• 每一个函数名只能且只需注册一次；
• 注册的函数逻辑中如果有 panic ，需要程序自己捕获处理;

TODO

已实现

• 加 +
• 减 -
• 乘 *
• 除 /
• 取余 %
• 整数次方 ^
• 科学计数法 e.g. 1.2e7、 1.2e-7
• 括号 ()
• 混合运算 e.g. 1+2*6/4+(456-8*9.2)-(2+4^5)*2e3+1.2e-2
• 友好的长数字 e.g. 123_456_789
• 三角函数 e.g. sin, cos, tan, cot, sec, csc
• 常量 pi
• 辅助函数 e.g. abs, ceil, floor, sqrt, cbrt, max, min, noerr
• 提供自定义函数注册功能，注册后可以在表达式中使用
• 精确的数据计算
• 友好的错误消息 e.g.

input /> 123+89-0.0.9
ERROR: strconv.ParseFloat: parsing "0.0.9": invalid syntax
want '(' or '0-9' but get '0.0.9'
------------
123+89-0.0.9
       ^
------------