ruvector_robotics/lib.rs
1//! # ruvector-robotics
2//!
3//! Unified cognitive robotics platform built on ruvector's vector database,
4//! graph neural networks, and self-learning infrastructure.
5//!
6//! ## Modules
7//!
8//! - [`bridge`]: Core robotics types, converters, spatial indexing, and perception pipeline
9//! - [`perception`]: Scene graph construction, obstacle detection, trajectory prediction
10//! - [`cognitive`]: Cognitive architecture with behavior trees, memory, skills, and swarm intelligence
11//! - [`mcp`]: Model Context Protocol tool registrations for agentic robotics
12//!
13//! ## Quick Start
14//!
15//! ```rust
16//! use ruvector_robotics::bridge::{Point3D, PointCloud, SpatialIndex};
17//!
18//! // Create a point cloud from sensor data
19//! let cloud = PointCloud::new(
20//! vec![Point3D::new(1.0, 2.0, 3.0), Point3D::new(4.0, 5.0, 6.0)],
21//! 1000,
22//! );
23//!
24//! // Index and search
25//! let mut index = SpatialIndex::new(3);
26//! index.insert_point_cloud(&cloud);
27//! let nearest = index.search_nearest(&[2.0, 3.0, 4.0], 1).unwrap();
28//! assert_eq!(nearest.len(), 1);
29//! ```
30
31pub mod bridge;
32pub mod cognitive;
33pub mod mcp;
34pub mod perception;
35pub mod planning;
36
37/// Cross-domain transfer learning integration with `ruvector-domain-expansion`.
38///
39/// Requires the `domain-expansion` feature flag.
40#[cfg(feature = "domain-expansion")]
41pub mod domain_expansion;
42
43/// RVF packaging for robotics data.
44///
45/// Bridges point clouds, scene graphs, trajectories, Gaussian splats, and
46/// obstacles into the RuVector Format (`.rvf`) for persistence and similarity
47/// search. Requires the `rvf` feature flag.
48#[cfg(feature = "rvf")]
49pub mod rvf;
50
51// Convenience re-exports of the most commonly used types.
52pub use bridge::{
53 BridgeConfig, DistanceMetric, OccupancyGrid, Obstacle as BridgeObstacle, Point3D, PointCloud,
54 Pose, Quaternion, RobotState, SceneEdge, SceneGraph, SceneObject, SensorFrame, SpatialIndex,
55 Trajectory,
56};
57pub use cognitive::{BehaviorNode, BehaviorStatus, BehaviorTree, CognitiveCore, CognitiveState};
58pub use perception::{
59 ObstacleDetector, PerceptionConfig, PerceptionPipeline, SceneGraphBuilder,
60};
61pub use planning::{GridPath, VelocityCommand};