advanced_algorithms/
lib.rs

1//! # Advanced Algorithms Library
2//!
3//! A comprehensive Rust library providing high-performance implementations of advanced algorithms
4//! across multiple domains including:
5//!
6//! - **Numerical Analysis & Linear Algebra**: FFT, QR Decomposition, Newton-Raphson, SVD
7//! - **Number Theory & Cryptography**: Miller-Rabin Primality Test, Extended Euclidean Algorithm, Mersenne Twister
8//! - **Optimization & Statistics**: Gradient Descent, Levenberg-Marquardt, Monte Carlo Integration
9//! - **Graph Algorithms**: Dijkstra's, A*, Bellman-Ford, Floyd-Warshall
10//!
11//! ## Features
12//!
13//! - **High Performance**: Optimized implementations with multi-threading support via Rayon
14//! - **Well Documented**: Comprehensive documentation with examples for each algorithm
15//! - **Type Safe**: Leverages Rust's type system for correctness
16//! - **Numerically Stable**: Implementations prioritize numerical stability
17//!
18//! ## Quick Start
19//!
20//! ```rust
21//! use advanced_algorithms::numerical::fft;
22//! use advanced_algorithms::optimization::gradient_descent;
23//! use advanced_algorithms::number_theory::miller_rabin;
24//!
25//! // Fast Fourier Transform
26//! let signal = vec![1.0, 2.0, 3.0, 4.0];
27//! let spectrum = fft::fft(&signal);
28//!
29//! // Check if a number is prime
30//! let is_prime = miller_rabin::is_prime(17, 10);
31//! ```
32
33pub mod numerical;
34pub mod number_theory;
35pub mod optimization;
36pub mod graph;
37
38// Re-export commonly used types
39pub use num_complex::Complex64;
40
41/// Common error type for the library
42#[derive(Debug, Clone)]
43pub enum AlgorithmError {
44    /// Input dimensions are incompatible
45    DimensionMismatch(String),
46    /// Numerical computation failed to converge
47    ConvergenceFailure(String),
48    /// Invalid input parameters
49    InvalidInput(String),
50    /// Algorithm encountered a numerical instability
51    NumericalInstability(String),
52}
53
54impl std::fmt::Display for AlgorithmError {
55    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
56        match self {
57            AlgorithmError::DimensionMismatch(msg) => write!(f, "Dimension mismatch: {}", msg),
58            AlgorithmError::ConvergenceFailure(msg) => write!(f, "Convergence failure: {}", msg),
59            AlgorithmError::InvalidInput(msg) => write!(f, "Invalid input: {}", msg),
60            AlgorithmError::NumericalInstability(msg) => write!(f, "Numerical instability: {}", msg),
61        }
62    }
63}
64
65impl std::error::Error for AlgorithmError {}
66
67/// Result type for algorithm operations
68pub type Result<T> = std::result::Result<T, AlgorithmError>;
advanced_algorithms/lib.rs

advanced_algorithms/
lib.rs
