Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miroiu/string-math
Evaluates a math expression from a string. Supports variables and custom operators.
https://github.com/miroiu/string-math
boolean-algebra boolean-expression calculator csharp dotnet expression-evaluator expression-parser math math-expression math-operation mathematics string string-calculator string-math
Last synced: 3 months ago
JSON representation
Evaluates a math expression from a string. Supports variables and custom operators.
- Host: GitHub
- URL: https://github.com/miroiu/string-math
- Owner: miroiu
- License: mit
- Created: 2020-01-06T13:22:37.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T07:05:10.000Z (9 months ago)
- Last Synced: 2024-10-11T14:28:45.125Z (3 months ago)
- Topics: boolean-algebra, boolean-expression, calculator, csharp, dotnet, expression-evaluator, expression-parser, math, math-expression, math-operation, mathematics, string, string-calculator, string-math
- Language: C#
- Homepage:
- Size: 224 KB
- Stars: 46
- Watchers: 1
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
> V3 README can be found here:
> **NEW!** Boolean math example: https://github.com/miroiu/string-math/pull/6/files
# String Math [](https://www.nuget.org/packages/StringMath/) [](https://www.nuget.org/packages/StringMath)  
Calculates the value of a math expression from a string returning a double.
Supports variables, user defined operators and expression compilation.
```csharp
double result = "1 * (2 - 3) ^ 2".Eval(); // 1
```
## Variables
```csharp
double result = "{a} + 2 * {b}".Substitute("a", 2).Substitute("b", 3).Result; // 8
```
### Global variables
These variables are inherited and cannot be substituted.
```csharp
MathExpr.AddVariable("PI", 3.1415926535897931);
double result = "1 + {PI}".Eval(); // 4.1415926535897931
```
## Custom operators
### Global operators
These operators are inherited and can be overidden.
```csharp
MathExpr.AddOperator("abs", a => a > 0 ? a : -a);
double result = "abs -5".Eval(); // 5
// Operator precedence (you can specify an int for precedence)
MathExpr.AddOperator("max", (a, b) => a > b ? a : b, Precedence.Power);
double result = new MathExpr("2 * 3 max 4").Result; // 8
```
### Local operators
These are applied only to the target expression.
```csharp
MathExpr expr = "{PI} + 1";
expr.SetOperator("+", (a, b) => Math.Pow(a, b));
double result = expr; // 3.1415926535897931
double result2 = "{PI} + 1".Eval(); // 4.1415926535897931
```
## Advanced
### Extract variables
```csharp
var expr = "{a} + {b} + {PI}".ToMathExpr();
var variables = expr.Variables; // { "a", "b", "PI" }
var localVariables = expr.LocalVariables; // { "a", "b" }
```
### Compilation
```csharp
Func fn = "{a} + 2".ToMathExpr().Compile("a");
double result = fn(5); // 7
```
### Conditional substitution
```csharp
MathExpr expr = "1 / {a}".Substitute("a", 1);
double temp = expr.Result; // 1
if (someCondition) // true
expr.Substitute("a", 2);
double final = expr.Result; // 0.5
```
### Sharing math context
```csharp
MathExpr expr = "{PI} + 1";
expr.SetOperator("+", (a, b) => Math.Pow(a, b));
MathExpr expr2 = "3 + 2".ToMathExpr(expr.Context);
double result = "1 + 2 + 3".Eval(expr.Context);
```
### Custom math context
```csharp
var context = new MathContext(); // new MathContext(MathContext.Default); // to inherit from global
context.RegisterBinary("+", (a, b) => Math.Pow(a, b));
MathExpr expr = new MathExpr("{PI} + 1", context);
MathExpr expr2 = "3 + 2".ToMathExpr(context);
double result = "1 + 2 + 3".Eval(context);
```
## Default operators
### Binary
```csharp
+ (addition)
- (subtraction)
* (multiplication)
/ (division)
% (remainder)
^ (power)
log (logarithm)
max (maximum)
min (minimum)
```
### Unary
```csharp
- (negation)
! (factorial)
sqrt (square root)
sin (sine)
asin (arcsine)
cos (cosine)
acos (arccosine)
tan (tangent)
atan (arctangent)
rad (convert degrees to radians)
deg (convert radians to degrees)
ceil (ceiling)
floor (floor)
round (rounding)
exp (e raised to power)
abs (absolute)
```