Skip to content

Commit

Permalink
fix expected Aspen-8 compiler ISA; fix bug in json-equality compariso…
Browse files Browse the repository at this point in the history 
…n, and improve error output
  • Loading branch information
@BatmanAoD
BatmanAoD committed Dec 28, 2024
1 parent 7a1bac4 commit d7d26e0
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 143 deletions.
93 changes: 44 additions & 49 deletions crates/lib/src/compiler/isa/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ pub enum Error {

#[cfg(test)]
mod describe_compiler_isa {
use std::{convert::TryFrom, fs::read_to_string};
use std::{convert::TryFrom, fs::{self, read_to_string}};

use float_cmp::{approx_eq, F64Margin};
use qcs_api_client_openapi::models::{InstructionSetArchitecture, Node};
Expand All @@ -111,65 +111,61 @@ mod describe_compiler_isa {
/// Compare two JSON values and make sure they are equivalent while allowing for some precision
/// loss in numbers.
///
/// Return Ok if equivalent, or tuple containing the differing elements.
fn json_is_equivalent<'a>(
first: &'a Value,
second: &'a Value,
) -> Result<(), (&'a Value, &'a Value)> {
let equal = match (first, second) {
(Value::Number(first_num), Value::Number(second_num)) => {
if !first_num.is_f64() || !second_num.is_f64() {
first_num == second_num
/// Panics if there is any inequality.
fn assert_json_is_equivalent<'a>(
expected: &'a Value,
actual: &'a Value,
) {
assert_json_is_equivalent_inner(expected, actual, "");
}

fn assert_json_is_equivalent_inner<'a>(
expected: &'a Value,
actual: &'a Value,
path: &str,
) {
match (expected, actual) {
(Value::Number(expected_num), Value::Number(actual_num)) => {
if !expected_num.is_f64() || !actual_num.is_f64() {
assert_eq!(expected_num, actual_num, "path '{}': non-f64 numeric inequality: expected: {}, actual: {}", path, expected_num, actual_num);
} else {
let first_f64 = first_num.as_f64().unwrap();
let second_f64 = second_num.as_f64().unwrap();
approx_eq!(
let expected_f64 = expected_num.as_f64().unwrap();
let actual_f64 = actual_num.as_f64().unwrap();
assert!(approx_eq!(
f64,
first_f64,
second_f64,
expected_f64,
actual_f64,
F64Margin {
ulps: 1,
epsilon: 0.000_000_1
}
)
), "path '{}': numeric inequality out of range: expected: {}, actual: {}", path, expected_f64, actual_f64);
}
}
(Value::Object(first_map), Value::Object(second_map)) => {
let mut found_missing = false;
for (key, first_value) in first_map {
let second_value = second_map.get(key);
if second_value.is_none() {
found_missing = true;
(Value::Object(expected_map), Value::Object(actual_map)) => {

let mut expected_key_missing_from_actual = None;
for (key, expected_value) in expected_map {
let actual_value = actual_map.get(key);
if actual_value.is_none() {
expected_key_missing_from_actual = Some(key);
break;
}
let cmp = json_is_equivalent(first_value, second_value.unwrap());
cmp?;
assert_json_is_equivalent_inner(expected_value, actual_value.unwrap(), &(format!("{}.{}", path, key)));
}
assert!(expected_key_missing_from_actual.is_none(), "path '{}': expected map has key not in actual map: {}", path, expected_key_missing_from_actual.unwrap());
for (key, _) in actual_map {
assert!(expected_map.contains_key(key), "path '{}': actual map has key not in expected map: {}", path, key);
}
!found_missing
}
(Value::Array(first_array), Value::Array(second_array))
if first_array.len() != second_array.len() =>
{
false
}
(Value::Array(first_array), Value::Array(second_array)) => {
let error = first_array.iter().zip(second_array).find(
|(first_value, second_value)| -> bool {
json_is_equivalent(first_value, second_value).is_err()
},
);
if let Some(values) = error {
return Err(values);
(Value::Array(expected_array), Value::Array(actual_array)) => {
assert!(expected_array.len() == actual_array.len(), "expected array has more elements than actual array");
for (index, (expected_value, actual_value)) in expected_array.iter().zip(actual_array).enumerate() {
assert_json_is_equivalent_inner(expected_value, actual_value, &(format!("{}[{}]", path, index)));
}
true
}
(first, second) => first == second,
(expected, actual) => assert_eq!(expected, actual, "path '{}': inequality: expected: {:?}, actual: {:?}", path, expected, actual),
};
if equal {
Ok(())
} else {
Err((first, second))
}
}

#[test]
Expand Down Expand Up @@ -197,8 +193,8 @@ mod describe_compiler_isa {

let serialized =
serde_json::to_value(compiler_isa).expect("Unable to serialize CompilerIsa");
let result = json_is_equivalent(&serialized, &expected);
result.expect("JSON was not equivalent");

assert_json_is_equivalent(&expected, &serialized);
}

#[test]
Expand Down Expand Up @@ -242,7 +238,6 @@ mod describe_compiler_isa {
let serialized_without_dead = serde_json::to_value(compiler_isa_excluding_dead)
.expect("Unable to serialize CompilerIsa");

let result = json_is_equivalent(&serialized, &serialized_without_dead);
result.expect("JSON was not equivalent");
assert_json_is_equivalent(&serialized, &serialized_without_dead);
}
}
95 changes: 1 addition & 94 deletions crates/lib/tests/compiler-isa-Aspen-8.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -186,11 +186,6 @@
],
"id": 1
},
"10": {
"dead": true,
"gates": [],
"id": 10
},
"11": {
"gates": [
{
Expand Down Expand Up @@ -1865,11 +1860,6 @@
],
"id": 30
},
"31": {
"dead": true,
"gates": [],
"id": 31
},
"32": {
"gates": [
{
Expand Down Expand Up @@ -2802,14 +2792,6 @@
}
},
"2Q": {
"0-1": {
"dead": true,
"gates": [],
"ids": [
0,
1
]
},
"0-7": {
"gates": [
{
Expand Down Expand Up @@ -2882,22 +2864,6 @@
2
]
},
"10-11": {
"dead": true,
"gates": [],
"ids": [
10,
11
]
},
"10-17": {
"dead": true,
"gates": [],
"ids": [
10,
17
]
},
"11-12": {
"gates": [
{
Expand Down Expand Up @@ -2994,14 +2960,6 @@
13
]
},
"12-25": {
"dead": true,
"gates": [],
"ids": [
12,
25
]
},
"13-14": {
"gates": [
{
Expand Down Expand Up @@ -3522,25 +3480,6 @@
4
]
},
"30-31": {
"gates": [
{
"arguments": [
"_",
"_"
],
"duration": 200.0,
"fidelity": 0.962505082735891,
"operator": "CZ",
"operator_type": "gate",
"parameters": []
}
],
"ids": [
30,
31
]
},
"30-37": {
"gates": [
{
Expand All @@ -3560,38 +3499,6 @@
37
]
},
"31-32": {
"gates": [
{
"arguments": [
"_",
"_"
],
"duration": 200.0,
"fidelity": 0.984330374008766,
"operator": "CZ",
"operator_type": "gate",
"parameters": []
},
{
"arguments": [
"_",
"_"
],
"duration": 200.0,
"fidelity": 0.970416051000658,
"operator": "XY",
"operator_type": "gate",
"parameters": [
"theta"
]
}
],
"ids": [
31,
32
]
},
"32-33": {
"gates": [
{
Expand Down Expand Up @@ -3849,4 +3756,4 @@
]
}
}
}
}

0 comments on commit d7d26e0

Please sign in to comment.