Struct quantum2::ket::Ket

pub struct Ket {
    pub elements: [Complex; 32],
    // some fields omitted
}

A ket describes the state of a quantum register.

We choose to always use kets as coefficients for linear combinations of the computational basis. A register of width n corresponds to a ket of size 2^n. Theoretically, the sum of the square coefficient moduli must equal 1.

We store the elements (left-aligned) in an array of size MAX_SIZE, with the unused slots set to zero.

See Wikipedia for more information.

Fields

elements: [Complex; 32]

The ket's elements, w.r.t. the computational basis.

Methods

impl Ket

pub fn new(size: usize) -> Ket

Construct a new, zero-initialized ket of given size.

pub fn from_classical(register: &ClassicalRegister) -> Ket

Generate a ket from a classical register.

This ket encodes a single basis vector, and is used for initializing a quantum register to an initial (classical) state.

pub fn is_valid(&self) -> bool

Is this structure a valid ket?

pub fn is_classical(&self) -> bool

Determine whether this ket represents a classically possible state.

This is true iff. the ket encodes a single basis vector, meaning that precisely one slot will have value 1, and all others 0.

pub fn size(register_width: usize) -> usize

Compute a ket's size from the register width.

pub fn apply(&mut self, gate: Gate)

Apply a quantum gate to this ket, mutating its state.

Trait Implementations

impl Clone for Ket

fn clone(&self) -> Ket

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Ket

impl PartialEq<Ket> for Ket

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for Ket

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

Formats the value using the given formatter.