qcs 0.26.2-rc.0

use serde::{Deserialize, Deserializer, Serialize};

pub(crate) fn wildcard(node_id: Option<i64>) -> Operator {
    let arg = node_id.map_or_else(|| Argument::String("_".to_owned()), Argument::Int);
    Operator::Gate {
        operator: "_".to_string(),
        duration: PERFECT_DURATION,
        fidelity: PERFECT_FIDELITY,
        parameters: vec![Parameter::String("_".to_owned())],
        arguments: vec![arg],
    }
}

/// Represents a single operation that can be performed on a Qubit or Edge
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
#[serde(tag = "operator_type")]
#[serde(rename_all = "lowercase")]
pub(crate) enum Operator {
    Gate {
        operator: String,
        #[serde(deserialize_with = "deserialize_duration_null_default")]
        duration: f64,
        #[serde(deserialize_with = "deserialize_fidelity_null_default")]
        fidelity: f64,
        parameters: Vec<Parameter>,
        arguments: Vec<Argument>,
    },
    Measure {
        operator: String,
        #[serde(deserialize_with = "deserialize_duration_null_default")]
        duration: f64,
        #[serde(deserialize_with = "deserialize_fidelity_null_default")]
        fidelity: f64,
        qubit: Qubit,
        target: Option<String>,
    },
}

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
#[serde(untagged)]
pub(crate) enum Qubit {
    Int(i64),
    String(String),
}

/// Swap a ``null`` duration value with [`PERFECT_DURATION`]
fn deserialize_duration_null_default<'de, D>(d: D) -> Result<f64, D::Error>
where
    D: Deserializer<'de>,
{
    Deserialize::deserialize(d).map(|x: Option<_>| x.unwrap_or(PERFECT_DURATION))
}

/// Swap a ``null`` fidelity value with [`PERFECT_FIDELITY`]
fn deserialize_fidelity_null_default<'de, D>(d: D) -> Result<f64, D::Error>
where
    D: Deserializer<'de>,
{
    Deserialize::deserialize(d).map(|x: Option<_>| x.unwrap_or(PERFECT_FIDELITY))
}

#[cfg(test)]
mod describe_operator {
    use serde_json::json;

    use super::{Argument, Operator, Parameter, Qubit, PERFECT_DURATION, PERFECT_FIDELITY};

    /// This test copies some JSON data from the pyQuil ISA integration test to
    /// validate that [`Operator::Gate`] is serialized correctly.
    #[test]
    fn it_serializes_gates_like_pyquil() {
        let gate_op = Operator::Gate {
            arguments: vec![Argument::String("_".to_string())],
            duration: 0.5,
            fidelity: 0.5,
            operator: "RZ".to_string(),
            parameters: vec![Parameter::String("_".to_owned())],
        };
        let expected = serde_json::json!({
            "arguments": ["_"],
            "duration": 0.5,
            "fidelity": 0.5,
            "operator": "RZ",
            "operator_type": "gate",
            "parameters": ["_"]
        });
        let serialized =
            serde_json::to_value(gate_op).expect("Could not serialize Operation::Gate");
        assert_eq!(serialized, expected);
    }

    #[test]
    fn it_deserializes_gates_like_quilc() {
        let expected = Operator::Gate {
            arguments: vec![
                Argument::String("_".to_string()),
                Argument::String("_".to_string()),
            ],
            duration: 0.5,
            fidelity: 0.5,
            operator: "RZ".to_string(),
            parameters: vec![Parameter::String("_".to_owned())],
        };
        let input = json!({
            "arguments": ["_", "_"],
            "duration": 0.5,
            "fidelity": 0.5,
            "operator": "RZ",
            "operator_type": "gate",
            "parameters": ["_"]
        });
        let input = serde_json::to_string(&input).expect("It should serialize to string");
        let actual =
            serde_json::from_str::<Operator>(&input).expect("It should deserialize successfully");
        assert_eq!(actual, expected);
    }

