Struct roqoqo::operations::SpinInteraction
source · [−]pub struct SpinInteraction {
control: usize,
target: usize,
x: CalculatorFloat,
y: CalculatorFloat,
z: CalculatorFloat,
}
Expand description
The generalized, anisotropic XYZ Heisenberg interaction between spins.
$$ e^{-\mathrm{i} (x \cdot X_c X_t + y \cdot Y_c Y_t + z \cdot Z_c Z_t)} $$
Where x, y, z are prefactors of the $X_c X_t$, $Y_c Y_t$, $Z_c Z_t$ Pauliproducts acting on control and target qubit, with $XX \equiv \sigma_x \sigma_x$, $YY \equiv \sigma_y \sigma_y$ and $ZZ \equiv \sigma_z \sigma_z$.
Fields
control: usize
The index of the most significant qubit in the unitary representation.
target: usize
The index of the least significant qubit in the unitary representation.
x: CalculatorFloat
The prefactor of the XX interaction.
y: CalculatorFloat
The prefactor of the YY interaction.
z: CalculatorFloat
The prefactor of the ZZ interaction.
Implementations
sourceimpl SpinInteraction
impl SpinInteraction
sourcepub fn x(&self) -> &CalculatorFloat
pub fn x(&self) -> &CalculatorFloat
Returns the value of the field x
.
sourcepub fn y(&self) -> &CalculatorFloat
pub fn y(&self) -> &CalculatorFloat
Returns the value of the field y
.
sourcepub fn z(&self) -> &CalculatorFloat
pub fn z(&self) -> &CalculatorFloat
Returns the value of the field z
.
sourcepub fn new(
control: usize,
target: usize,
x: CalculatorFloat,
y: CalculatorFloat,
z: CalculatorFloat
) -> Self
pub fn new(
control: usize,
target: usize,
x: CalculatorFloat,
y: CalculatorFloat,
z: CalculatorFloat
) -> Self
Creates a new instance of SpinInteraction
.
Trait Implementations
sourceimpl Clone for SpinInteraction
impl Clone for SpinInteraction
sourcefn clone(&self) -> SpinInteraction
fn clone(&self) -> SpinInteraction
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for SpinInteraction
impl Debug for SpinInteraction
sourceimpl<'de> Deserialize<'de> for SpinInteraction
impl<'de> Deserialize<'de> for SpinInteraction
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl From<SpinInteraction> for Operation
impl From<SpinInteraction> for Operation
Implements the From trait $\textit{from}$ this Operation.
sourcefn from(v: SpinInteraction) -> Self
fn from(v: SpinInteraction) -> Self
Performs the conversion.
sourceimpl From<SpinInteraction> for TwoQubitOperation
impl From<SpinInteraction> for TwoQubitOperation
Implements the From trait $\textit{from}$ this Operation.
sourcefn from(v: SpinInteraction) -> Self
fn from(v: SpinInteraction) -> Self
Performs the conversion.
sourceimpl From<SpinInteraction> for GateOperation
impl From<SpinInteraction> for GateOperation
Implements the From trait $\textit{from}$ this Operation.
sourcefn from(v: SpinInteraction) -> Self
fn from(v: SpinInteraction) -> Self
Performs the conversion.
sourceimpl From<SpinInteraction> for TwoQubitGateOperation
impl From<SpinInteraction> for TwoQubitGateOperation
Implements the From trait $\textit{from}$ this Operation.
sourcefn from(v: SpinInteraction) -> Self
fn from(v: SpinInteraction) -> Self
Performs the conversion.
sourceimpl InvolveQubits for SpinInteraction
impl InvolveQubits for SpinInteraction
Implements InvolveQubits trait for the qubits involved in this Operation.
sourcefn involved_qubits(&self) -> InvolvedQubits
fn involved_qubits(&self) -> InvolvedQubits
Returns a list of all involved qubits.
sourceimpl Operate for SpinInteraction
impl Operate for SpinInteraction
Implements the universal basic trait Operate for this Operation.
sourceimpl OperateGate for SpinInteraction
impl OperateGate for SpinInteraction
Trait for all Operations acting with a unitary gate on a set of qubits.
sourcefn unitary_matrix(&self) -> Result<Array2<Complex64>, RoqoqoError>
fn unitary_matrix(&self) -> Result<Array2<Complex64>, RoqoqoError>
Returns unitary matrix of the gate.
Returns
Ok(Array2<Complex64>)
- The unitary matrix representation of the gate.Err(RoqoqoError)
- The conversion of parameters to f64 failed.
sourceimpl OperateTwoQubit for SpinInteraction
impl OperateTwoQubit for SpinInteraction
Trait for Operations acting on exactly two qubits.
sourceimpl OperateTwoQubitGate for SpinInteraction
impl OperateTwoQubitGate for SpinInteraction
Trait for all gate operations acting on exactly two qubits.
sourcefn kak_decomposition(&self) -> KakDecomposition
fn kak_decomposition(&self) -> KakDecomposition
Returns KakDecomposition of the gate.
Returns
- struct
KakDecomposition { global_phase, k_vector, circuit_before, circuit_after }
sourceimpl PartialEq<SpinInteraction> for SpinInteraction
impl PartialEq<SpinInteraction> for SpinInteraction
sourcefn eq(&self, other: &SpinInteraction) -> bool
fn eq(&self, other: &SpinInteraction) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &SpinInteraction) -> bool
fn ne(&self, other: &SpinInteraction) -> bool
This method tests for !=
.
sourceimpl Serialize for SpinInteraction
impl Serialize for SpinInteraction
sourceimpl Substitute for SpinInteraction
impl Substitute for SpinInteraction
Implements Substitute trait allowing to replace symbolic parameters and to perform qubit mappings.
sourcefn substitute_parameters(
&self,
calculator: &mut Calculator
) -> Result<Self, RoqoqoError>
fn substitute_parameters(
&self,
calculator: &mut Calculator
) -> Result<Self, RoqoqoError>
Substitutes symbolic parameters in clone of the operation.
sourcefn remap_qubits(
&self,
mapping: &HashMap<usize, usize>
) -> Result<Self, RoqoqoError>
fn remap_qubits(
&self,
mapping: &HashMap<usize, usize>
) -> Result<Self, RoqoqoError>
Remaps the qubits in clone of the operation.
sourceimpl TryFrom<GateOperation> for SpinInteraction
impl TryFrom<GateOperation> for SpinInteraction
Implements the core::convert::TryFrom trait $\textit{into}$ this Operation.
sourceimpl TryFrom<Operation> for SpinInteraction
impl TryFrom<Operation> for SpinInteraction
Implements the core::convert::TryFrom trait $\textit{into}$ this Operation.
sourceimpl TryFrom<TwoQubitGateOperation> for SpinInteraction
impl TryFrom<TwoQubitGateOperation> for SpinInteraction
Implements the core::convert::TryFrom trait $\textit{into}$ this Operation.
sourceimpl TryFrom<TwoQubitOperation> for SpinInteraction
impl TryFrom<TwoQubitOperation> for SpinInteraction
Implements the core::convert::TryFrom trait $\textit{into}$ this Operation.
impl StructuralPartialEq for SpinInteraction
Auto Trait Implementations
impl RefUnwindSafe for SpinInteraction
impl Send for SpinInteraction
impl Sync for SpinInteraction
impl Unpin for SpinInteraction
impl UnwindSafe for SpinInteraction
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more