AngouriMath

[!WARNING] AngouriMath is deprecated. You can still use it, but it's unlikely it will go forward. Full story at wbg.gg

<p align="center"> <a href="https://github.com/asc-community/AngouriMath"> <img src="./.github/additional/readme/icon_white.png" alt="AngouriMath logo" width="200" height="200"> </a> </p> <h2 align="center">AngouriMath</h2> <p align="center"> <i>New open-source cross-platform symbolic algebra library for </i><b>C# · F# · Jupyter · C++ (WIP)</b> <br> <a href="https://am.angouri.org/quickstart/"><b>Get started</b></a> <b>·</b> <a href="#exam"><b>Examples</b></a> <b>·</b> <a href="#contrib"><b>Contributions</b></a> <b>·</b> <a href="https://am.angouri.org/whatsnew/"><b>What's new</b></a> <b>·</b> <a href="https://am.angouri.org/"><b>Website</b></a> <br> <br> <a href="https://dotnetfiddle.net/u901sI"><img src="https://img.shields.io/static/v1?label=Fiddle&message=Try%21&color=purple&style=flat&logo=.NET&labelColor=646"></a> <a href="https://mybinder.org/v2/gh/asc-community/AngouriMathLab/try"><img src="https://img.shields.io/static/v1?label=Jupyter&message=Try%21&color=purple&style=flat&logo=Jupyter&labelColor=646"></a> <a href="https://matrix.to/#/#angourimath:matrix.org"><img alt="Join Matrix Chat" src="https://img.shields.io/badge/chat%20with%20us-7eb7e2?logo=matrix&style=flat&labelColor=474&logoColor=white&color=252"></a> <a href="https://github.com/quozd/awesome-dotnet"><img src="https://awesome.re/mentioned-badge.svg"></a> </p> <details><summary><strong>Status board</strong></summary>

Builds and tests

	Kernel/C#	F#	Interactive	C++
Build
Test

Note, that all tests and builds are tested for the following three operating systems: Windows, Ubuntu, Mac OS.

Coverage

Kernel/C#	F#	C++
<a href="https://codecov.io/gh/asc-community/AngouriMath"><img src="https://codecov.io/gh/asc-community/AngouriMath/branch/master/graph/badge.svg?token=XaA0JGyNrS"/></a>	???	???

Versions

	Prerelease	Stable	Downloads
Kernel/C#	<a href="https://www.nuget.org/packages/AngouriMath"><img alt="Nuget (with prereleases)" src="https://img.shields.io/nuget/vpre/AngouriMath?color=blue&label=NuGet&logo=nuget&style=flat-square"></a>	<a href="https://www.nuget.org/packages/AngouriMath"><img alt="Nuget" src="https://img.shields.io/nuget/v/AngouriMath?color=blue&label=NuGet&logo=nuget&style=flat-square"></a>	<a href="https://www.nuget.org/packages/AngouriMath"><img alt="Nuget" src="https://img.shields.io/nuget/dt/AngouriMath?color=darkblue&label=Downloads&style=flat-square"></a>
F#	<a href="https://www.nuget.org/packages/AngouriMath.FSharp"><img alt="Nuget (with prereleases)" src="https://img.shields.io/nuget/vpre/AngouriMath.FSharp?color=blue&label=NuGet&logo=nuget&style=flat-square"></a>	<a href="https://www.nuget.org/packages/AngouriMath.FSharp"><img alt="Nuget" src="https://img.shields.io/nuget/v/AngouriMath.FSharp?color=blue&label=NuGet&logo=nuget&style=flat-square"></a>	<a href="https://www.nuget.org/packages/AngouriMath.FSharp"><img alt="Nuget" src="https://img.shields.io/nuget/dt/AngouriMath.FSharp?color=darkblue&label=Downloads&style=flat-square"></a>
Interactive	<a href="https://www.nuget.org/packages/AngouriMath.Interactive"><img alt="Nuget (with prereleases)" src="https://img.shields.io/nuget/vpre/AngouriMath.Interactive?color=blue&label=NuGet&logo=nuget&style=flat-square"></a>	<a href="https://www.nuget.org/packages/AngouriMath.Interactive"><img alt="Nuget" src="https://img.shields.io/nuget/v/AngouriMath.Interactive?color=blue&label=NuGet&logo=nuget&style=flat-square"></a>	<a href="https://www.nuget.org/packages/AngouriMath.Interactive"><img alt="Nuget" src="https://img.shields.io/nuget/dt/AngouriMath.Interactive?color=darkblue&label=Downloads&style=flat-square"></a>
Experimental	<a href="https://www.nuget.org/packages/AngouriMath.Experimental"><img alt="Nuget (with prereleases)" src="https://img.shields.io/nuget/vpre/AngouriMath.Experimental?color=blue&label=NuGet&logo=nuget&style=flat-square"></a>	<a href="https://www.nuget.org/packages/AngouriMath.Experimental"><img alt="Nuget" src="https://img.shields.io/nuget/v/AngouriMath.Experimental?color=blue&label=NuGet&logo=nuget&style=flat-square"></a>	<a href="https://www.nuget.org/packages/AngouriMath.Experimental"><img alt="Nuget" src="https://img.shields.io/nuget/dt/AngouriMath.Experimental?color=darkblue&label=Downloads&style=flat-square"></a>
Terminal	<a href="https://www.nuget.org/packages/AngouriMath.Terminal"><img alt="Nuget (with prereleases)" src="https://img.shields.io/nuget/vpre/AngouriMath.Terminal?color=blue&label=NuGet&logo=nuget&style=flat-square"></a>	<a href="https://www.nuget.org/packages/AngouriMath.Terminal"><img alt="Nuget" src="https://img.shields.io/nuget/v/AngouriMath.Terminal?color=blue&label=NuGet&logo=nuget&style=flat-square"></a>	<a href="https://www.nuget.org/packages/AngouriMath.Terminal"><img alt="Nuget" src="https://img.shields.io/nuget/dt/AngouriMath.Terminal?color=darkblue&label=Downloads&style=flat-square"></a>
C++	<img alt="GitHub release (latest SemVer including pre-releases)" src="https://img.shields.io/github/v/release/asc-community/AngouriMathLab?include_prereleases&label=GH%20Releases">	WIP	WIP

