stim 0.3.0

use std::fmt::{self, Display, Formatter};
use std::str::FromStr;

use crate::{Circuit, GateData, GateTarget, Result, StimError};

/// A single instruction from a stabilizer circuit, such as `H 0 1` or
/// `CNOT rec[-1] 5`.
///
/// This is the Rust equivalent of Python's `stim.CircuitInstruction`. It
/// represents one line of a Stim circuit file — a gate name together with
/// its numeric arguments, an ordered list of [`GateTarget`]s, and an
/// optional string tag for annotation.
///
/// # Components
///
/// | Component | Accessor | Example |
/// |-----------|----------|---------|
/// | Gate name | [`name()`](Self::name) | `"H"`, `"CX"`, `"X_ERROR"`, `"DETECTOR"` |
/// | Gate arguments | [`gate_args_copy()`](Self::gate_args_copy) | `[0.01]` for `DEPOLARIZE1(0.01)` |
/// | Targets | [`targets_copy()`](Self::targets_copy) | qubit indices, `rec[-k]` refs, Pauli targets |
/// | Tag | [`tag()`](Self::tag) | `"100ns"` in `I[100ns] 2` |
///
/// # Gate name canonicalization
///
/// Gate names are canonicalized on construction so that aliases resolve to
/// the standard name used by Stim. For instance, `"cnot"`, `"CNOT"`, and
/// `"ZCX"` all become `"CX"`. This ensures that two `CircuitInstruction`
/// values built from different aliases of the same gate compare equal and
/// hash identically.
///
/// # Measurement counting
///
/// The number of measurement results an instruction produces is computed
/// eagerly during construction and cached. Access it with
/// [`num_measurements()`](Self::num_measurements). Non-measuring gates
/// return `0`; single-qubit measurements like `M` count one per target;
/// two-qubit measurements like `MXX` count one per *pair* of targets; and
/// Pauli-product measurements like `MPP` count one per product group.
///
/// # Display and Debug
///
/// - [`Display`](std::fmt::Display) formats the instruction as a valid
///   Stim circuit file line, e.g. `X_ERROR(0.125) 5 7`.
/// - [`Debug`](std::fmt::Debug) produces the Rust-repr form, e.g.
///   `stim::CircuitInstruction("X_ERROR", [stim::GateTarget::qubit(5, false).unwrap(), stim::GateTarget::qubit(7, false).unwrap()], [0.125])`.
///
/// # Ordering and hashing
///
/// `CircuitInstruction` implements [`Eq`], [`Ord`], and [`Hash`].
/// Ordering is lexicographic by name, then tag, then gate arguments (by
/// bit-pattern), then targets.
///
/// # Examples
///
/// ```
/// use stim::CircuitInstruction;
///
/// let h = CircuitInstruction::new(
///     "H", [0u32, 1u32], std::iter::empty::<f64>(), "",
/// ).expect("H is a valid gate");
/// assert_eq!(h.name(), "H");
/// assert_eq!(h.num_measurements(), 0);
///
/// // Aliases are canonicalized automatically.
/// let cx = CircuitInstruction::new(
///     "cnot", [0u32, 1u32], std::iter::empty::<f64>(), "",
/// ).expect("cnot is an alias for CX");
/// assert_eq!(cx.name(), "CX");
/// ```
///
/// Parsing from Stim program text:
///
/// ```
/// use stim::CircuitInstruction;
///
/// let inst = CircuitInstruction::from_stim_program_text("DEPOLARIZE1(0.25) 5")
///     .expect("valid instruction text");
/// assert_eq!(inst.name(), "DEPOLARIZE1");
/// assert_eq!(inst.gate_args_copy(), vec![0.25]);
/// ```
///
/// Tagged instructions:
///
/// ```
/// use stim::CircuitInstruction;
///
/// let inst = CircuitInstruction::from_stim_program_text("I[100ns] 2")
///     .expect("valid instruction");
/// assert_eq!(inst.tag(), "100ns");
/// assert_eq!(inst.to_string(), "I[100ns] 2");
/// ```
#[derive(Clone, PartialEq)]
pub struct CircuitInstruction {
    name: String,
    tag: String,
    gate_args: Vec<f64>,
    targets: Vec<GateTarget>,
    num_measurements: u64,
}