    /// This test copies some JSON data from the pyQuil ISA integration test to validate that
    /// [`Operator::Measure`] is serialized correctly.
    #[test]
    fn it_serializes_measurements_like_pyquil() {
        let measure = Operator::Measure {
            duration: 0.5,
            fidelity: 0.5,
            qubit: Qubit::Int(1),
            operator: "MEASURE".to_string(),
            target: Some("_".to_string()),
        };
        let expected = serde_json::json!({
            "duration": 0.5,
            "fidelity": 0.5,
            "operator": "MEASURE",
            "operator_type": "measure",
            "qubit": 1,
            "target": "_"
        });
        let serialized =
            serde_json::to_value(measure).expect("Could not serialize Operation::Gate");
        assert_eq!(serialized, expected);
    }

    /// This test copies some JSON data from the pyQuil ISA integration test to validate that
    /// [`Operator::Measure`] is serialized correctly.
    #[test]
    fn it_serializes_measurements_with_null_targets_like_pyquil() {
        let measure = Operator::Measure {
            duration: 0.5,
            fidelity: 0.5,
            qubit: Qubit::Int(1),
            operator: "MEASURE".to_string(),
            target: None,
        };
        let expected = serde_json::json!({
            "duration": 0.5,
            "fidelity": 0.5,
            "operator": "MEASURE",
            "operator_type": "measure",
            "qubit": 1,
            "target": null
        });
        let serialized =
            serde_json::to_value(measure).expect("Could not serialize Operation::Gate");
        assert_eq!(serialized, expected);
    }

    #[test]
    fn it_deserializes_null_fidelity_as_perfect_fidelity() {
        let input = json!({
            "duration": null,
            "fidelity": null,
            "operator": "MEASURE",
            "operator_type": "measure",
            "qubit": 1,
            "target": null

        });
        let expected = json!({
            "duration": PERFECT_DURATION,
            "fidelity": PERFECT_FIDELITY,
            "operator": "MEASURE",
            "operator_type": "measure",
            "qubit": 1,
            "target": null

        });
        let gate: Operator = serde_json::from_value(input).expect("Operator should deserialize");
        assert_eq!(
            serde_json::to_value(gate).expect("Can convert Operator to Value"),
            expected
        );
    }
}

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
#[serde(untagged)]
pub(crate) enum Parameter {
    String(String),
    Float(f64),
}

#[cfg(test)]
mod describe_parameters {
    use super::Parameter;

    #[test]
    fn it_serializes_underscore_as_list_of_strings() {
        let p = Parameter::String("_".to_owned());
        let serialized = serde_json::to_value(p).expect("Could not serialize");
        let expected = serde_json::json!("_");
        assert_eq!(expected, serialized);
    }

    #[test]
    fn it_serializes_one_float_as_list_of_numbers() {
        let p = Parameter::Float(1.0);
        let serialized = serde_json::to_value(p).expect("Could not serialize");
        let expected = serde_json::json!(1.0);
        assert_eq!(expected, serialized);
    }
}

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
#[serde(untagged)]
pub(crate) enum Argument {
    Int(i64),
    String(String),
}

#[cfg(test)]
mod describe_arguments {
    use serde_json::json;

    use super::Argument;

    #[test]
    fn it_serializes_underscores_as_list_of_strings() {
        let p = vec![Argument::String("_".to_owned())];
        let serialized = serde_json::to_value(p).expect("Could not serialize");
        let expected = serde_json::json!(["_"]);
        assert_eq!(expected, serialized);
    }

    #[test]
    fn it_serializes_one_int_as_list_of_numbers() {
        let p = vec![Argument::Int(1)];
        let serialized = serde_json::to_value(p).expect("Could not serialize");
        let expected = serde_json::json!([1]);
        assert_eq!(expected, serialized);
    }

    #[test]
    fn it_deserializes_underscore_arguments() {
        let expected = Argument::String("_".to_string());
        let actual =
            serde_json::from_value::<Argument>(json!("_")).expect("Should deserialize from Value");
        assert_eq!(actual, expected);
    }
}

pub(crate) const PERFECT_FIDELITY: f64 = 1.0;
pub(crate) const PERFECT_DURATION: f64 = 1.0 / 100.0;