There are also latest-master versions (updated on every push to master) on MyGet:

MyGet	Downloads

Source to install from MyGet:

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

Other info

Website	Stars	License
<a href="https://am.angouri.org"><img alt="Website" src="https://img.shields.io/website?down_message=Down&label=Website&up_message=Up&url=https%3A%2F%2Fam.angouri.org&style=flat-square"></a>	<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/asc-community/AngouriMath?label=Stars&style=flat-square">	<img alt="GitHub" src="https://img.shields.io/github/license/asc-community/AngouriMath?color=dark-green&label=License&style=flat-square">

<a href="CONTRIBUTING.md"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/asc-community/AngouriMath"></a>

If you want, you can add a badge to your repo:

[![Powered by AngouriMath](https://img.shields.io/badge/Powered%20by-AngouriMath-purple?style=flat-square&labelColor=646)](https://am.angouri.org)

</details>

What is it about?

<a href="https://am.angouri.org">AngouriMath</a> is an open source symbolic algebra library. That is, via AngouriMath, you can automatically <a href="https://am.angouri.org/wiki/07.-Solvers.html">solve</a> equations, systems of equations, <a href="https://am.angouri.org/wiki/05.-Differentiation.html">differentiate</a>, <a href="https://am.angouri.org/wiki/01.-Expressions.html">parse</a> from string, <a href="https://am.angouri.org/wiki/09.-Compilation.html">compile expressions</a>, work with <a href="https://am.angouri.org/wiki/10.-Matrices.html">matrices</a>, find limits, convert an expression to LaTeX, and <a href="https://am.angouri.org/wiki/">many other things</a>.

Where can be used?

<a href="#jupyter"><img src="./.github/additional/readme/side.PNG" align="right" width="25%" alt="AngouriMath now supports Jupyter integration"/></a>

The two areas of use:

<hr> <details><summary>🧪<b> Research / Data Science</b> _{[click 🖱️]}</summary>

<a name="research"></a>AngouriMath for research

As F#, great first-functional language, skyrocketing in the area of data analysis and interactive research, AngouriMath offers a few ways to conveniently work with symbolic expressions.

Notebooks

Notebooks provide amazing experience working with function visualization, for functions over one and two variables. With dotnet/interactive, it can be used in Visual Studio Code notebooks as well as Jupyter notebooks. To install the package, simply run this in the notebook:

#r "nuget:AngouriMath.Interactive,*-*"

Terminal

As both a demonstration sample and a convenient tool, this repository includes tool called AngouriMath.Terminal. It is a CLI-based program to interact with AngouriMath (as opposed to API-based interaction, that is, consuming it as a lib).

[ Download ]

Or build from sources:

git clone https://github.com/asc-community/AngouriMath
cd AngouriMath/Sources/Terminal/AngouriMath.Terminal
dotnet run -c release

See the online Jupyter notebook on how to use the F# API of AngouriMath. Note, that the C# API is still available via open AngouriMath command, then you can call the main library's methods.

See its source folder.

More

Read more about using AngouriMath for research on the website.

</details> <hr> <details><summary>💻<b> Software Development</b> _{[click 🖱️]}</summary> <br>

It is installed from nuget for both C# and F# and can be used by Web/Desktop/Mobile development.

Installing the library

1. Install AngouriMath from NuGet.
2. Write the following code:

using AngouriMath; using System;
Entity expr = "x + sin(y)";
Console.WriteLine(expr);

3. Run.

<a href="https://am.angouri.org/quickstart/"><strong>More detailed Quick Start</strong></a>.

If you are new to AM, we suggest you checking out some samples instead of reading boring documentation. If you want to contribute, we would be happy to welcome you in our community.

For any questions, feel free to contact us via <a href="https://discord.gg/YWJEX7a">Discord</a>.

Official website: am.angouri.org.

<a id="exam"></a>

Examples

Expand any section to see. Examples with live shell are on the website.

<details><summary><strong>Computations</strong></summary>

Use as a simple calculator:

Entity expr = "1 + 2 * log(3, 9)";
Console.WriteLine(expr.EvalNumerical());

<img src="https://render.githubusercontent.com/render/math?math=5">

Console.WriteLine("2 / 3 + sqrt(-16)".EvalNumerical());
>>> 2 / 3 + 4i

<img src="https://render.githubusercontent.com/render/math?math=\frac{2}{3} %2B 4i">

Console.WriteLine("(-2) ^ 3".EvalNumerical());

<img src="https://render.githubusercontent.com/render/math?math=-8">

Build expressions with variables and substitute them:

Entity expr = "2x + sin(x) / sin(2 ^ x)";
var subs = expr.Substitute("x",