-
Notifications
You must be signed in to change notification settings - Fork 0
refactor(substrate): graduate 5 modules from hpc/ to crate root (bitwise, heel_f64x8, distance, byte_scan, spatial_hash) #194
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,7 +27,8 @@ pub mod reductions; | |
| pub mod statistics; | ||
| pub mod activations; | ||
| pub mod hdc; | ||
| pub mod bitwise; | ||
| // Bitwise SIMD primitives — graduated to crate root. Back-compat re-export. | ||
| pub use crate::bitwise; | ||
|
Comment on lines
+30
to
+31
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Document the new These public re-exports currently use regular Proposed doc-comment patch-// Bitwise SIMD primitives — graduated to crate root. Back-compat re-export.
+/// Bitwise SIMD primitives — graduated to crate root. Back-compat re-export.
+///
+/// ```rust
+/// use ndarray::hpc::bitwise as _;
+/// ```
pub use crate::bitwise;
@@
-// HEEL F64x8 distance kernels — graduated to crate root. Back-compat re-export.
+/// HEEL F64x8 distance kernels — graduated to crate root. Back-compat re-export.
+///
+/// ```rust
+/// use ndarray::hpc::heel_f64x8 as _;
+/// ```
pub use crate::heel_f64x8;
@@
-// SIMD-accelerated spatial / byte-scan / hash utilities — graduated to crate root.
-// Back-compat re-exports for existing `use ndarray::hpc::{distance,byte_scan,spatial_hash}::*`.
+/// SIMD-accelerated spatial / byte-scan / hash utilities — graduated to crate root.
+/// Back-compat re-exports for existing `use ndarray::hpc::{distance,byte_scan,spatial_hash}::*`.
+///
+/// ```rust
+/// use ndarray::hpc::{byte_scan as _, distance as _, spatial_hash as _};
+/// ```
pub use crate::byte_scan;
pub use crate::distance;
pub use crate::spatial_hash;As per coding guidelines: “All public APIs must include Also applies to: 60-61, 173-177 🤖 Prompt for AI Agents |
||
| pub mod projection; | ||
| pub mod cogrecord; | ||
| pub mod graph; | ||
|
|
@@ -56,8 +57,8 @@ pub mod soa; | |
| pub mod node; | ||
| #[allow(missing_docs)] | ||
| pub mod cascade; | ||
| #[allow(missing_docs)] | ||
| pub mod heel_f64x8; | ||
| // HEEL F64x8 distance kernels — graduated to crate root. Back-compat re-export. | ||
| pub use crate::heel_f64x8; | ||
| // AMX is an x86_64-only ISA (Intel Sapphire Rapids+); both modules use | ||
| // `asm!` with `rcx`/`rax` register names that don't exist on other | ||
| // architectures (rejected at parse time on s390x / aarch64 / wasm32). | ||
|
|
@@ -169,22 +170,21 @@ pub mod parallel_search; | |
| // ZeckF64 progressive edge encoding + batch/top-k | ||
| pub mod zeck; | ||
|
|
||
| // SIMD-accelerated spatial / byte-scan / hash utilities | ||
| pub mod distance; | ||
| pub mod byte_scan; | ||
| pub mod spatial_hash; | ||
|
|
||
| // Variable-width palette index codec (Minecraft-style bit packing) | ||
| #[allow(missing_docs)] | ||
| pub mod palette_codec; | ||
|
|
||
| // SIMD-accelerated HPC modules (block properties, nibble light data, AABB collision) | ||
| #[allow(missing_docs)] | ||
| pub mod property_mask; | ||
| #[allow(missing_docs)] | ||
| pub mod nibble; | ||
| #[allow(missing_docs)] | ||
| pub mod aabb; | ||
| // SIMD-accelerated spatial / byte-scan / hash utilities — graduated to crate root. | ||
| // Back-compat re-exports for existing `use ndarray::hpc::{distance,byte_scan,spatial_hash}::*`. | ||
| pub use crate::byte_scan; | ||
| pub use crate::distance; | ||
| pub use crate::spatial_hash; | ||
|
|
||
| // Variable-width palette index codec — graduated to crate root. | ||
| // Back-compat re-export for existing `use ndarray::hpc::palette_codec::*`. | ||
| pub use crate::palette_codec; | ||
|
|
||
| // SIMD-accelerated HPC modules (block properties, nibble light data, AABB | ||
| // collision) — all three graduated to crate root. Back-compat re-exports. | ||
| pub use crate::aabb; | ||
| pub use crate::nibble; | ||
| pub use crate::property_mask; | ||
|
|
||
| // Holographic phase-space operations (ported from rustynum-holo) | ||
| #[allow(missing_docs)] | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a language tag to the fenced code block.
Line 68 opens a fenced block without a language, which triggers markdownlint MD040. Please annotate it (e.g.,
bash).Suggested patch
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 68-68: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents