quantrs2_tytan/
lib.rs

1// Architectural decisions - these are intentional design patterns
2#![allow(clippy::unnecessary_wraps)] // Result return types for API consistency
3#![allow(clippy::unused_self)] // Trait implementations require &self
4#![allow(clippy::unused_async)]
5// Async placeholders for future implementation
6// Performance-related (not safety issues, can be optimized later)
7#![allow(clippy::significant_drop_tightening)] // Lock scope optimization TODO
8// Style-related (low priority)
9#![allow(clippy::match_same_arms)] // Sometimes intentional for clarity
10#![allow(clippy::option_if_let_else)] // Style preference
11#![allow(clippy::return_self_not_must_use)] // Builder pattern
12#![allow(clippy::needless_range_loop)] // Sometimes clearer with index
13// Additional suppressions for remaining warnings
14#![allow(clippy::branches_sharing_code)] // Sometimes intentional
15#![allow(clippy::type_complexity)] // Quantum types are complex
16#![allow(clippy::missing_const_for_fn)] // Not always beneficial
17#![allow(clippy::format_push_string)] // Performance optimization TODO
18#![allow(clippy::cast_possible_truncation)] // Platform-specific, validated
19#![allow(clippy::future_not_send)] // Async architecture decision
20#![allow(clippy::needless_pass_by_ref_mut)] // API consistency
21#![allow(clippy::cast_precision_loss)] // Acceptable for quantum simulation
22#![allow(clippy::uninlined_format_args)] // Style preference
23#![allow(clippy::assigning_clones)] // Sometimes clearer
24#![allow(clippy::zero_sized_map_values)] // Intentional for set-like maps
25#![allow(clippy::used_underscore_binding)] // Sometimes needed for unused captures
26#![allow(clippy::collection_is_never_read)] // Builder pattern / lazy evaluation
27#![allow(clippy::wildcard_in_or_patterns)] // Sometimes intentional
28#![allow(clippy::ptr_arg)] // API consistency with slices
29#![allow(clippy::implicit_hasher)] // Generic hasher not always needed
30#![allow(clippy::ref_option)] // Sometimes needed for lifetime reasons
31#![allow(clippy::expect_fun_call)] // Clearer error messages
32#![allow(clippy::if_not_else)] // Sometimes clearer
33#![allow(clippy::iter_on_single_items)] // Sometimes intentional
34#![allow(clippy::trivially_copy_pass_by_ref)] // API consistency
35#![allow(clippy::empty_line_after_doc_comments)] // Formatting preference
36#![allow(clippy::manual_let_else)] // Style preference
37#![allow(clippy::await_holding_lock)] // Async architecture
38// Full clippy category suppressions
39#![allow(clippy::pedantic)]
40#![allow(clippy::nursery)]
41#![allow(clippy::cargo)]
42// Additional specific suppressions
43#![allow(clippy::large_enum_variant)]
44#![allow(clippy::borrowed_box)]
45#![allow(clippy::manual_map)]
46#![allow(clippy::non_send_fields_in_send_ty)]
47#![allow(clippy::if_same_then_else)]
48#![allow(clippy::manual_clamp)]
49#![allow(clippy::double_must_use)]
50#![allow(clippy::only_used_in_recursion)]
51#![allow(clippy::same_item_push)]
52#![allow(clippy::format_in_format_args)]
53#![allow(clippy::implied_bounds_in_impls)]
54#![allow(clippy::explicit_counter_loop)]
55#![allow(clippy::duplicated_attributes)]
56#![allow(clippy::new_ret_no_self)]
57#![allow(clippy::must_use_unit)]
58#![allow(clippy::redundant_pattern_matching)]
59#![allow(clippy::redundant_guards)]
60#![allow(clippy::wrong_self_convention)]
61#![allow(clippy::iter_next_slice)]
62#![allow(clippy::create_dir)]
63#![allow(clippy::enum_variant_names)]
64// Additional specific suppressions (correct lint names)
65#![allow(clippy::should_implement_trait)] // Methods like default(), from_str(), next()
66#![allow(clippy::upper_case_acronyms)] // VQE, QAOA, QFT, CNOT, SGD
67#![allow(clippy::unnecessary_map_or)] // map_or simplification suggestions
68#![allow(clippy::derivable_impls)] // Impl can be derived
69#![allow(clippy::or_fun_call)] // unwrap_or_else with default value
70#![allow(clippy::cloned_ref_to_slice_refs)] // clone can be replaced with from_ref
71#![allow(clippy::collapsible_match)]
72#![allow(clippy::len_without_is_empty)]
73#![allow(clippy::arc_with_non_send_sync)]
74#![allow(clippy::std_instead_of_core)] // Allow std usage
75#![allow(clippy::match_like_matches_macro)] // Sometimes match is clearer
76#![allow(clippy::suspicious_open_options)] // File open options
77#![allow(clippy::new_without_default)] // new() without Default impl
78
79//! High-level quantum annealing interface inspired by Tytan for the QuantRS2 framework.
80//!
81//! This crate provides a high-level interface for formulating and solving
82//! quantum annealing problems, with support for multiple backend solvers.
83//! It is inspired by the Python [Tytan](https://github.com/tytansdk/tytan) library.
84//!
85//! # Features
86//!
87//! - **Symbolic Problem Construction**: Define QUBO problems using symbolic expressions
88//! - **Higher-Order Binary Optimization (HOBO)**: Support for terms beyond quadratic
89//! - **Multiple Samplers**: Choose from various solvers
90//! - **Auto Result Processing**: Automatically convert solutions to multi-dimensional arrays
91//!
92//! ## Recent Updates (v0.2.0)
93//!
94//! - Refined SciRS2 v0.5.0 Stable Release integration for enhanced performance
95//! - High-performance sparse matrix operations via SciRS2
96//! - Parallel optimization using `scirs2_core::parallel_ops`
97//! - SIMD-accelerated energy calculations
98//!
99//! # Example
100//!
101//! Example with the `dwave` feature enabled:
102//!
103//! ```rust,no_run
104//! # #[cfg(feature = "dwave")]
105//! # fn dwave_example() {
106//! use quantrs2_tytan::sampler::{SASampler, Sampler};
107//! use quantrs2_tytan::symbol::symbols;
108//! use quantrs2_tytan::compile::Compile;
109//! use quantrs2_tytan::auto_array::AutoArray;
110//!
111//! // Define variables
112//! let x = symbols("x");
113//! let y = symbols("y");
114//! let z = symbols("z");
115//!
116//! // Define expression (3 variables, want exactly 2 to be 1)
117//! let two: quantrs2_symengine_pure::Expression = 2.into();
118//! let h = (x + y + z - two.clone()).pow(&two);
119//!
120//! // Compile to QUBO
121//! let (qubo, offset) = Compile::new(h).get_qubo().expect("Failed to compile QUBO");
122//!
123//! // Choose a sampler
124//! let solver = SASampler::new(None);
125//!
126//! // Sample
127//! let mut result = solver.run_qubo(&qubo, 100).expect("Failed to run QUBO sampler");
128//!
129//! // Display results
130//! for r in &result {
131//!     println!("{:?}", r);
132//! }
133//! # }
134//! ```
135//!
136//! Basic example without the `dwave` feature (no symbolic math):
137//!
138//! ```rust
139//! use quantrs2_tytan::sampler::{SASampler, Sampler};
140//! use std::collections::HashMap;
141//! use scirs2_core::ndarray::Array;
142//!
143//! // Create a simple QUBO matrix manually (minimise x XOR y)
144//! let mut matrix = Array::<f64, _>::zeros((2, 2));
145//! matrix[[0, 0]] = -1.0;  // Linear term for x
146//! matrix[[1, 1]] = -1.0;  // Linear term for y
147//! matrix[[0, 1]] = 2.0;   // Quadratic coupling x*y
148//!
149//! // Create variable map
150//! let mut var_map = HashMap::new();
151//! var_map.insert("x".to_string(), 0);
152//! var_map.insert("y".to_string(), 1);
153//!
154//! // Choose a sampler
155//! let solver = SASampler::new(Some(42));
156//!
157//! // Sample using the QUBO interface
158//! let result = solver.run_qubo(&(matrix, var_map), 10).expect("Failed to run QUBO sampler");
159//! assert!(!result.is_empty());
160//! ```
161
162// Export modules
163pub mod adaptive_noise_calibration;
164pub mod adaptive_optimization;
165pub mod advanced_error_mitigation;
166pub mod advanced_performance_analysis;
167pub mod advanced_problem_decomposition;
168pub mod advanced_visualization;
169pub mod ai_assisted_optimization;
170pub mod analysis;
171pub mod applications;
172pub mod auto_array;
173pub mod benchmark;
174pub mod coherent_ising_machine;
175pub mod compile;
176pub mod constraints;
177pub mod encoding;
178pub mod gpu;
179pub mod gpu_benchmark;
180pub mod gpu_kernels;
181pub mod gpu_memory_pool;
182pub mod gpu_performance;
183pub mod gpu_samplers;
184pub mod grover_amplitude_amplification;
185pub mod hybrid_algorithms;
186pub mod ml_guided_sampling;
187pub mod multi_objective_optimization;
188pub mod optimization;
189pub mod optimize;
190pub mod parallel_tempering;
191pub mod parallel_tempering_advanced;
192pub mod performance_optimization;
193pub mod performance_profiler;
194pub mod problem_decomposition;
195pub mod problem_dsl;
196pub mod quantum_adiabatic_path_optimization;
197pub mod quantum_advantage_analysis;
198pub mod quantum_advantage_prediction;
199pub mod quantum_annealing;
200pub mod quantum_circuit_annealing_compiler;
201pub mod quantum_classical_hybrid;
202pub mod quantum_error_correction;
203pub mod quantum_inspired_ml;
204pub mod quantum_ml_integration;
205pub mod quantum_neural_networks;
206pub mod quantum_optimization_extensions;
207pub mod quantum_state_tomography;
208pub mod realtime_performance_dashboard;
209pub mod realtime_quantum_integration;
210pub mod sampler;
211pub mod sampler_framework;
212pub mod scirs_stub;
213pub mod sensitivity_analysis;
214pub mod solution_clustering;
215pub mod solution_debugger;
216pub mod solution_statistics;
217pub mod symbol;
218pub mod tensor_network_sampler;
219pub mod testing_framework;
220pub mod topological_optimization;
221pub mod variable_correlation;
222pub mod variational_quantum_factoring;
223pub mod visual_problem_builder;
224pub mod visualization;
225
226// Re-export key types for convenience
227pub use advanced_error_mitigation::{
228    create_advanced_error_mitigation_manager, create_lightweight_error_mitigation_manager,
229    AdvancedErrorMitigationManager, ErrorMitigationConfig,
230};
231pub use advanced_performance_analysis::{
232    create_comprehensive_analyzer, create_lightweight_analyzer, AdvancedPerformanceAnalyzer,
233    AnalysisConfig,
234};
235pub use advanced_visualization::{
236    create_advanced_visualization_manager, create_lightweight_visualization_manager,
237    AdvancedVisualizationManager, VisualizationConfig,
238};
239pub use analysis::{calculate_diversity, cluster_solutions, visualize_energy_distribution};
240#[cfg(feature = "dwave")]
241pub use auto_array::AutoArray;
242#[cfg(feature = "dwave")]
243pub use compile::{Compile, PieckCompile};
244#[cfg(feature = "gpu")]
245pub use gpu::{gpu_solve_hobo, gpu_solve_qubo, is_available as is_gpu_available_internal};
246pub use grover_amplitude_amplification::{
247    GroverAmplificationConfig, GroverAmplifiedSampler, GroverAmplifiedSolver,
248};
249pub use optimize::{calculate_energy, optimize_hobo, optimize_qubo};
250pub use quantum_adiabatic_path_optimization::{
251    AdiabaticPathConfig, PathInterpolation, QuantumAdiabaticPathOptimizer, QuantumAdiabaticSampler,
252};
253pub use sampler::{
254    ArminSampler, DWaveSampler, GASampler, MIKASAmpler, PopulationAnnealingSampler, SASampler,
255    SBSampler, SBVariant, TabuSampler,
256};
257pub use scirs_stub::SCIRS2_AVAILABLE;
258#[cfg(feature = "dwave")]
259pub use symbol::{symbols, symbols_define, symbols_list, symbols_nbit};
260pub use tensor_network_sampler::{
261    create_mera_sampler, create_mps_sampler, create_peps_sampler, TensorNetworkSampler,
262};
263pub use visual_problem_builder::{
264    BuilderConfig, ConstraintType, ExportFormat, ObjectiveExpression, VariableType, VisualProblem,
265    VisualProblemBuilder,
266};
267
268// Expose QuantRS2-anneal types as well for advanced usage
269pub use quantrs2_anneal::{IsingError, IsingModel, IsingResult, QuboModel};
270pub use quantrs2_anneal::{QuboBuilder, QuboError, QuboFormulation, QuboResult};
271
272/// Check if the module is available
273///
274/// This function always returns `true` since the module
275/// is available if you can import it.
276#[must_use]
277pub const fn is_available() -> bool {
278    true
279}
280
281/// Check if GPU acceleration is available
282///
283/// This function checks if GPU acceleration is available and enabled.
284#[cfg(feature = "gpu")]
285pub fn is_gpu_available() -> bool {
286    // When gpu feature is enabled, ocl dependency is available
287    // Try to get the first platform and device
288    match ocl::Platform::list().first() {
289        Some(platform) => !ocl::Device::list_all(platform)
290            .unwrap_or_default()
291            .is_empty(),
292        None => false,
293    }
294}
295
296#[cfg(not(feature = "gpu"))]
297#[must_use]
298pub const fn is_gpu_available() -> bool {
299    false
300}
301
302/// Print version information
303#[must_use]
304pub const fn version() -> &'static str {
305    env!("CARGO_PKG_VERSION")
306}
quantrs2_tytan/lib.rs

quantrs2_tytan/
lib.rs