impl CircuitInstruction {
    /// Creates a new circuit instruction with the given gate name, targets,
    /// gate arguments, and optional tag.
    ///
    /// This is the primary constructor for `CircuitInstruction`. It
    /// corresponds to Python's `stim.CircuitInstruction.__init__`.
    ///
    /// The gate name is canonicalized so that aliases resolve to the standard
    /// name used by Stim (e.g. `"cnot"` becomes `"CX"`, `"ZCX"` becomes
    /// `"CX"`). The number of measurements produced by the instruction is
    /// computed eagerly during construction and cached for later retrieval
    /// via [`num_measurements()`](Self::num_measurements).
    ///
    /// # Arguments
    ///
    /// * `name` — The gate name (e.g. `"H"`, `"CX"`, `"DEPOLARIZE1"`).
    ///   Aliases are accepted and will be resolved to the canonical name.
    /// * `targets` — The qubits, measurement record references, or Pauli
    ///   targets this instruction acts on. Raw `u32` values are interpreted
    ///   as qubit indices; use [`GateTarget`] for richer target types such
    ///   as `rec[-1]` or Pauli `X0`.
    /// * `gate_args` — Numeric parameters for the gate. For noise channels
    ///   these are probabilities (e.g. `[0.01]` for `DEPOLARIZE1`). For
    ///   `OBSERVABLE_INCLUDE` it is the logical observable index. Most
    ///   unitary gates have no arguments.
    /// * `tag` — An arbitrary string annotation attached to the instruction.
    ///   Stim propagates tags across circuit transformations but otherwise
    ///   ignores them. Use an empty string (`""`) for no tag.
    ///
    /// # Errors
    ///
    /// Returns an error if the combination of gate name, targets, and
    /// arguments is not valid according to Stim's gate definitions — for
    /// example, if a two-qubit gate receives an odd number of targets, or
    /// if an unknown gate name is provided.
    ///
    /// # Examples
    ///
    /// ```
    /// let inst = stim::CircuitInstruction::new(
    ///     "X_ERROR", [5u32, 7u32], [0.125], "",
    /// ).expect("valid instruction");
    /// assert_eq!(inst.to_string(), "X_ERROR(0.125) 5 7");
    /// ```
    pub fn new(
        name: impl Into<String>,
        targets: impl IntoIterator<Item = impl Into<GateTarget>>,
        gate_args: impl IntoIterator<Item = f64>,
        tag: impl Into<String>,
    ) -> Result<Self> {
        let raw_name = name.into();
        let instruction = Self {
            name: canonical_gate_name(&raw_name),
            tag: tag.into(),
            gate_args: gate_args.into_iter().collect(),
            targets: targets.into_iter().map(Into::into).collect(),
            num_measurements: 0,
        };
        let num_measurements = instruction.compute_num_measurements()?;
        Ok(Self {
            num_measurements,
            ..instruction
        })
    }

