Fluent.Calculations.DotNetGraph 1.1.0-aplha.59

This is a prerelease version of Fluent.Calculations.DotNetGraph.
dotnet add package Fluent.Calculations.DotNetGraph --version 1.1.0-aplha.59                
NuGet\Install-Package Fluent.Calculations.DotNetGraph -Version 1.1.0-aplha.59                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Fluent.Calculations.DotNetGraph" Version="1.1.0-aplha.59" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Fluent.Calculations.DotNetGraph --version 1.1.0-aplha.59                
#r "nuget: Fluent.Calculations.DotNetGraph, 1.1.0-aplha.59"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Fluent.Calculations.DotNetGraph as a Cake Addin
#addin nuget:?package=Fluent.Calculations.DotNetGraph&version=1.1.0-aplha.59&prerelease

// Install Fluent.Calculations.DotNetGraph as a Cake Tool
#tool nuget:?package=Fluent.Calculations.DotNetGraph&version=1.1.0-aplha.59&prerelease                

Logo

Quality gate SonarCloud

Quality Gate Status Maintainability Rating

Nuget Nuget (with prereleases) Nuget GPLv3 License

Fluent Calculations

One of the more powerful ways to make a program readable is to break the calculations up into intermediate values that are held in variables with meaningful names. - Robert C. Martin, Clean Code, A Handbook of Agile Craftsmanship

<div align="justify"> By following this principle together wit Fluent Calculations library we gain an ability to write readable calculations as well as get insights at runtime. </div>

Motivation

<div align="justify"> <p> Having worked on many line of business and some finance applications authors have observed a common difficulty of understating and communicating non-trivial business logic or calculations. </p><p> Validating the correctness of financial calculations, like tax calculations for example, involves a lot of effort on analyst or tester side. For a developer pinpointing problems from just the final result is challenging, thus often we resort to manual debugging. </p><p> TDD falls short of communicating more complex test cases to business people as it relies on quite granular decomposition. Splitting up some algorithms is not always a good option too, due to loss of the original conciseness. Troubleshooting calculations happening in a production environment is impossible without deploying some manual logging that makes code noisy and less readable. </p> <p> This project attempts to provide a clean way to get an <b>"X-ray"</b> of calculations or business logic. </p> </div>

The Goal

Spend minutes of programming to save hours of debugging and testing.

Features

  • Number (Decimal) and Condition (Boolean) datatype are supported,
  • Seamlessly use C# math and logic operators,
  • Build isolated calculation components,
  • Close to no boilerplate code,
  • Serialize calculation tree to JSON,
  • Generate DOT graph output of your calculations,
  • Render graph as an image.

Get Started

Fluent.Calculations can be installed using the Nuget package manager or the dotnet CLI.

dotnet add package Fluent.Calculations.Primitives

Documentation

Usage/Examples

Basic demo calculation:

public class Demo : EvaluationScope<Number>
{
    Number
        A = Number.Of(1),
        B = Number.Of(2),
        C = Number.Of(3);

    Number D => Evaluate(() => A + B);

    Number E => Evaluate(() => D * C);

    public override Number Return() => E;
}

Number result = new Demo().ToResult();

The result value can be :

<img src="../assets/example/fluent-calculations-demo.dot.png" alt="Demo calculation graph rendering" width="280" height="auto">

Challenges

  • Explore ways to introduce concept of units (Meters, Kilograms, etc.).
  • Expand a list of supported operations and math functions.
  • Explore ways to optimize lambda expression compilation.
  • Explore a ways to reuse existing calculations and attempt to benefit from :
    • Cache compiled expressions,
    • Cache evaluation results,
    • Partial execution depending on changed parameters.
  • Explore thread-safety aspects.

License

GNU General Public License v3.0

Authors

🚀 About The Team

We are bunch of .NET practitioners always looking for ways to make code great.

Give it a star ⭐

Loving it? Show your support by giving this project a star!

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Fluent.Calculations.DotNetGraph:

Package Downloads
Fluent.Calculations.Graphviz

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0-aplha.59 57 3/24/2024
1.1.0-aplha.58 46 3/24/2024
1.1.0-aplha.57 44 3/24/2024
1.1.0-aplha.56 48 3/24/2024
1.1.0-aplha.55 49 3/23/2024
1.1.0-aplha.54 48 3/23/2024
1.1.0-aplha.53 47 3/23/2024
1.1.0-aplha.52 45 3/21/2024
1.1.0-aplha.51 55 2/24/2024
1.1.0-aplha.50 52 2/22/2024
1.1.0-aplha.49 97 1/11/2024
1.1.0-aplha.48 90 12/30/2023
1.1.0-aplha.47 60 12/30/2023
1.1.0-aplha.46 64 12/30/2023
1.1.0-aplha.45 60 12/30/2023
1.1.0-aplha.44 58 12/30/2023
1.1.0-aplha.43 61 12/30/2023
1.1.0-aplha.42 66 12/30/2023
1.1.0-aplha.41 56 12/30/2023
1.1.0-aplha.40 68 12/28/2023
1.1.0-aplha.39 65 12/21/2023
1.1.0-aplha.38 69 12/18/2023
1.1.0-aplha.37 63 12/17/2023
1.1.0-aplha.36 71 12/5/2023
1.1.0-aplha.35 75 11/27/2023
1.1.0-aplha.34 63 11/22/2023
1.1.0-aplha.33 56 11/19/2023
1.1.0-aplha.32 59 11/16/2023
1.1.0-aplha.31 54 11/15/2023
1.1.0-aplha.30 57 11/13/2023
1.1.0-aplha.29 51 11/11/2023
1.1.0-aplha.28 56 11/10/2023
1.1.0-aplha.27 51 11/10/2023
1.1.0-aplha.26 48 11/10/2023
1.1.0-aplha.25 58 11/9/2023
1.1.0-aplha.24 54 11/9/2023
1.1.0-aplha.23 53 11/9/2023
1.1.0-aplha.22 53 11/9/2023
1.1.0-aplha.21 55 11/9/2023
1.1.0-aplha.20 57 11/9/2023
1.1.0-aplha.19 52 11/9/2023
1.1.0-aplha.18 55 11/9/2023
1.1.0-aplha.17 55 11/9/2023
1.1.0-aplha.16 56 11/8/2023
1.1.0-aplha.15 54 11/8/2023
1.1.0-aplha.14 55 11/8/2023
1.1.0-aplha.13 69 11/3/2023
1.1.0-aplha.12 63 10/31/2023
1.1.0-aplha.11 60 10/30/2023
1.1.0-aplha.10 77 10/25/2023
1.1.0-aplha.9 59 10/23/2023
1.1.0-aplha.8 58 10/19/2023
1.1.0-aplha.7 62 10/16/2023
1.1.0-aplha.6 70 10/9/2023
1.1.0-aplha.5 63 10/8/2023
1.1.0-aplha.4 60 10/8/2023
1.1.0-aplha.3 66 9/24/2023
1.1.0-aplha.2 57 9/22/2023
1.1.0-aplha.1 63 9/19/2023
1.1.0-alpha 76 9/12/2023
1.0.19-alpha.1 69 9/12/2023
1.0.19-alpha 70 9/12/2023
1.0.18-alpha.4 67 9/11/2023
1.0.18-alpha.3 60 9/11/2023
1.0.18-alpha.2 62 9/11/2023
1.0.17-alpha 72 9/10/2023
1.0.16-alpha 91 9/10/2023
0.0.0-alpha.0.31 76 9/11/2023
0.0.0-alpha.0 66 9/11/2023