Skip to main content

omgkit_core/
lib.rs

1//! # omgkit-core
2//!
3//! omgkit 的 L0 层:列式分子批、CSR 图与元素周期表。
4//!
5//! 本 crate 刻意保持**零依赖**,并且不含任何化学语义 —— 没有净化、没有
6//! 芳香性感知、没有价键推断。它只回答"分子的拓扑与原子属性如何存放"这一个问题。
7//! 化学语义在 `omgkit-chem`(L2),解析在 `omgkit-io`(L1)。
8//!
9//! ## 两种表示
10//!
11//! | 类型 | 可变性 | 布局 | 用途 |
12//! |---|---|---|---|
13//! | [`MolBuilder`] | 可变 | AoS,逐分子 | 建图:解析、反应产物构建 |
14//! | [`MolBatch`] | 不可变 | SoA + CSR,跨分子 | 算法、并行、零拷贝导出 |
15//!
16//! 二者经 [`MolBatchBuilder::push`] / [`MolView::to_builder`] 互转,
17//! 往返恒等由测试保证。
18//!
19//! ```
20//! use omgkit_core::{BondOrder, MolBatchBuilder, MolBuilder};
21//!
22//! let mut ethanol = MolBuilder::new();
23//! let c0 = ethanol.add_atom(6);
24//! let c1 = ethanol.add_atom(6);
25//! let o = ethanol.add_atom(8);
26//! ethanol.add_bond(c0, c1, BondOrder::Single).unwrap();
27//! ethanol.add_bond(c1, o, BondOrder::Single).unwrap();
28//!
29//! let mut bb = MolBatchBuilder::new();
30//! bb.push(&ethanol).unwrap();
31//! bb.push(&ethanol).unwrap();
32//! let batch = bb.finish();
33//!
34//! assert_eq!(batch.num_mols(), 2);
35//! assert_eq!(batch.num_atoms(), 6);
36//!
37//! // 列是连续内存,可零拷贝暴露给 numpy / Arrow
38//! assert_eq!(batch.atomic_nums(), &[6, 6, 8, 6, 6, 8]);
39//!
40//! // 单分子是零拷贝视图,下标自动换算为局部
41//! let m = batch.mol(1).unwrap();
42//! assert_eq!(m.num_atoms(), 3);
43//! assert_eq!(m.degree(1), 2);
44//! ```
45
46pub mod batch;
47pub mod builder;
48pub mod element;
49pub mod error;
50pub mod polyhedron;
51pub mod types;
52pub mod valence;
53pub mod view;
54
55mod element_data;
56
57pub use batch::{MolBatch, MolBatchBuilder};
58pub use builder::{AtomData, BondData, BondMut, MolBuilder, Neighbors};
59pub use element::Element;
60pub use error::{Error, Result};
61pub use types::{
62    AtomFlags, BondDirection, BondFlags, BondOrder, BondStereo, ChiralTag, Hybridization,
63};
64pub use view::MolView;