qubit_argument/argument/constraint/comparison_constraint.rs
1// =============================================================================
2// Copyright (c) 2025 - 2026 Haixing Hu.
3//
4// SPDX-License-Identifier: Apache-2.0
5//
6// Licensed under the Apache License, Version 2.0.
7// =============================================================================
8//! Scalar comparison constraints.
9
10use crate::argument::ArgumentValue;
11
12/// A comparison between an argument and a captured scalar value.
13///
14/// # Examples
15///
16/// ```
17/// use qubit_argument::{ArgumentValue, ComparisonConstraint};
18///
19/// let constraint = ComparisonConstraint::AtLeast(ArgumentValue::from(10_i32));
20/// assert!(matches!(constraint, ComparisonConstraint::AtLeast(_)));
21/// ```
22///
23/// ```compile_fail
24/// #![deny(unused_must_use)]
25/// use qubit_argument::{ArgumentValue, ComparisonConstraint};
26///
27/// ComparisonConstraint::EqualTo(ArgumentValue::Signed(1));
28/// ```
29#[must_use]
30#[derive(Debug, Clone, PartialEq, Eq)]
31pub enum ComparisonConstraint {
32 /// Requires equality with the captured value.
33 EqualTo(ArgumentValue),
34 /// Requires inequality with the captured value.
35 NotEqualTo(ArgumentValue),
36 /// Requires a value strictly less than the captured value.
37 LessThan(ArgumentValue),
38 /// Requires a value less than or equal to the captured value.
39 AtMost(ArgumentValue),
40 /// Requires a value strictly greater than the captured value.
41 GreaterThan(ArgumentValue),
42 /// Requires a value greater than or equal to the captured value.
43 AtLeast(ArgumentValue),
44}