Struct ClassicalValue 

pub struct ClassicalValue { /* private fields */ }

Circuit-local handle to an immutable runtime classical value.

Values are produced by operations such as measurement. Unlike ClassicalVar, a value is never overwritten. If a runtime result must be preserved as loop-carried mutable state, store it into a ClassicalVar.

Implementations

impl ClassicalValue

pub fn new(circuit_id: CircuitId, index: u32, ty: ClassicalType) -> Self

Creates a new classical value handle.

Prefer circuit measurement builders for normal circuit construction so the value has a dominating producer in the circuit IR.

pub fn index(self) -> u32

Returns the circuit-local value table index.

pub fn circuit_id(self) -> CircuitId

Returns the identity of the circuit that owns this value.

pub fn ty(self) -> ClassicalType

Returns the static type of this value.

pub fn expr(self) -> ClassicalExpr

Creates an expression that reads this immutable runtime value.

Trait Implementations

impl<Rhs> BitAnd<Rhs> for ClassicalValue

where Rhs: Into<ClassicalExpr>,

type Output = ClassicalExpr

The resulting type after applying the & operator.

fn bitand(self, rhs: Rhs) -> Self::Output

Performs the & operation.

impl<Rhs> BitOr<Rhs> for ClassicalValue

where Rhs: Into<ClassicalExpr>,

type Output = ClassicalExpr

The resulting type after applying the | operator.

fn bitor(self, rhs: Rhs) -> Self::Output

Performs the | operation.

impl<Rhs> BitXor<Rhs> for ClassicalValue

where Rhs: Into<ClassicalExpr>,

type Output = ClassicalExpr

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Rhs) -> Self::Output

Performs the ^ operation.

impl Clone for ClassicalValue

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ClassicalValue

impl Debug for ClassicalValue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for ClassicalValue

impl From<ClassicalValue> for ClassicalExpr

fn from(value: ClassicalValue) -> Self

Converts to this type from the input type.

impl Hash for ClassicalValue

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Not for ClassicalValue

type Output = ClassicalExpr

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation using logical or bitwise negation.

impl Ord for ClassicalValue

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ClassicalValue

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for ClassicalValue

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ClassicalValue