Skip to content

Commit

Permalink
chore: add a release note to the changelog (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
imrn99 authored Oct 22, 2024
1 parent 4500887 commit b9e738e
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,29 @@

Integraal aims to provide generic and efficient tools for numerical integration in the Rust Programming Language.

---
---

## To be released
## 0.1.0

Integraal's first (real) release is here!

The crate features a main structure, `Integraal`, that acts as the entrypoint for your numerical integration.
You can specify the domain and the function of the integral, as well as the numerical integration method using
methods of the structure. It follows a builder-like pattern.

Domains and functions are described using struct enums for the sake of flexibility. The repository contains
usage examples for both analytical expression and sampled values integration. The following numerical
integration methods are implemented:

- Riemann summation (both left rule and right rule)
- Trapezoid rule
- Simpson's rule (different variants depending on the domain & function)
- Boole's rule
- Romberg's rule
- Monte Carlo method

Different methods have different requirements and dependencies. All of this is detailed in the documentation.

In the future, the computation kernel may support different execution backends. This would align with the initial
motivation behind this crate, that is being an experiment over flexible API designs for HPC.

A feature list will be written for the first non-alpha release (i.e. `0.1.0`)

0 comments on commit b9e738e

Please sign in to comment.