Flutter公式解析插件quds_formula_parser的使用

quds_formula_parser是一个强大的Dart包，用于解析、评估和操作各种形式的数学公式。它支持多种数据类型，包括数字、日期和自定义对象，为基于公式的计算提供了灵活的解决方案。

特性

• 公式解析：将数学表达式从中缀转换为后缀表示法。
• 可定制的术语：定义自定义函数、运算符和变量。
• 数据类型支持：处理复杂的类型，如数字、日期、时间跨度和逻辑表达式。
• 可扩展性：易于扩展库以支持自定义术语、类型和函数。

支持的类型

更多详细信息请参考官方文档。

运算符（包内定义）

更多运算符请参阅官方文档。

函数（包内定义）

更多函数请参阅官方文档。

安装

在 pubspec.yaml 文件中添加以下内容：

dependencies:
  quds_formula_parser: ^1.0.0

然后运行：

flutter pub get

使用

基本用法

以下是一个解析并评估简单公式的示例：

import 'package:quds_formula_parser/quds_formula_parser.dart';

dynamic _parseFormulaAndEvaluate(String str) {
  FormulaParser parser = FormulaParser();
  var formula = parser.parse(str);
  var supporter = FormulaInfixToPostfixConvertor(formula: formula);
  var result = supporter.evaluate();

  if (result is ValueWrapper) return result.value;
  return result;
}

void main() {
  print(_parseFormulaAndEvaluate('5 + 9 / 2')); // 输出: 9.5
}

支持并设置变量值

您可以定义自定义变量并在公式中使用它们：

import 'package:quds_formula_parser/quds_formula_parser.dart';

void _evaluatingWithVariables() {
  var provider = FormulaProvider.defaultInstance;
  FormulaParser parser = FormulaParser(provider: provider);
  provider.insertVariable(Variable(symbol: 'x', value: 0));

  String formulaStr = 'power(x,2)';
  var formula = parser.parse(formulaStr);
  var supporter = FormulaInfixToPostfixConvertor(formula: formula);

  for (int i = 0; i < 10; i++) {
    provider.setVariableValue('x', i);
    print(supporter.evaluate());
  }
}

void main() {
  _evaluatingWithVariables();
}

定义并使用自定义函数

您可以定义自定义函数并在公式中使用它们：

import 'package:quds_formula_parser/quds_formula_parser.dart';

void _parseAndEvaluateWithCustomProvider() {
  FormulaProvider provider = FormulaProvider();
  provider.identifiers.addAll([
    BracketIdentifier(),
    NamedValuesIdentifier(provider: provider),
    FunctionIdentifier(functions: [_CustomFunction()])
  ]);

  var parser = FormulaParser(provider: provider);
  provider.insertVariable(Variable(symbol: 'x', value: 0));
  var formula = parser.parse('randomize(x)');

  var supporter = FormulaInfixToPostfixConvertor(formula: formula);

  for (int i = 0; i < 10; i++) {
    provider.setVariableValue('x', i);
    print(supporter.evaluate());
  }
}

class _CustomFunction extends FunctionTerm {
  @override
  String get name => 'randomize';

  @override
  bool checkParameters(List<dynamic> parameters) => parameters.length == 1 && parameters.first is num;

  @override
  dynamic evaluate(List<dynamic> parameters) {
    return parameters.first * Random().nextInt(100);
  }
}

void main() {
  _parseAndEvaluateWithCustomProvider();
}

示例Demo

以下是一个完整的示例，展示了如何使用 quds_formula_parser 解析和评估不同类型的公式：

import 'package:quds_formula_parser/quds_formula_parser.dart';
import 'dart:io';

void main() {
  _evaluateSimpleFormulas();
  _evaluatingWithVariables();
  _parseAndEvaluateWithCustomProvider();
}

void _evaluateSimpleFormulas() {
  print('\nEvaluating simple formulas');
  _parseFormulaAndEvaluate('5 + 9 / 2'); // 9.5
  _parseFormulaAndEvaluate('6 ^ 3'); // 216
  _parseFormulaAndEvaluate('true != false'); // True
}

dynamic _parseFormulaAndEvaluate(String str) {
  FormulaParser parser = FormulaParser();
  var formula = parser.parse(str);
  if (formula.hasParsingError) {
    print('''Error of parsing: $str
Error in position: ${formula.errorParsingPosition},
Error details: ${formula.errorCode?.name}''');
  } else {
    var result = (parser..parse(str)).evaluate();
    print('$str => ${parser.formula!.formulaString}\n  => $result');
  }
}

void _evaluatingWithVariables() {
  print('\nEvaluating formula with changing variable value many times');
  FormulaParser parser = FormulaParser();
  parser.insertVariable(NamedValue(symbol: 'x', value: 0));
  String formulaStr = 'power(x,2)';
  parser.parse(formulaStr);

  Stopwatch stopwatch = Stopwatch();
  stopwatch.start();
  int times = 1000000;
  for (int i = 0; i < times; i++) {
    parser.setVariableValue('x', i);
    parser.evaluate();
  }
  stopwatch.stop();
  print(
      '$formulaStr evaluating times($times) took ${stopwatch.elapsedMilliseconds} ms');
}

void _parseAndEvaluateWithCustomProvider() {
  print('\nParsing with evaluating with custom provider');
  FormulaProvider provider = FormulaProvider();
  provider.identifiers.addAll([
    BracketIdentifier(),
    NamedValuesIdentifier(provider: provider),
  ]);
  provider.registerFunction(
      notations: ['Randomize', 'Custom.Rnd'],
      checkParameters: (params) => params.length == 1 && params.first is num,
      evaluator: (params) {
        return params.first * Random().nextInt(100);
      });

  var parser = FormulaParser(provider: provider);
  provider.setVariableValue('x', 0);
  var formula = parser.parse('randomize(x)');
  var supporter = FormulaInfixToPostfixConvertor(formula: formula);

  for (int i = 0; i < 10; i++) {
    provider.setVariableValue('x', i);
    print(supporter.evaluate());
  }
}