Struct ClassicalVar 

pub struct ClassicalVar { /* private fields */ }

Circuit-local handle to a mutable runtime classical storage location.

The handle carries its static type so expression and operation builders can validate uses without maintaining parallel typed ID families. The id is meaningful only inside the circuit that allocated it.

Implementations

impl ClassicalVar

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

Creates a new classical variable handle.

Prefer Circuit::var for normal circuit construction so the handle is registered in the circuit’s type table.

pub fn id(self) -> u32

Returns the circuit-local variable identifier.

pub fn index(self) -> u32

Returns the circuit-local variable table index.

pub fn circuit_id(self) -> CircuitId

Returns the identity of the circuit that owns this variable.

pub fn ty(self) -> ClassicalType

Returns the static type of this variable.

pub fn expr(self) -> ClassicalExpr

Creates an expression that reads this variable’s current runtime value.

Trait Implementations

impl<Rhs> BitAnd<Rhs> for ClassicalVar

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 ClassicalVar

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 ClassicalVar

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 ClassicalVar

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 ClassicalVar

impl Debug for ClassicalVar

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

Formats the value using the given formatter.

impl Eq for ClassicalVar

impl From<ClassicalVar> for ClassicalExpr

fn from(var: ClassicalVar) -> Self

Converts to this type from the input type.

impl Hash for ClassicalVar

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 ClassicalVar

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 ClassicalVar

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 ClassicalVar

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ClassicalVar

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 ClassicalVar