optionstratlib-math 0.22.1

Generic curves, surfaces, interpolation and geometry of OptionStratLib, on Decimal coordinates. Re-exported by the optionstratlib facade under its `math` feature.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# optionstratlib-math

Generic numerical containers and algorithms of
[OptionStratLib](https://github.com/joaquinbejar/OptionStratLib): 2D curves,
3D surfaces, and the construction, interpolation, arithmetic and metric
machinery they share. Nothing here knows about option chains, Greeks, pricing
or plotting; the crate depends only on `optionstratlib-core` and general
numeric crates.

| Module       | Contents                                                                  |
|--------------|---------------------------------------------------------------------------|
| `curves`     | `Curve`, `Point2D`, `Curvable`, `StatisticalCurve`, `CurveSpline`          |
| `surfaces`   | `Surface`, `Point3D`, `Surfacable`                                         |
| `geometrics` | Construction, linear / bilinear / cubic / spline interpolation, arithmetic, metric extraction |
| `error`      | `CurveError`, `SurfaceError`, `InterpolationError`, `MetricsError`         |

Coordinates are `rust_decimal::Decimal`, and arithmetic on them is checked.

## Place in the workspace

- **Depends on** `optionstratlib-core`.
- **Must not depend on** `optionstratlib-pricing`, `-simulation`, `-market`,
  `-analytics`, `-strategies`, `-backtest` and `-visualization`; `make
  check-graph` enforces the layering (ADR-0001 D9).
- **In the facade:** `optionstratlib::{curves, surfaces, geometrics}` and the
  math errors in `optionstratlib::error`, under the facade feature `math`. The
  facade paths are the same types as the paths here; the [ownership
  map](https://github.com/joaquinbejar/OptionStratLib/blob/main/docs/ownership.md)
  lists every one with its feature.

Moving from 0.21? The [0.22 architecture and adoption
guide](https://github.com/joaquinbejar/OptionStratLib/blob/main/docs/migration-0.22.md)
maps each redesign to its replacement workflow; 0.22 keeps no
compatibility with 0.21.

## Minimal example

```rust
use optionstratlib_math::curves::{Curve, Point2D};
use std::collections::BTreeSet;

fn main() {
    let points: BTreeSet<Point2D> = [(0, 0), (1, 2), (2, 4)]
        .into_iter()
        .map(|(x, y)| Point2D::new(x, y))
        .collect();
    let curve = Curve::new(points);
    assert_eq!(curve.points.len(), 3);
}
```

## Runnable example

A runnable program that depends on this crate directly, with the smallest
dependency set and no facade, is [`osl-example-direct-math`](https://github.com/joaquinbejar/OptionStratLib/tree/main/examples/direct/math); `make tree-example-direct-math`
asserts its resolved graph.

## Features

| Feature  | Default | Effect                                                              |
|----------|---------|---------------------------------------------------------------------|
| `schema` | no      | Derives `utoipa::ToSchema` on math types and enables `optionstratlib-core/schema` |

Option-specific projections (`BasicCurves`, `BasicSurfaces`) live in the
analytics layer and plotting in visualization; most users get all of it
through the `optionstratlib` facade.

## License

MIT