Exmex

Exmex 是一个可扩展的数学表达式解析器和评估器。易用性、灵活性和高效的评估是其主要设计目标。Exmex 可以解析包含变量和运算符的数学表达式。一方面，它提供了一组用于浮点数值的默认运算符。对于可微分的默认运算符，Exmex 可以计算偏导数。另一方面，用户可以定义自己的运算符并处理不同类型的数据，如浮点数、整数、布尔值或其他实现了 Clone、FromStr、Debug、Default 等类型的自定义数据。

Exmex 的部分功能可通过 Mexpress 从 Python 访问。

安装

在您的项目目录中运行

cargo add exmex

以获取 最新版本。如果您想使用 Exmex 的最新版本，请将以下内容添加到您的 Cargo.toml 文件中：

[dependencies]
# ...
exmex = { git = "https://github.com/bertiqwerty/exmex.git", branch = "main" }

基本用法

要简单地评估一个字符串，可以使用

let result = exmex::eval_str::<f64>("e^(2*π-τ)")?;
assert!((result - 1.0).abs() < 1e-12);

其中 π/PI、τ/TAU 和欧拉数 E/e 可用为常量。要创建一个表示数学函数的变量表达式，可以使用任何不定义运算符或常量的字符串，并且符合 r"[a-zA-Zα-ωΑ-Ω_]+[a-zA-Zα-ωΑ-Ω_0-9]*" 的格式，例如：

use exmex::prelude::*;
let expr = exmex::parse::<f64>("2*x^3-4/y")?;

从 prelude 的通配符导入仅使表达式特质 Express 和其实施 FlatEx（一个扁平的表达式）可访问。要使用变量，您不需要使用上下文或明确告诉解析器变量是什么。要评估函数在 x=2.0 和 y=4.0 的位置，您可以使用

let result = expr.eval(&[2.0, 4.0])?;
assert!((result - 15.0).abs() < 1e-12);

传递给评估的变量的顺序必须与变量名的字母顺序匹配。

除了预定义的浮点运算符外，您还可以实现自定义运算符，并使用其工厂类型作为泛型参数，如下例所示。

use exmex::prelude::*;
use exmex::{BinOp, MakeOperators, Operator};
ops_factory!(
    BitwiseOpsFactory,
    u32,
    Operator::make_bin(
        "|",
        BinOp {
            apply: |a, b| a | b,
            prio: 0,
            is_commutative: true,
        }
    ),
    Operator::make_unary("!", |a| !a)
);
let expr = FlatEx::<_, BitwiseOpsFactory>::parse("!(a|b)")?;
let result = expr.eval(&[0, 1])?;
assert_eq!(result, u32::MAX - 1);

更复杂的数据类型示例

• 作为操作数使用的运算符，用于 2020 年圣诞节的第 19 天 和
• 类型 Val 可以通过启用功能 value 来激活，见下文。

偏导数

为了计算具有浮点数的表达式的偏导数，您可以在通过在 Cargo.toml 中激活 Exmex 功能 partial 后使用方法 partial。

[dependencies]
exmex = { ..., features = ["partial"] }

partial 方法的结果是另一个表达式。

use exmex::prelude::*;
let expr = exmex::parse::<f64>("y*x^2")?;

// d_x
let dexpr_dx = expr.partial(0)?;
assert_eq!(format!("{}", dexpr_dx), "({x}*2.0)*{y}");

// d_xy
let ddexpr_dxy = dexpr_dx.partial(1)?;
assert_eq!(format!("{}", ddexpr_dxy), "{x}*2.0");
let result = ddexpr_dxy.eval(&[2.0, f64::MAX])?;
assert!((result - 4.0).abs() < 1e-12);

// d_xyx
let dddexpr_dxyx = ddexpr_dxy.partial(0)?;
assert_eq!(format!("{}", dddexpr_dxyx), "2.0");
let result = dddexpr_dxyx.eval(&[f64::MAX, f64::MAX])?;
assert!((result - 2.0).abs() < 1e-12);

// all in one
let dddexpr_dxyx_iter = expr.partial_iter([0, 1, 0].iter())?;
assert_eq!(format!("{}", dddexpr_dxyx_iter), "2.0");
let result = dddexpr_dxyx_iter.eval(&[f64::MAX, f64::MAX])?;
assert!((result - 2.0).abs() < 1e-12);

使用功能 value 在一个表达式中混合标量数据类型和浮点向量

激活 Exmex 功能 value 后，可以使用类型为 Val 的表达式，这是从 Evalexpr 包中的 Value 类型中受到启发的。一个 Val 实例可以包含布尔值、整数、浮点数或浮点数向量。这样，就可以在同一个表达式中使用布尔值、整数、浮点数和向量。此外，Exmex 通过 ValOpsFactory 提供了预定义的 Val 运算符集合。请参阅以下 Python 风格的 if-else 运算符的示例。

use exmex::{Express, Val};
let expr = exmex::parse_val::<i32, f64>("0 if b < c else 1.2")?;
let res = expr.eval(&[Val::Float(34.0), Val::Int(21)])?.to_float()?;
assert!((res - 1.2).abs() < 1e-12);

请参阅 Val-docs 以获取包含向量的示例。

如果同时激活了 partial 和 value，则可以计算类型如 FlatExVal<i32, f64> 的表达式的偏导数。目前不支持向量。

use exmex::{Differentiate, Express, Val};
let expr = exmex::parse_val::<i32, f64>("3*x if x > 1 else x^2")?;
let deri = expr.partial(0)?;
let res = deri.eval(&[Val::Float(1.0)])?.to_float()?;
assert!((res - 2.0).abs() < 1e-12);
let res = deri.eval(&[Val::Float(7.0)])?.to_float()?;
assert!((res - 3.0).abs() < 1e-12);

cargo doc --all-features --no-deps

sin:     "sin(x)+sin(y)+sin(z)",
power:   "x^2+y*y+z^z",
nested:  "x*0.02*sin(-(3*(2*sin(x-1/(sin(y*5)+(5.0-1/z))))))",
compile: "x*0.2*5/4+x*2*4*1*1*1*1*1*1*1+7*sin(y)-z/sin(3.0/2/(1-x*4*1*1*1*1))",

cargo bench --all-features --bench benchmark -- --noplot --sample-size 10 --nresamples 10