    /// Parses a single instruction from Stim program text.
    ///
    /// The text must contain exactly one instruction — not a `REPEAT` block
    /// and not multiple lines of operations. Comments (text after `#`) are
    /// stripped during parsing, so `"CX rec[-1] 5  # comment"` is valid.
    ///
    /// This is the Rust counterpart to the Python pattern of constructing a
    /// `stim.CircuitInstruction` by passing a full instruction line as the
    /// name with no targets or gate args.
    ///
    /// This is also available via the [`FromStr`] implementation, so you
    /// can use `"H 0 1".parse::<CircuitInstruction>()`.
    ///
    /// # Errors
    ///
    /// Returns an error if:
    ///
    /// - The text contains multiple operations (multiple lines).
    /// - The text is a `REPEAT` block.
    /// - The text is otherwise not a valid single Stim instruction.
    ///
    /// # Examples
    ///
    /// ```
    /// use stim::CircuitInstruction;
    ///
    /// let inst = CircuitInstruction::from_stim_program_text("H 0 1")
    ///     .expect("valid instruction text");
    /// assert_eq!(inst.name(), "H");
    ///
    /// // Using the FromStr impl:
    /// let cx: CircuitInstruction = "CX 0 1".parse().expect("valid");
    /// assert_eq!(cx.name(), "CX");
    /// ```
    pub fn from_stim_program_text(text: &str) -> Result<Self> {
        let circuit = Circuit::from_str(text)?;
        let normalized = circuit.to_string();
        if normalized.contains('\n') {
            return Err(StimError::new(
                "expected a single circuit instruction, got multiple operations",
            ));
        }
        if normalized.starts_with("REPEAT") {
            return Err(StimError::new(
                "CircuitInstruction cannot represent REPEAT blocks",
            ));
        }

        let (head, tail) = split_head_and_tail(&normalized);
        let (name, tag, gate_args) = parse_head(head)?;
        let targets = parse_targets(tail)?;
        Self::new(name, targets, gate_args, tag)
    }

    /// Returns the canonical gate name (e.g. `"CX"`, `"H"`, `"M"`,
    /// `"X_ERROR"`, `"DETECTOR"`).
    ///
    /// The name is always the canonical form, regardless of which alias was
    /// used during construction. For example, constructing with `"cnot"`
    /// will still return `"CX"` from this accessor.
    #[must_use]
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Returns the instruction's tag string, or `""` if no tag was set.
    ///
    /// The tag is an arbitrary custom string attached to the instruction.
    /// Tags appear in Stim syntax as bracketed annotations, e.g. the
    /// `100ns` in `I[100ns] 2`. Stim will attempt to propagate tags across
    /// circuit transformations (such as unrolling repeat blocks) but will
    /// otherwise completely ignore them. They can be used by custom code
    /// for purposes like specifying timing information for noise insertion.
    ///
    /// The default tag, when none is specified, is the empty string.
    #[must_use]
    pub fn tag(&self) -> &str {
        &self.tag
    }

    /// Returns a copy of the gate's numeric arguments.
    ///
    /// Gate arguments are the numbers that parameterize a gate. For noisy
    /// gates this is typically a list of probabilities — for example,
    /// `DEPOLARIZE1(0.01)` has a single gate argument `[0.01]`, and
    /// `PAULI_CHANNEL_1(0.1, 0.2, 0.05)` has three. For
    /// `OBSERVABLE_INCLUDE` it is a singleton list containing the logical
    /// observable index. Most unitary gates like `H` have an empty argument
    /// list.
    ///
    /// Each call returns a fresh `Vec`, so callers can mutate the result
    /// without affecting the instruction.
    #[must_use]
    pub fn gate_args_copy(&self) -> Vec<f64> {
        self.gate_args.clone()
    }

    /// Returns a copy of all targets the instruction acts on.
    ///
    /// The returned targets are in the same order they appeared when the
    /// instruction was constructed. For Pauli-product gates like `MPP`, the
    /// list includes combiner targets (`*`) interleaved with Pauli targets.
    /// Use [`target_groups()`](Self::target_groups) if you need the targets
    /// already split into logical groups.
    ///
    /// Each call returns a fresh `Vec`, so callers can mutate the result
    /// without affecting the instruction.
    #[must_use]
    pub fn targets_copy(&self) -> Vec<GateTarget> {
        self.targets.clone()
    }

