magba 0.5.0

Magnetic computation library for Rust
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

/*
 * Magba is licensed under The 3-Clause BSD, see LICENSE.
 * Copyright 2025 Sira Pornsiriprasert <code@psira.me>
 */

//! Data structures for grouping and management of magnetic components.
//!
//! This module provides two primary types of collections for both magnetic sources and sensors: **Arrays** and **Assemblies**.
//!
//! # Arrays vs. Assemblies
//!
//! | Feature | Array (`SourceArray`, `ObserverArray`) | Assembly (`SourceAssembly`, `ObserverAssembly`) |
//! |---------|--------------------------------------|-----------------------------------------------|
//! | **Allocation** | Stack-allocated | Heap-allocated |
//! | **Capacity** | Fixed-size (`const N: usize`) | Dynamically-sized (`Vec`) |
//! | **Components** | Uniform type (unless wrapped in an enum like `Magnet`) | Heterogeneous |
//! | **Nesting** | Not supported | Supported (only for `SourceAssembly`) |
//! | **Custom Types** | Not supported | Supported |
//!
//! # Convenience Macros
//!
//! Instead of manually creating collections, you can use the [`sources!`](crate::sources) and [`observers!`](crate::observers) macros.
//! These macros provide a familiar, `vec!`-like syntax to quickly build up arrays and assemblies.

mod macros;
#[cfg(test)]
pub(crate) use macros::observers;
#[cfg(test)]
pub(crate) use macros::sources;

mod node;
mod observer_array;
mod observer_assembly;
mod observer_component;
mod source_array;
mod source_assembly;
mod source_component;

use node::Node;
pub use observer_array::ObserverArray;
pub use observer_assembly::ObserverAssembly;
pub use observer_component::ObserverComponent;
pub use source_array::SourceArray;
pub use source_assembly::SourceAssembly;
pub use source_component::SourceComponent;

mod utils;