quantrs2-tytan 0.1.3

High-level quantum annealing interface inspired by Tytan for the QuantRS2 framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

//! Core types for the solution debugger.

use scirs2_core::ndarray::Array2;
use serde::Serialize;
use std::collections::HashMap;

/// Problem information
#[derive(Debug, Clone, Serialize)]
pub struct ProblemInfo {
    /// Problem name
    pub name: String,
    /// Problem type
    pub problem_type: String,
    /// Number of variables
    pub num_variables: usize,
    /// Variable mapping
    pub var_map: HashMap<String, usize>,
    /// Reverse variable mapping
    pub reverse_var_map: HashMap<usize, String>,
    /// QUBO matrix
    pub qubo: Array2<f64>,
    /// Constraints
    pub constraints: Vec<ConstraintInfo>,
    /// Known optimal solution (if available)
    pub optimal_solution: Option<Solution>,
    /// Additional metadata
    pub metadata: HashMap<String, String>,
}

#[derive(Debug, Clone, serde::Serialize)]
pub struct Solution {
    /// Variable assignments
    pub assignments: HashMap<String, bool>,
    /// Solution energy
    pub energy: f64,
    /// Solution quality metrics
    pub quality_metrics: HashMap<String, f64>,
    /// Solution metadata
    pub metadata: HashMap<String, String>,
    /// Sampling statistics
    pub sampling_stats: Option<SamplingStats>,
}

#[derive(Debug, Clone, Serialize)]
pub struct SamplingStats {
    /// Number of reads
    pub num_reads: usize,
    /// Annealing time
    pub annealing_time: f64,
    /// Chain break fraction
    pub chain_break_fraction: f64,
    /// Sampler used
    pub sampler: String,
}

/// Constraint information
#[derive(Debug, Clone, Serialize)]
pub struct ConstraintInfo {
    /// Constraint name
    pub name: Option<String>,
    /// Constraint type
    pub constraint_type: ConstraintType,
    /// Variables involved
    pub variables: Vec<String>,
    /// Constraint parameters
    pub parameters: HashMap<String, f64>,
    /// Penalty weight
    pub penalty: f64,
    /// Description
    pub description: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
pub enum ConstraintType {
    /// Equality constraint
    Equality { target: f64 },
    /// Inequality constraint
    Inequality {
        bound: f64,
        direction: InequalityDirection,
    },
    /// All different constraint
    AllDifferent,
    /// Exactly one constraint
    ExactlyOne,
    /// At most one constraint
    AtMostOne,
    /// Custom constraint
    Custom { evaluator: String },
}

#[derive(Debug, Clone, Serialize)]
pub enum InequalityDirection {
    LessEqual,
    GreaterEqual,
}