    /// Returns the number of measurement results (bits) this instruction
    /// produces when executed.
    ///
    /// This value is computed eagerly during construction and cached, so
    /// calling this method is free.
    ///
    /// The counting rules depend on the gate:
    ///
    /// - **Non-measuring gates** like `H` or `CX` return `0`.
    /// - **Single-qubit measurements** like `M` count one per target, so
    ///   `M 2 3 5 7 11` returns `5`.
    /// - **Two-qubit measurements** like `MXX` count one per pair of
    ///   targets, so `MXX 0 1 4 5 11 13` returns `3`.
    /// - **Pauli-product measurements** like `MPP` count one per product
    ///   group (separated by combiners), so `MPP X0*X1 X0*Z1*Y2` returns
    ///   `2`.
    /// - **Heralded operations** like `HERALDED_ERASE` count one per
    ///   target.
    #[must_use]
    pub fn num_measurements(&self) -> u64 {
        self.num_measurements
    }

    /// Splits the instruction's targets into logical operation groups.
    ///
    /// The grouping strategy depends on the gate type, following the same
    /// rules as Stim's Python `CircuitInstruction.target_groups()`:
    ///
    /// - **Single-qubit gates and single-qubit measurements** (e.g. `H`,
    ///   `M`): each target becomes its own group of size 1.
    /// - **Two-qubit gates** (e.g. `CX`, `MXX`): targets are paired into
    ///   groups of size 2.
    /// - **Gates with combiners** (e.g. `MPP X0*Y1 X5*X6`): targets are
    ///   split on combiner boundaries, and the combiner targets themselves
    ///   are removed from the output groups.
    /// - **Instructions taking measurement record targets** (e.g.
    ///   `DETECTOR rec[-1] rec[-2]`): each record reference forms its own
    ///   group.
    /// - **Other gates** (e.g. `CORRELATED_ERROR`): all targets form a
    ///   single group.
    ///
    /// Returns an empty `Vec` if the instruction has no targets.
    #[must_use]
    pub fn target_groups(&self) -> Vec<Vec<GateTarget>> {
        if self.targets.is_empty() {
            return Vec::new();
        }
        if self.targets.iter().any(|target| target.is_combiner()) {
            return split_on_combiners(&self.targets);
        }

        match GateData::new(&self.name) {
            Ok(gate) if gate.is_two_qubit_gate() => self
                .targets
                .chunks_exact(2)
                .map(|chunk| chunk.to_vec())
                .collect(),
            Ok(gate)
                if gate.is_single_qubit_gate()
                    || gate.produces_measurements()
                    || gate.takes_measurement_record_targets() =>
            {
                self.targets
                    .iter()
                    .copied()
                    .map(|target| vec![target])
                    .collect()
            }
            _ => vec![self.targets.clone()],
        }
    }

    fn compute_num_measurements(&self) -> Result<u64> {
        let mut circuit = Circuit::new();
        circuit.append_instruction(self)?;
        Ok(circuit.num_measurements())
    }

    fn fmt_repr(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "stim::CircuitInstruction({:?}, [", self.name)?;
        for (index, target) in self.targets.iter().enumerate() {
            if index > 0 {
                f.write_str(", ")?;
            }
            write!(f, "{target:?}")?;
        }
        write!(f, "], {:?}", self.gate_args)?;
        if !self.tag.is_empty() {
            write!(f, ", tag={:?}", self.tag)?;
        }
        f.write_str(")")
    }
}

impl Eq for CircuitInstruction {}

impl PartialOrd for CircuitInstruction {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for CircuitInstruction {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.name
            .cmp(&other.name)
            .then_with(|| self.tag.cmp(&other.tag))
            .then_with(|| compare_f64_slices(&self.gate_args, &other.gate_args))
            .then_with(|| self.targets.cmp(&other.targets))
    }
}

impl std::hash::Hash for CircuitInstruction {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.name.hash(state);
        self.tag.hash(state);
        for arg in &self.gate_args {
            arg.to_bits().hash(state);
        }
        self.targets.hash(state);
    }
}

impl Display for CircuitInstruction {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.write_str(&self.name)?;
        if !self.tag.is_empty() {
            write!(f, "[{}]", self.tag)?;
        }
        if !self.gate_args.is_empty() {
            f.write_str("(")?;
            for (index, arg) in self.gate_args.iter().enumerate() {
                if index > 0 {
                    f.write_str(",")?;
                }
                write!(f, "{arg}")?;
            }
            f.write_str(")")?;
        }
        for target in &self.targets {
            if target.is_combiner() {
                write!(f, "{target}")?;
            } else {
                write!(f, " {target}")?;
            }
        }
        Ok(())
    }
}

