reefer 0.3.0

Optimizing proc-macro for geometric algebra
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

# Quickstart

This five‑minute guide gets you from zero to a working algebra and a compiled expression.

## Installation

Add Reefer to your manifest (not on crates.io yet):

```toml
[dependencies]
reefer = { git = "https://github.com/kgullion/reefer", branch = "main" }
```

> **Heads up:** building the default CAS backend compiles GMP/MPFR through `rug`, which requires the `m4` macro processor to be available during the build. Install it via your system package manager (for example, `sudo apt install m4` on Debian/Ubuntu or `brew install m4` on macOS) before running `cargo build`.

## Example CGA 2D

```rust
#[reefer::algebra(f32, 3, 1)]
mod cga2d {
    basis! { e0 = P0 + N0 }
    basis! { eI = P0 - N0 }
    basis! { e1 = P1 }
    basis! { e2 = P2 }

    #[derive(Debug, Clone, Copy, PartialEq)]
    shape!(Vector { e0, eI, e1, e2 });
}

// Use the generated `expr!` macro to build expressions:
let mv: cga2d::Vector = cga2d::expr!(|| e1 + 2.0 * e2)();

// Methods are available directly on symbolic values:
let norm = cga2d::expr!(|| (e1 + e2).norm_squared())();
let rotor = cga2d::expr!(|| ((-0.5 * (e1 ^ e2)).exp()))();

// Closures can take typed arguments too
let reflect = cga2d::expr!(|v: cga2d::Vector| {
    let r = (-0.5 * (e1 ^ e2)).exp();
    r.sandwich(v)
});
let result = reflect(mv);
```

- Operators: `*` (geometric), `^` (wedge), `|` (inner), `&` (regressive/meet)
- Methods: `.reverse()`, `.dual()`, `.undual()`, `.left_contract(rhs)`, `.right_contract(rhs)`, `.complement()`, `.conjugate()`, `.automorphism()`, `.sandwich(x)`, `.exp()`, `.sqrt()`, `.norm_squared()`, `.scalar()`
- Shapes returned from `expr!` are concrete structs. Inspect the generated module to see fields.

See the “Expressions & Operators” chapter for details.