Skip to main content

PhotonBasis

Struct PhotonBasis 

Source
pub struct PhotonBasis<Matter>
where Matter: Basis, Matter::State: Hash,
{ /* private fields */ }
Expand description

Matter basis tensored with one truncated photon mode, optionally at fixed total excitation number.

Implementations§

Source§

impl<Matter> PhotonBasis<Matter>
where Matter: Basis, Matter::State: Hash + 'static,

Source

pub fn new(matter: Matter, photon: BosonBasis1D) -> Result<Self>

Source

pub fn fixed_total_excitations<F>( matter: Matter, photon: BosonBasis1D, total: usize, matter_excitations: F, ) -> Result<Self>
where F: Fn(Matter::State) -> usize,

Source

pub const fn total_excitations(&self) -> Option<usize>

Source

pub fn matter(&self) -> &Matter

Source

pub fn photon(&self) -> &BosonBasis1D

Trait Implementations§

Source§

impl<Matter> Basis for PhotonBasis<Matter>
where Matter: Basis, Matter::State: Hash + 'static,

Source§

type State = (<Matter as Basis>::State, u128)

Integer-like state representation used by this basis.
Source§

fn len(&self) -> usize

Return the number of vectors in the basis.
Source§

fn state(&self, index: usize) -> Result<Self::State>

Return the encoded state at a basis index. Read more
Source§

fn index(&self, state: Self::State) -> Result<usize>

Locate an encoded state in the basis.
Source§

fn apply_local( &self, state: Self::State, operator: &str, sites: &[usize], ) -> Result<Option<(Self::State, Complex64)>>

Apply one local operator string to one encoded state. Read more
Source§

fn apply_local_transitions( &self, state: Self::State, operator: &str, sites: &[usize], ) -> Result<LocalTransitions<Self::State>>

Applies a local operator and returns every nonzero destination. Read more
Source§

fn visit_local_unreduced_transitions<F>( &self, state: Self::State, operator: &str, sites: &[usize], visit: F, ) -> Result<()>
where F: FnMut(Self::State, Complex64) -> Result<()>,

Streams unreduced destinations directly to a consumer. Read more
Source§

fn operator_preserves_particle_sector(&self, operator: &str) -> Result<bool>

Whether a local operator string preserves the particle-sector constraints represented by this basis. Unconstrained and custom bases accept every syntactically valid string by default.
Source§

fn apply_local_unreduced_transitions( &self, state: Self::State, operator: &str, sites: &[usize], ) -> Result<LocalTransitions<Self::State>>

Local action before symmetry-sector reduction. Cross-sector builders use this path and let the target basis perform the reduction.
Source§

fn transition_orbit_size(&self, _state: Self::State) -> Result<usize>

Orbit size of a canonical source state used in projector normalization.
Source§

fn reduction_image( &self, state: Self::State, ) -> Result<Option<ReductionImage<Self::State>>>

Return the canonical reduction metadata for a physical state. Read more
Source§

fn reduce_transition( &self, state: Self::State, source_orbit_size: usize, ) -> Result<Option<(Self::State, Complex64)>>

Map an unreduced physical target state into this basis.
Source§

fn index_transition( &self, state: Self::State, source_orbit_size: usize, ) -> Result<Option<(usize, Complex64)>>

Reduces a physical target and locates its row in one operation. Read more
Source§

fn operator_preserves_particle_sector_on_sites( &self, operator: &str, _sites: &[usize], ) -> Result<bool>

Site-aware particle-sector check for bases whose local labels encode species as well as position. Read more
Source§

fn is_empty(&self) -> bool

Return whether the basis contains no vectors.

Auto Trait Implementations§

§

impl<Matter> Freeze for PhotonBasis<Matter>
where Matter: Freeze,

§

impl<Matter> RefUnwindSafe for PhotonBasis<Matter>
where Matter: RefUnwindSafe, <Matter as Basis>::State: RefUnwindSafe,

§

impl<Matter> Send for PhotonBasis<Matter>

§

impl<Matter> Sync for PhotonBasis<Matter>

§

impl<Matter> Unpin for PhotonBasis<Matter>
where Matter: Unpin, <Matter as Basis>::State: Unpin,

§

impl<Matter> UnsafeUnpin for PhotonBasis<Matter>
where Matter: UnsafeUnpin,

§

impl<Matter> UnwindSafe for PhotonBasis<Matter>
where Matter: UnwindSafe, <Matter as Basis>::State: UnwindSafe,

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

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> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,