Skip to content
C# library to evaluate formulas
C# ANTLR PowerShell Shell
Branch: dev
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build Update build dependencies Aug 5, 2019
docs/template/styles Use NUKE Build instead of PowerShell scripts for automation Mar 19, 2018
src/Dangl.Calculator Configure build to produce strongly named assembly +semver: minor Aug 5, 2019
test/Dangl.Calculator.Tests Add feature to support missing multiplication signs Jul 12, 2019
.gitignore Use NUKE Build instead of PowerShell scripts for automation Mar 19, 2018
.nuke Use NUKE Build instead of PowerShell scripts for automation Mar 19, 2018
CHANGELOG.md Configure build to produce strongly named assembly +semver: minor Aug 5, 2019
Dangl.Calculator.sln Update dependencies and configure Linux CI tests Jul 12, 2019
GitVersion.yml Update GitVersion.yml Aug 5, 2019
Jenkinsfile Update dependencies and configure Linux CI tests Jul 12, 2019
LICENCE.md Fix spelling for LICENCE.md filename=) May 19, 2017
NuGet.Config Remove obsolete entries from NuGet.config Mar 8, 2019
README.md Configure build to produce strongly named assembly +semver: minor Aug 5, 2019
app-logo.png Use NUKE Build instead of PowerShell scripts for automation Mar 19, 2018
build.cmd Use NUKE Build instead of PowerShell scripts for automation Mar 19, 2018
build.ps1 Enable xml comment restore in nuke build script Mar 2, 2019
build.sh Enable xml comment restore in nuke build script Mar 2, 2019
docfx.json Update company name in footer in docs Dec 28, 2018
toc.yml Use NUKE Build instead of PowerShell scripts for automation Mar 19, 2018

README.md

Dangl.Calculator

Build Status NuGet MyGet

Built with Nuke

Online Documentation
Changelog

This calculator is using the ANTLR4 C# target to calculate results from formulas that are passed in as string.

Whenever a calculation is performed, a CalculationResult is returned with the following properties:

Property Type
IsValid bool true if the formula could be parsed and calculated, else false
ErrorPosition int Position of the offending symbol in the line, 0 based index, for invalid results, else null
ErrorMessage string ANTLR error message for invalid formulas, else null
Result double NaN for invalid formulas, else the actual result

Installation

Install it via NuGet: Dangl.Calculator

CI builds are available via MyGet.

https://www.myget.org/F/dangl/api/v3/index.json

Compatibility

This project targets netstandard2.0, netstandard1.1 and net45. Due to .Net 4.5.2 being the currently latest supported version by Microsoft and the xUnit test suite, no tests are run for net45 and net451.

Project Configuration

If this project is consumed in a project using the full .Net framework with a newer version of Antlr4.Runtime, the necessary AssemblyBindingRedirects are not automatically generated with the current dotnet CLI tooling. This is scheduled to be fixed with the 2.0 release. In the meantime, the following should be added to the consumers csproj:

<PropertyGroup Condition=" '$(TargetFramework)' == 'net461' ">
  <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
  <GenerateBindingRedirectsOutputType>true</GenerateBindingRedirectsOutputType>
</PropertyGroup>

The Condition=" '$(TargetFramework)' == 'net461' " attribute may be changed as necessary or removed.

Example

using Dangl.Calculator;

public void Example()
{
    var formula = "5+5";
    var calculation = Calculator.Calculate(formula);

    Console.WriteLine(calculation.Result);
    Console.WriteLine(calculation.IsValid);

    // 10.0
    // true
}

Supported functions

Expression
FLOOR expression Round down to zero accuracy
CEIL expression Round up to zero accuracy
ABS expression Absolute value
ROUNDK '(' expression ';' expression ')' Round expr_1 with expr_2 accuracy
ROUND expression Round with zero accuracy
TRUNC expression Trim decimal digits
SIN expression Sinus
COS expression Cosinus
TAN expression Tangens
COT expression Cotangens
SINH expression Sinus Hypererbolicus
COSH expression Cosinus Hyperbolicus
TANH expression Tangens Hyperbolicus
ARCSIN expression Inverse Sinus
ARCCOS expression Inverse Cosinus
ARCTAN expression Inverse Tangens
ARCTAN2 '(' expression ';' expression ')' Atan2
ARCCOT expression Inverse Cotangens
EXP expression e ^ expr
LN expression Logarithm to e
EEX expression 10 ^ expr
LOG expression Logarithm to 10
RAD expression Angle to radians (360° base)
DEG expression Radians to angle (360° base)
SQRT expression Square root
SQR expression Square product
expression op = ('^'|'**') expression expr_1 to the expr_2 th power
expression (MOD | '%' ) expression Modulo
expression DIV expression Whole part of division rest
expression op = ('~'|'//') expression expr_1 nth root of expr_2
expression op = ('*'|'/') expression Multiplication or division
expression op = ('+'|'-') expression Addition or subtraction
NUMBER Single integer or float number
'(' expression ')' Expression within parentheses
PI '()'? Mathematical constant pi = 3,141593
expression E+ expression Exponent, e.g. 10e+43
expression E- expression Inverted Exponent, e.g. 10e-43
EULER Mathematical constant e = 2,718282
'-' expression Unary minus sign (negative numbers)
'+' expression Unary plus sign (positive numbers)
'(' expression ')' expression Expressions without multiplication sign, e.g. 2(3) -> 2*(3)
expression '(' expression ')' Expressions without multiplication sign, e.g. 2(3) -> 2*(3)

expression may be any expression as functions can be nested. Example: DEG(2*PI) or LOG(10^3).

Formulas can be case invariant, e.g. SIN, sin and siN are all considered the same.

An optional equals sign = at the end of the function is allowed.

Comments in Formulas

Comments in Formulas are supported by encapsulating them either in /*...*/, '...' or "..." quote styles. Examples:

4/*Length*/*3/*Width*/ resolves to 12

4'Length'*3'Width' resolves to 12

4"Length"*3"Width" resolves to 12

Assembly Strong Naming & Usage in Signed Applications

This module produces strong named assemblies when compiled. When consumers of this package require strongly named assemblies, for example when they themselves are signed, the outputs should work as-is. The key file to create the strong name is adjacent to the csproj file in the root of the source project. Please note that this does not increase security or provide tamper-proof binaries, as the key is available in the source code per Microsoft guidelines


MIT Licence

You can’t perform that action at this time.