impl fmt::Debug for CircuitInstruction {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        self.fmt_repr(f)
    }
}

impl Circuit {
    /// Appends a [`CircuitInstruction`] to the end of this circuit.
    ///
    /// The instruction is serialized to Stim program text and re-parsed by
    /// the underlying C++ engine, so the result is always consistent with
    /// Stim's own representation.
    ///
    /// # Errors
    ///
    /// Returns an error if the instruction's name is empty or if the
    /// serialized text is rejected by the Stim parser.
    ///
    /// # Examples
    ///
    /// ```
    /// let mut circuit = stim::Circuit::new();
    /// let h = stim::CircuitInstruction::new(
    ///     "H", [0u32], std::iter::empty::<f64>(), "",
    /// ).expect("valid instruction");
    /// circuit.append_instruction(&h).expect("append succeeds");
    /// assert_eq!(circuit.to_string(), "H 0");
    /// ```
    pub fn append_instruction(&mut self, instruction: &CircuitInstruction) -> Result<()> {
        if instruction.name().trim().is_empty() {
            return Err(StimError::new("instruction name must not be empty"));
        }
        let raw_targets = instruction
            .targets_copy()
            .into_iter()
            .map(|target| target.raw_data())
            .collect::<Vec<_>>();
        self.inner
            .append_with_tag(
                instruction.name(),
                &raw_targets,
                &instruction.gate_args_copy(),
                instruction.tag(),
            )
            .map_err(StimError::from)?;
        self.invalidate_item_cache();
        Ok(())
    }
}

fn split_on_combiners(targets: &[GateTarget]) -> Vec<Vec<GateTarget>> {
    let mut groups = Vec::new();
    let mut current = Vec::new();
    for (index, target) in targets.iter().enumerate() {
        if target.is_combiner() {
            continue;
        }
        current.push(*target);
        let at_group_end = targets
            .get(index + 1)
            .is_none_or(|next| !next.is_combiner());
        if at_group_end {
            groups.push(std::mem::take(&mut current));
        }
    }
    groups
}

fn compare_f64_slices(left: &[f64], right: &[f64]) -> std::cmp::Ordering {
    for (l, r) in left.iter().zip(right.iter()) {
        let cmp = l.to_bits().cmp(&r.to_bits());
        if cmp != std::cmp::Ordering::Equal {
            return cmp;
        }
    }
    left.len().cmp(&right.len())
}

impl FromStr for CircuitInstruction {
    type Err = StimError;

    fn from_str(s: &str) -> Result<Self> {
        Self::from_stim_program_text(s)
    }
}

fn canonical_gate_name(name: &str) -> String {
    GateData::new(name)
        .map(|gate| gate.name())
        .unwrap_or_else(|_| name.to_string())
}

fn parse_head(head: &str) -> Result<(String, String, Vec<f64>)> {
    let name_end = head.find(['[', '(']).unwrap_or(head.len());
    let name = &head[..name_end];
    let mut rest = &head[name_end..];
    let mut tag = String::new();
    let mut gate_args = Vec::new();

    if let Some(after_open) = rest.strip_prefix('[') {
        let close = after_open
            .find(']')
            .ok_or_else(|| StimError::new("unterminated instruction tag"))?;
        tag = after_open[..close].to_string();
        rest = &after_open[close + 1..];
    }

    if let Some(after_open) = rest.strip_prefix('(') {
        let close = after_open
            .find(')')
            .ok_or_else(|| StimError::new("unterminated instruction argument list"))?;
        let raw_args = &after_open[..close];
        if !raw_args.is_empty() {
            gate_args = raw_args
                .split(',')
                .map(|arg| {
                    arg.trim()
                        .parse::<f64>()
                        .map_err(|_| StimError::new(format!("invalid gate arg: {arg}")))
                })
                .collect::<Result<Vec<_>>>()?;
        }
    }

    Ok((name.to_string(), tag, gate_args))
}

