Math.Gmp.Native/README.md

77 lines
4.1 KiB
Markdown
Raw Normal View History

2017-11-04 16:02:37 +01:00
# Welcome to the C.math.NET Library
The C.math.NET library implements several [C Standard](http://en.cppreference.com/w/c/numeric/math) mathematical
functions that are missing from the .NET framework.
Functions include among others:
[frexp](https://machinecognitis.github.io/C.math.NET/html/b4d6cd51-2441-999a-18c2-8d18dc2a2c3c.htm),
[ilogb](https://machinecognitis.github.io/C.math.NET/html/6c69efac-8d3c-7c31-f0c5-930b73593c0e.htm),
[ldexp](https://machinecognitis.github.io/C.math.NET/html/35eead45-7bb4-88c5-0f75-278b2cbc94a7.htm),
[logb](https://machinecognitis.github.io/C.math.NET/html/5f67d96e-daa3-cd30-9384-1cda9ebf3f8a.htm),
[scalbn](https://machinecognitis.github.io/C.math.NET/html/bedc19b9-8091-4a47-c967-9092577c1dd7.htm),
[copysign](https://machinecognitis.github.io/C.math.NET/html/cd5217b7-7396-95ed-e4b7-0702efbd860d.htm),
[nextafter](https://machinecognitis.github.io/C.math.NET/html/65f00e22-a956-ec37-9e75-4594cb42d6d2.htm),
[isunordered](https://machinecognitis.github.io/C.math.NET/html/e64fb421-ebf8-8796-d5d0-159ce7435c91.htm), and
[fpclassify](https://machinecognitis.github.io/C.math.NET/html/63a4a916-1492-dedf-c8fe-0e01aff401f4.htm).
Both double and single precision functions are implemented.
All functions are static and their names follow the
[C Standard](http://en.cppreference.com/w/c/numeric/math).
All functions have been thoroughly tested using a large set of unit tests that cover all
limit cases to guarantee that all functions behave as specified by the C standard.
### Documentation
- On-line help is available [here](https://machinecognitis.github.io/C.math.NET/).
### NuGet
The C.math.NET library can be installed in your Visual Studio solution or project with this
[NuGet package](https://www.nuget.org/packages/C.math.NET/).
### Latest Build
The build file includes the compiled library and the help file (.chm) ready to be included in your project.
The library targets the .NET Framework 2.0, so it can be used with all newer versions of the .NET Framework.
For other builds, see the [Releases](https://github.com/MachineCognitis/C.math.NET/releases) page.
- [C.math.NET.v1.1.build.zip](https://github.com/MachineCognitis/C.math.NET/releases/download/v1.1/C.math.NET.v1.1.build.zip).
**NOTE**: On some systems, the content of the ZIP file may be blocked. To unblock it, right click on the
ZIP file, select Properties, and click on the Unblock button, if it is present.
### Making a Donation
You can make a donation to support this project by clicking on the PayPal Donate button below.
PayPal guarantees your privacy and security. I will not receive any details about your payment
other than the amount, and your name.
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=WUQ6Q2QC8EVDA"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" alt="PayPal - The safer, easier way to pay online!"></a>
Thanks to those who have made a donation. This is much appreciated!
### Sharing
<div>
<!-- Email -->
<a href="mailto:?Subject=C.math.NET%20Library&amp;Body=I%20saw%20this%20and%20thought%20of%20you!%20https://github.com/MachineCognitis/C.math.NET/" target="_blank">
<img width="35" src="./docs/icons/mail.png" alt="Email" />
</a>
<!-- Facebook -->
<a href="http://www.facebook.com/sharer.php?u=https://github.com/MachineCognitis/C.math.NET/" target="_blank">
<img width="35"src="./docs/icons/facebook.png" alt="Facebook" />
</a>
<!-- Google+ -->
<a href="https://plus.google.com/share?url=https://github.com/MachineCognitis/C.math.NET/" target="_blank">
<img width="35"src="./docs/icons/google.png" alt="Google" />
</a>
<!-- LinkedIn -->
<a href="http://www.linkedin.com/shareArticle?mini=true&amp;url=https://github.com/MachineCognitis/C.math.NET/" target="_blank">
<img width="35"src="./docs/icons/linkedin.png" alt="LinkedIn" />
</a>
<!-- Twitter -->
<a href="https://twitter.com/share?url=https://github.com/MachineCognitis/C.math.NET/" target="_blank">
<img width="35"src="./docs/icons/twitter.png" alt="Twitter" />
</a>
</div>