Struct brakets::Ket

pub struct Ket<D: DimName>(_)
 where
    DefaultAllocator: Allocator<Complex, D>;

Generic ket. You can multiply it by bra to an outer product (or operator).

Methods

impl<D: DimName> Ket<D> where
    DefaultAllocator: Allocator<Complex, D>, 

pub fn up() -> Ket<U2>

Up 2-dimension ket, [1, 0]

pub fn down() -> Ket<U2>

Down 2-dimension ket, [0, 1]

pub fn right() -> Ket<U2>

Right 2-dimension ket, 1/√2[1, 1]

pub fn left() -> Ket<U2>

Left 2-dimension ket, 1/√2[1, -1]

pub fn inw() -> Ket<U2>

Inward 2-dimension ket, 1/√2[1, i]

pub fn out() -> Ket<U2>

Outward 2-dimension ket, 1/√2[1, -i]

pub fn cross(self, other: Ket<D>) -> Ket<DimNameProd<D, D>> where
    D: DimNameMul<D>,
    DefaultAllocator: Allocator<Complex, DimNameProd<D, D>>, 

Kronecker (tensor) product of two kets

For qubits, it's possible to produce only 2 qubits state with this product.

pub fn from_bits(number: u16) -> Result<Ket<D>, &'static str>

Cross product of basis (|up> & |down>) qubits picked from a bit string.

Trait Implementations

impl<D: DimName> From<Ket<D>> for Bra<D> where
    DefaultAllocator: Allocator<Complex, D> + Allocator<Complex, D, D> + Allocator<Complex, U1, D>, 

fn from(v: Ket<D>) -> Self

Performs the conversion.

impl<D: DimName> From<Bra<D>> for Ket<D> where
    DefaultAllocator: Allocator<Complex, D> + Allocator<Complex, D, D> + Allocator<Complex, U1, D>, 

fn from(v: Bra<D>) -> Self

Performs the conversion.

impl<D: DimName> From<Matrix<Complex<f64>, D, U1, <DefaultAllocator as Allocator<Complex<f64>, D, U1>>::Buffer>> for Ket<D> where
    DefaultAllocator: Allocator<Complex, D>, 

fn from(v: VectorN<Complex, D>) -> Self

Performs the conversion.

impl<D: PartialEq + DimName> PartialEq<Ket<D>> for Ket<D> where
    DefaultAllocator: Allocator<Complex, D>, 

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

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

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

This method tests for !=.

impl<D: Clone + DimName> Clone for Ket<D> where
    DefaultAllocator: Allocator<Complex, D>, 

fn clone(&self) -> Ket<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: DimName> Display for Ket<D> where
    DefaultAllocator: Allocator<Complex, D>,
    DefaultAllocator: Allocator<usize, D>, 

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

Formats the value using the given formatter.

impl<D: Debug + DimName> Debug for Ket<D> where
    DefaultAllocator: Allocator<Complex, D>, 

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

Formats the value using the given formatter.

impl<D: DimName> Add<Ket<D>> for Ket<D> where
    DefaultAllocator: Allocator<Complex, D>, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Ket<D>) -> Self::Output

Performs the + operation.

impl<D: DimName> Mul<Ket<D>> for Bra<D> where
    DefaultAllocator: Allocator<Complex, D> + Allocator<Complex, U1, D>, 

type Output = Complex

The resulting type after applying the * operator.

fn mul(self, other: Ket<D>) -> Self::Output

Performs the * operation.

impl<D: DimName> Mul<Bra<D>> for Ket<D> where
    DefaultAllocator: Allocator<Complex, D> + Allocator<Complex, D, D> + Allocator<Complex, U1, D>, 

type Output = Outer<D>

The resulting type after applying the * operator.

fn mul(self, other: Bra<D>) -> Self::Output

Performs the * operation.

impl<D: DimName> Mul<Complex<f64>> for Ket<D> where
    DefaultAllocator: Allocator<Complex, D, U1>, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Complex) -> Self::Output

Performs the * operation.

impl<D: DimName> Mul<Ket<D>> for Outer<D> where
    DefaultAllocator: Allocator<Complex, D> + Allocator<Complex, D, D>, 

type Output = Ket<D>

The resulting type after applying the * operator.

fn mul(self, other: Ket<D>) -> Self::Output

Performs the * operation.