Struct dqcsim::common::types::Matrix

pub struct Matrix { /* fields omitted */ }

Matrix wrapper for Gate matrices.

Implementations

impl Matrix

pub fn new(elements: impl IntoIterator<Item = Complex64>) -> Result<Self>

Returns a new Matrix with provided elements.

pub fn new_identity(dimension: usize) -> Self

Returns a new identity Matrix with given dimension.

pub fn approx_eq(
    &self,
    other: &Matrix,
    epsilon: f64,
    ignore_global_phase: bool
) -> bool

Approximately compares this Matrix with another Matrix. epsilon specifies the maximum element-wise root-mean-square error between the matrices that results in a positive match. ignore_phase specifies whether the aforementioned check should ignore global phase.

pub fn basis_approx_eq(&self, other: &Matrix, epsilon: f64) -> bool

Approximately compares two matrices representing bases with each other.

The basis representation works as follows:

• (apply hermetian of matrix as gate if measurement)
• measure/prep Z
• apply matrix as gate

Any rotation around the Z axis is don't care before and after the prep/measurement, because that information is thrown away when the prep/measurement occurs. Global phase is also don't care as usual. That means the following must hold for the bases to be equal:

              / e^ix   0  \  ~
    basis_a * |           |  =  basis_b
              \  0   e^iy /

    / a_a e^ix   a_b e^iy \  ~  / b_a   b_b \
    |                     |  =  |           |
    \ a_c e^ix   a_d e^iy /     \ b_c   b_d /

with x and y being free variables.

pub fn approx_unitary(&self, epsilon: f64) -> bool

Checks whether this Matrix is approximately unitary by multiplying itself with its hermetian, and measuring the RMS difference of the result and the identity matrix. If this difference is more than epsilon the matrix is not (sufficiently) unitary and this function returns false, otherwise it returns true.

pub fn add_controls(&self, number_of_controls: usize) -> Self

Returns new Matrix with number_of_control qubits added.

pub fn strip_control(
    &self,
    epsilon: f64,
    ignore_global_phase: bool
) -> (HashSet<usize>, Matrix)

Returns new Matrix with control behavior removed from the Matrix, and the control indices corresponding to the target qubits acting as control in the original Matrix.

epsilon specifies the maximum magitude of the difference between the column vectors of the input matrix and the identity matrix (after dephasing if ignore_phase is set) for the column vector to be considered to not affect the respective entry in the quantum state vector. Note that if this is greater than zero, the resulting gate may not be exactly equivalent. If ignore_global_phase is set, any global phase in the matrix is ignored, but note that if control qubits are stripped the "global" phase of the resulting submatrix is always significant.

This function assumes that the incoming matrix is unitary (within epsilon) without verifying that this is the case. The results may thus be invalid if it was not.

The identity matrix special case is handled by interpreting all qubits as non-control (any set of qubits would satisfy the controlled matrix criterium).

pub fn len(&self) -> usize

Returns the number of elements in the Matrix.

pub fn is_empty(&self) -> bool

Returns true if the Matrix is empty.

pub fn dimension(&self) -> usize

Returns the dimension of the Matrix. The dimension equals the square root of the number of elements.

pub fn num_qubits(&self) -> Option<usize>

Returns the number of qubits for this Matrix.

pub fn get(&self, row: usize, column: usize) -> Option<&Complex64>

Returns the element at given row and colum index. Returns None for out of bound indices.

Trait Implementations

impl Clone for Matrix

fn clone(&self) -> Matrix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Matrix

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Matrix

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Matrix

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

Formats the value using the given formatter.

impl Eq for Matrix

impl From<Basis> for Matrix

fn from(basis: Basis) -> Matrix

Performs the conversion.

impl<'_, '_> From<BoundUnitaryGate<'_, '_>> for Matrix

fn from(bound_gate: BoundUnitaryGate<'_, '_>) -> Matrix

Performs the conversion.

impl From<Matrix> for FixedMatrixConverter

fn from(matrix: Matrix) -> FixedMatrixConverter

Performs the conversion.

impl<'_> From<UnboundUnitaryGate<'_>> for Matrix

fn from(unbound_gate: UnboundUnitaryGate<'_>) -> Matrix

Performs the conversion.

impl FromArb for Matrix

fn from_arb(src: &mut ArbData) -> Result<Self>

Construct from the given ArbData, taking the parameters used for construction out of the data object.

impl Hash for Matrix

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, 

Feeds a slice of this type into the given Hasher.

impl Index<(usize, usize)> for Matrix

type Output = Complex64

The returned type after indexing.

fn index(&self, index: (usize, usize)) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for Matrix

type Output = Complex64

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<(usize, usize)> for Matrix

fn index_mut(&mut self, index: (usize, usize)) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Matrix

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for Matrix

type Item = Complex64

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Matrix> for Matrix

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Matrix

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl ToArb for Matrix

fn to_arb(self, dest: &mut ArbData)

Convert self to ArbData parameters and add them to the data object.

impl TryFrom<UnitaryGateType> for Matrix

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(gate_type: UnitaryGateType) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<Complex<f64>>> for Matrix

type Error = Error

The type returned in the event of a conversion error.

fn try_from(elements: Vec<Complex64>) -> Result<Self>

Performs the conversion.