geospec 0.1.0

A geometry specification library for ECS-style simulations. Provides shape definitions (sphere, box, cylinder, etc.), dimension inference, and JSON serialization for physical objects.
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
71

# geospec

`geospec` is a geometry specification library designed for ECS-style simulations.  
It provides **shape definitions**, **dimension inference**, and **JSON-friendly representations** for physical objects.

---

## Features
- Define common geometric shapes:
  - Sphere (radius, volume, surface area)
  - Box (length × width × height, volume, surface area)
  - Cylinder (radius × height, volume, surface area)
  - Cone (radius × height, volume, surface area)
  - Pyramid (base × height, volume, surface area)
  - Capsule, Torus, Prism, etc. (planned)

- Infer missing properties:
  - Provide just a radius → auto-compute volume and surface area.
  - Provide dimensions → auto-compute derived measures.

- Serialize/deserialize to **JSON** using `serde_json`.

- Optimized for **speed**: most computations run in nanoseconds.

---

## Example

```rust
use geospec::shapes::Sphere;
use geospec::traits::ShapeSpec;

fn main() {
    let sphere = Sphere { radius: 2.0 };
    let json = sphere.as_json();

    println!("Sphere as JSON: {}", json);
    println!("Volume: {}", sphere.volume());
    println!("Surface area: {}", sphere.surface_area());
}
```

Output:
```
Sphere as JSON: {"radius":2.0,"volume":33.510,"surface_area":50.265}
Volume: 33.510
Surface area: 50.265
```

---

## Benchmarks

Run with:

```bash
cargo bench
```

Typical performance (on a mid-range CPU):
- Sphere volume: ~1.4 ns
- Sphere surface area: ~1.1 ns
- Box volume: ~0.46 ns
- Box surface area: ~0.44 ns

---

## License
Dual-licensed under either:
- MIT License
- Apache License 2.0