Master:
Dev:
xFunc.Maths:
xFunc.DotnetTool:

xFunc

xFunc is a simple and easy to use application that allows you to build mathematical and logical expressions. It's written on C#. The library includes well-documented code that allows developers to parse strings to expression tree, to analyze (derivate, simplify) expressions by using lexer, parser and etc.

xFunc is a small-sized and portable application that you can use to create complex mathematical expressions which will be automatically computed. It can be used by teachers and students alike.

Features:

• Calculating expressions (supported functions and operations);
• Supporting measures of angles;
• Derivative and simplifying expressions;
• Plotting graphs;
• Truth tables;
• Supported Framework: .NET Standard 2.1+;

Usage

The main class of xFunc library is Processor.

Processor

It allows you to:

Parse:

var processor = new Processor();
var exp = processor.Parse("2 + x"); 

// 'exp' will contain the expression tree for later use
// you can calculate it or process it by analyzers (Differentiator, Simplifier, etc.)

// 'exp' has a parameter
// we should provide a value for varible 'x'
var parameters = new ParameterCollection
{
    { "x", 10 }
};
var result = exp.Execute(parameters);

// result will be equal to 12

Note: The Parse method won't simplify expression automatically, it will return the complete representation of provided string expression.

Solve:

This method parses string expression (like Parse method) and then calculates it (returns object which implements IResult interface).

There is two overloads of this method (common and generic). The common returns just IResult (you can access result by Result property). The generic allows to return specific implementation of IResult (eg. NumberResult).

var processor = new Processor();
processor.Solve<NumberResult>("2 + 2"); // will return 4.0 (double)

// or

processor.Solve("2 + 2").Result; // will return 4.0 (object)

If your expression has any parameter, you need to assign a value to it (otherwise xFunc will throw an exception), because Processor has a build-in collection of parameters and user functions, you don't need to use ExpressionParameters directly:

processor.Solve("x := 10");

// or explicitly throught Parameters property

processor.Parameters.Variables.Add("x", 10);

Note: The Solve method automatically simplifies expression, to control this behavior you can use simplify argument. It's useful for differentiation, because it will eliminate unnecessary expression nodes.

Simplify:

var processor = new Processor();

processor.Solve<ExpressionResult>("simplify(arcsin(sin(x)))");
// or
processor.Simplify("arcsin(sin(x))");
// will return simplified expression = "x"

Detailed simplification rules

Differentiate:

var processor = new Processor();

processor.Solve<ExpressionResult>("deriv(2x)");
// or
processor.Differentiate("2x");
// will return "2"

You can specified variable (default is "x") of differentiation:

var processor = new Processor();
processor.Differentiate("2y", Variable.Y); // will return "2"
processor.Differentiate("2x + sin(y)", new Variable("x")); // will return "2"

Performance

Processor

Version	Method	Mean	Allocated
3.7.3	Parse	166,581.4 ns	63770 B
4.0.0	Parse	24,604.93 ns	4760 B
3.7.3	Solve	232,498.0 ns	96952 B
4.0.0	Solve	39,971.82 ns	10673 B

More details

Bug Tracker

Please, if you have a bug or a feature request, create a new issue. Before creating any issue, please search for existing issues.

License

xFunc is released under MIT License.

Thanks

@RonnyCSHARP

Fluent.Ribbon
Azure Pipelines
Coverlet
ReportGenerator
xUnit
Moq