Struct Register

pub struct Register<const N: usize> { /* private fields */ }

A quantum register that holds the state of N qubits

Implementations

impl<const N: usize> Register<N>

pub fn new() -> Self

Create a new register with N qubits in the |0…0⟩ state

pub fn with_amplitudes(amplitudes: Vec<Complex64>) -> QuantRS2Result<Self>

Create a register with custom initial amplitudes

Errors

Returns an error if the provided amplitudes vector doesn’t have the correct dimension (2^N) or if the vector isn’t properly normalized.

pub const fn num_qubits(&self) -> usize

Get the number of qubits in this register

pub const fn dimension(&self) -> usize

Get the dimension of the state space (2^N)

pub fn amplitudes(&self) -> &[Complex64]

Get access to the raw amplitudes vector

pub fn amplitudes_mut(&mut self) -> &mut [Complex64]

Get mutable access to the raw amplitudes vector

pub fn amplitude(&self, bits: &[u8]) -> QuantRS2Result<Complex64>

Get the amplitude for a specific basis state

The bits parameter must be a slice of length N, where each element is either 0 or 1 representing the computational basis state.

Errors

Returns an error if the bits slice has incorrect length or contains values other than 0 or 1.

pub fn probability(&self, bits: &[u8]) -> QuantRS2Result<f64>

Calculate the probability of measuring a specific basis state

The bits parameter must be a slice of length N, where each element is either 0 or 1 representing the computational basis state.

Errors

Returns an error if the bits slice has incorrect length or contains values other than 0 or 1.

pub fn probabilities(&self) -> Vec<f64>

Calculate the probabilities of measuring each basis state

pub fn expectation_z(&self, qubit: impl Into<QubitId>) -> QuantRS2Result<f64>

Calculate the expectation value of a single-qubit Pauli operator

Trait Implementations

impl<const N: usize> Clone for Register<N>

fn clone(&self) -> Register<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Register<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for Register<N>

fn default() -> Self

Returns the “default value” for a type.