Struct Qubit 

pub struct Qubit(/* private fields */);

A lightweight logical qubit identifier.

Equality compares only the numeric identifier. A Qubit does not carry a circuit identity, physical-device location, or state-vector position. The owning circuit and the matrix or simulator qubit order determine those meanings.

It wraps a u32 to provide a compact representation. Numeric IDs may be sparse, so callers must not assume that Qubit::index is a valid position in a circuit’s dense qubit storage or a simulator state vector.

Examples

Basic usage:

use cqlib_core::circuit::bit::Qubit;

// Create a logical qubit with numeric identifier 5.
let q = Qubit::new(5);

assert_eq!(q.id(), 5);
assert_eq!(q.index(), 5usize);

Implementations

impl Qubit

pub const fn new(id: u32) -> Self

Creates a logical qubit with the supplied numeric identifier.

This is the only way for external users to create a Qubit instance, as the internal field is private to enforce encapsulation.

pub const fn id(&self) -> u32

Returns the raw underlying identifier as a u32.

Use this when you need the compact 4-byte representation.

pub const fn index(&self) -> usize

Returns the numeric identifier as a usize.

This conversion does not map the qubit to its position in a particular circuit, matrix, or simulator. Such positions depend on the ordering maintained by the owning data structure.

Trait Implementations

impl Clone for Qubit

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 Qubit

impl Debug for Qubit

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

Formats the value using the given formatter.

impl Display for Qubit

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

Formats the qubit identifier.

The output format is Q<id> (e.g., Q0, Q12).

impl Eq for Qubit

impl From<LogicalQubit> for Qubit

fn from(qubit: LogicalQubit) -> Self

Converts to this type from the input type.

impl From<PhysicalQubit> for Qubit

fn from(qubit: PhysicalQubit) -> Self

Converts to this type from the input type.

impl From<Qubit> for LogicalQubit

fn from(qubit: Qubit) -> Self

Converts to this type from the input type.

impl From<Qubit> for PhysicalQubit

fn from(qubit: Qubit) -> Self

Converts to this type from the input type.

impl From<u8> for Qubit

fn from(idx: u8) -> Self

Converts to this type from the input type.

impl From<u16> for Qubit

fn from(idx: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Qubit

fn from(idx: u32) -> Self

Converts to this type from the input type.

impl Hash for Qubit

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 Ord for Qubit

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 Qubit

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Qubit

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 Qubit

impl TryFrom<i8> for Qubit

type Error = QubitError

The type returned in the event of a conversion error.

fn try_from(idx: i8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i16> for Qubit

type Error = QubitError

The type returned in the event of a conversion error.

fn try_from(idx: i16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for Qubit

type Error = QubitError

The type returned in the event of a conversion error.

fn try_from(idx: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for Qubit

type Error = QubitError

The type returned in the event of a conversion error.

fn try_from(idx: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Qubit

type Error = QubitError

The type returned in the event of a conversion error.

fn try_from(idx: usize) -> Result<Self, Self::Error>

Performs the conversion.