Skip to main content

WignerFunction

Struct WignerFunction 

Source
pub struct WignerFunction {
    pub state_description: String,
    pub grid_values: Vec<(f64, f64, f64)>,
    pub hbar: f64,
}
Expand description

The Wigner quasi-probability distribution for a quantum state.

The Wigner function W_ρ(q, p) is the Weyl transform of the density matrix ρ: W_ρ(q, p) = (1/πℏ) ∫ ⟨q+y|ρ|q-y⟩ e^{2ipy/ℏ} dy. It is a real-valued function (not necessarily non-negative) on phase space ℝ².

Fields§

§state_description: String

Description of the quantum state.

§grid_values: Vec<(f64, f64, f64)>

Sample values W(q_i, p_i) at a grid of phase space points (q, p, W).

§hbar: f64

Planck constant ℏ used in the definition.

Implementations§

Source§

impl WignerFunction

Source

pub fn new(state_description: impl Into<String>) -> Self

Construct an empty Wigner function for the named state.

Source

pub fn with_hbar(self, hbar: f64) -> Self

Set the Planck constant ℏ.

Source

pub fn is_normalized(&self) -> bool

The Wigner function integrates to 1 over all of phase space: ∫ W dq dp = 1.

Source

pub fn lower_bound(&self) -> f64

The Wigner function satisfies the uncertainty bound: W_ρ ≥ -1/(πℏ).

Source

pub fn approximate_purity(&self) -> f64

Compute the approximate purity Tr(ρ²) = (2πℏ) ∫ W² dq dp from grid data.

Trait Implementations§

Source§

impl Clone for WignerFunction

Source§

fn clone(&self) -> WignerFunction

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WignerFunction

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.