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
97
98
99
100
101
102

use std::{error::Error, fmt::Display, result};

use num::{FromPrimitive, ToPrimitive};
use num_derive::{FromPrimitive, ToPrimitive};

#[derive(Debug, FromPrimitive, ToPrimitive)]
pub enum KetError {
    Success,
    ControlTwice,
    DataNotAvailable,
    DeallocatedQubit,
    FailToParseResult,
    NoAdj,
    NoCtrl,
    NonGateInstruction,
    NotBIN,
    NotJSON,
    NotUnitary,
    PluginOnCtrl,
    TargetOnControl,
    TerminatedBlock,
    UndefinedClassicalOp,
    UndefinedDataType,
    UndefinedGate,
    UnexpectedResultData,
    UnmatchedPid,
    UndefinedError,
}

pub type Result<T> = result::Result<T, KetError>;

impl KetError {
    pub fn to_str(&self) -> &'static str {
        match self {
            KetError::Success => "the call returned successfully",
            KetError::ControlTwice => "cannot set a qubit as a control twice",
            KetError::DeallocatedQubit => "cannot operate with a deallocated qubit",
            KetError::FailToParseResult => "fail to parse serialized result data",
            KetError::NoAdj => "no inverse scope to end",
            KetError::NoCtrl => "no control scope to end",
            KetError::NonGateInstruction => {
                "cannot apply a non-gate instruction within a controlled or inverse scope"
            }
            KetError::NotBIN => "data is not BIN",
            KetError::NotJSON => "data is not JSON",
            KetError::NotUnitary => "the given matrix is not unitary",
            KetError::PluginOnCtrl => "cannot apply plugin within a controlled scope",
            KetError::TargetOnControl => {
                "a qubit cannot be targeted and controlled at the same time"
            }
            KetError::TerminatedBlock => "cannot append statements to a terminated block",
            KetError::UndefinedClassicalOp => "undefined classical operation",
            KetError::UndefinedDataType => "undefined data type",
            KetError::UndefinedGate => "undefined quantum gate",
            KetError::UnexpectedResultData => "result do not have the expected number of values",
            KetError::UnmatchedPid => "unmatched pid",
            KetError::UndefinedError => "undefined error",
            KetError::DataNotAvailable => "data not available",
        }
    }

    pub fn error_code(&self) -> i32 {
        self.to_i32().unwrap()
    }

    pub fn from_error_code(error_code: i32) -> KetError {
        Self::from_i32(error_code).unwrap_or(KetError::UndefinedError)
    }
}

impl Display for KetError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.to_str())
    }
}

impl Error for KetError {}

#[cfg(test)]
mod tests {
    use super::KetError;

    #[test]
    fn success_is_zero() {
        assert!(KetError::Success.error_code() == 0)
    }

    #[test]
    fn print_error_code() {
        let mut error_code = 0;
        loop {
            let error = KetError::from_error_code(error_code);
            println!("#define KET_{:#?} {}", error, error_code);

            if let KetError::UndefinedError = error {
                break;
            } else {
                error_code += 1;
            }
        }
    }
}