fn split_head_and_tail(text: &str) -> (&str, &str) {
    let mut paren_depth = 0usize;
    let mut bracket_depth = 0usize;
    for (index, ch) in text.char_indices() {
        match ch {
            '(' => paren_depth += 1,
            ')' => paren_depth = paren_depth.saturating_sub(1),
            '[' => bracket_depth += 1,
            ']' => bracket_depth = bracket_depth.saturating_sub(1),
            ' ' if paren_depth == 0 && bracket_depth == 0 => {
                return (&text[..index], &text[index + 1..]);
            }
            _ => {}
        }
    }
    (text, "")
}

fn parse_targets(targets_text: &str) -> Result<Vec<GateTarget>> {
    let mut targets = Vec::new();
    for group in targets_text.split_whitespace() {
        let mut parts = group.split('*').peekable();
        while let Some(part) = parts.next() {
            if !part.is_empty() {
                targets.push(GateTarget::from_target_str(part)?);
            }
            if parts.peek().is_some() {
                targets.push(GateTarget::combiner());
            }
        }
    }
    Ok(targets)
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::collections::{BTreeSet, HashSet};
    use std::str::FromStr;

    #[test]
    fn constructor_and_accessors_preserve_values() {
        let instruction = CircuitInstruction::new("X_ERROR", [5u32, 7u32], [0.125], "").unwrap();

        assert_eq!(instruction.name(), "X_ERROR");
        assert_eq!(instruction.tag(), "");
        assert_eq!(instruction.gate_args_copy(), vec![0.125]);
        assert_eq!(
            instruction.targets_copy(),
            vec![GateTarget::from(5u32), GateTarget::from(7u32)]
        );
        assert_eq!(instruction.num_measurements(), 0);
        assert_eq!(instruction.to_string(), "X_ERROR(0.125) 5 7");
    }

    #[test]
    fn constructor_canonicalizes_aliases_and_parser_roundtrips_lines() {
        let aliased = CircuitInstruction::new(
            "cnot",
            [GateTarget::rec(-1).unwrap(), GateTarget::from(5u32)],
            std::iter::empty::<f64>(),
            "annotated",
        )
        .unwrap();
        let parsed = CircuitInstruction::from_str("CX[annotated] rec[-1] 5").unwrap();
        let mpp = CircuitInstruction::from_str("MPP X0*Y1 X5*X6").unwrap();

        assert_eq!(aliased.name(), "CX");
        assert_eq!(aliased, parsed);
        assert_eq!(
            mpp.targets_copy(),
            vec![
                GateTarget::x(0u32, false).unwrap(),
                GateTarget::combiner(),
                GateTarget::y(1u32, false).unwrap(),
                GateTarget::x(5u32, false).unwrap(),
                GateTarget::combiner(),
                GateTarget::x(6u32, false).unwrap(),
            ]
        );
    }

    #[test]
    fn parser_accepts_spaced_paren_args_emitted_by_stim() {
        let qubit_coords =
            CircuitInstruction::from_str("QUBIT_COORDS(1, 2) 0").expect("instruction should parse");
        let detector = CircuitInstruction::from_str("DETECTOR(2, 0, 0) rec[-24]")
            .expect("instruction should parse");

        assert_eq!(qubit_coords.name(), "QUBIT_COORDS");
        assert_eq!(qubit_coords.gate_args_copy(), vec![1.0, 2.0]);
        assert_eq!(qubit_coords.targets_copy(), vec![GateTarget::from(0u32)]);

        assert_eq!(detector.name(), "DETECTOR");
        assert_eq!(detector.gate_args_copy(), vec![2.0, 0.0, 0.0]);
        assert_eq!(detector.targets_copy(), vec![GateTarget::rec(-24).unwrap()]);
    }

    #[test]
    fn display_debug_and_tagged_append_match_binding_conventions() {
        let instruction =
            CircuitInstruction::new("I", [2u32], std::iter::empty::<f64>(), "100ns").unwrap();

        assert_eq!(instruction.to_string(), "I[100ns] 2");
        assert_eq!(
            format!("{instruction:?}"),
            "stim::CircuitInstruction(\"I\", [stim::GateTarget::qubit(2, false).unwrap()], [], tag=\"100ns\")"
        );

        let mut circuit = Circuit::new();
        circuit.append_instruction(&instruction).unwrap();
        assert_eq!(circuit.to_string(), "I[100ns] 2");
    }

    #[test]
    fn equality_hash_and_order_follow_name_tag_args_then_targets() {
        let first =
            CircuitInstruction::new("X_ERROR", [5u32], [0.125], "").expect("instruction builds");
        let same =
            CircuitInstruction::new("X_ERROR", [5u32], [0.125], "").expect("instruction builds");
        let different_tag =
            CircuitInstruction::new("X_ERROR", [5u32], [0.125], "tag").expect("instruction builds");
        let different_name =
            CircuitInstruction::new("Y_ERROR", [5u32], [0.125], "").expect("instruction builds");

        assert_eq!(first, same);
        assert_ne!(first, different_tag);
        assert_ne!(first, different_name);

        let ordered = [
            different_name.clone(),
            different_tag.clone(),
            same.clone(),
            first.clone(),
        ]
        .into_iter()
        .collect::<BTreeSet<_>>()
        .into_iter()
        .collect::<Vec<_>>();
        assert_eq!(ordered, vec![first.clone(), different_tag, different_name]);

        let hashed = [first.clone(), same, first.clone()]
            .into_iter()
            .collect::<HashSet<_>>();
        assert_eq!(hashed.len(), 1);
        assert!(hashed.contains(&first));
    }

    #[test]
    fn target_groups_follow_documented_shapes() {
        let single =
            CircuitInstruction::new("H", [0u32, 1u32, 2u32], std::iter::empty::<f64>(), "")
                .unwrap();
        let two_qubit = CircuitInstruction::new(
            "CX",
            [0u32, 1u32, 2u32, 3u32],
            std::iter::empty::<f64>(),
            "",
        )
        .unwrap();
        let mpp = CircuitInstruction::new(
            "MPP",
            [
                GateTarget::x(0u32, false).unwrap(),
                GateTarget::combiner(),
                GateTarget::y(1u32, false).unwrap(),
                GateTarget::x(5u32, false).unwrap(),
                GateTarget::combiner(),
                GateTarget::x(6u32, false).unwrap(),
            ],
            std::iter::empty::<f64>(),
            "",
        )
        .unwrap();
        let detector = CircuitInstruction::new(
            "DETECTOR",
            [GateTarget::rec(-1).unwrap(), GateTarget::rec(-2).unwrap()],
            [2.0, 3.0],
            "",
        )
        .unwrap();
        let correlated = CircuitInstruction::new(
            "CORRELATED_ERROR",
            [
                GateTarget::x(0u32, false).unwrap(),
                GateTarget::y(1u32, false).unwrap(),
            ],
            [0.1],
            "",
        )
        .unwrap();

        assert_eq!(
            single.target_groups(),
            vec![
                vec![GateTarget::from(0u32)],
                vec![GateTarget::from(1u32)],
                vec![GateTarget::from(2u32)],
            ]
        );
        assert_eq!(
            two_qubit.target_groups(),
            vec![
                vec![GateTarget::from(0u32), GateTarget::from(1u32)],
                vec![GateTarget::from(2u32), GateTarget::from(3u32)],
            ]
        );
        assert_eq!(
            mpp.target_groups(),
            vec![
                vec![
                    GateTarget::x(0u32, false).unwrap(),
                    GateTarget::y(1u32, false).unwrap()
                ],
                vec![
                    GateTarget::x(5u32, false).unwrap(),
                    GateTarget::x(6u32, false).unwrap()
                ],
            ]
        );
        assert_eq!(
            detector.target_groups(),
            vec![
                vec![GateTarget::rec(-1).unwrap()],
                vec![GateTarget::rec(-2).unwrap()]
            ]
        );
        assert_eq!(
            correlated.target_groups(),
            vec![vec![
                GateTarget::x(0u32, false).unwrap(),
                GateTarget::y(1u32, false).unwrap(),
            ]]
        );
    }

    #[test]
    fn num_measurements_matches_instruction_semantics() {
        assert_eq!(
            CircuitInstruction::new("H", [0u32], std::iter::empty::<f64>(), "")
                .unwrap()
                .num_measurements(),
            0
        );
        assert_eq!(
            CircuitInstruction::new("M", [0u32], std::iter::empty::<f64>(), "")
                .unwrap()
                .num_measurements(),
            1
        );
        assert_eq!(
            CircuitInstruction::new(
                "M",
                [2u32, 3u32, 5u32, 7u32, 11u32],
                std::iter::empty::<f64>(),
                "",
            )
            .unwrap()
            .num_measurements(),
            5
        );
        assert_eq!(
            CircuitInstruction::new(
                "MXX",
                [0u32, 1u32, 4u32, 5u32, 11u32, 13u32],
                std::iter::empty::<f64>(),
                "",
            )
            .unwrap()
            .num_measurements(),
            3
        );
        assert_eq!(
            CircuitInstruction::new(
                "MPP",
                [
                    GateTarget::x(0u32, false).unwrap(),
                    GateTarget::combiner(),
                    GateTarget::x(1u32, false).unwrap(),
                    GateTarget::x(0u32, false).unwrap(),
                    GateTarget::combiner(),
                    GateTarget::y(1u32, false).unwrap(),
                    GateTarget::combiner(),
                    GateTarget::y(2u32, false).unwrap(),
                ],
                std::iter::empty::<f64>(),
                "",
            )
            .unwrap()
            .num_measurements(),
            2
        );
        assert_eq!(
            CircuitInstruction::new("HERALDED_ERASE", [0u32], [0.25], "")
                .unwrap()
                .num_measurements(),
            1
        );
    }

    #[test]
    fn parser_rejects_multi_operation_and_repeat_inputs_and_covers_remaining_formats() {
        let multiple = CircuitInstruction::from_stim_program_text("H 0\nX 1").unwrap_err();
        assert!(
            multiple
                .message()
                .contains("expected a single circuit instruction")
        );

        let repeat =
            CircuitInstruction::from_stim_program_text("REPEAT 2 {\n    H 0\n}").unwrap_err();
        assert!(
            repeat.message().contains("REPEAT")
                || repeat.message().contains("single circuit instruction")
        );

        let tick = CircuitInstruction::from_str("TICK").unwrap();
        assert!(tick.target_groups().is_empty());

        let multi_args =
            CircuitInstruction::from_stim_program_text("PAULI_CHANNEL_1(0.1,0.2,0.3) 0").unwrap();
        assert_eq!(multi_args.to_string(), "PAULI_CHANNEL_1(0.1,0.2,0.3) 0");

        let mpp = CircuitInstruction::from_str("MPP X0*Y1").unwrap();
        assert_eq!(mpp.to_string(), "MPP X0* Y1");
        assert!(format!("{mpp:?}").contains("CircuitInstruction"));

        let mut circuit = Circuit::new();
        let invalid = CircuitInstruction {
            name: " ".to_string(),
            tag: String::new(),
            gate_args: vec![],
            targets: vec![],
            num_measurements: 0,
        };
        let error = circuit.append_instruction(&invalid).unwrap_err();
        assert!(
            error
                .message()
                .contains("instruction name must not be empty")
        );

        let low = CircuitInstruction::new("X_ERROR", [0u32], [0.1], "").unwrap();
        let high = CircuitInstruction::new("X_ERROR", [0u32], [0.2], "").unwrap();
        assert!(low < high);
    }
}