Loading...
Searching...
No Matches
q3::QuantumState< WavefunctionType > Struct Template Reference

#include <quantum_state.hpp>

Public Member Functions

bool is_occupied () const
 Whether this state is occupied.
 

Public Attributes

Real eigenvalue = 0.0
 Energy eigenvalue in Rydberg.
 
Real occupation = 0.0
 Occupation number (0.0 to 1.0 per spin channel).
 
WavefunctionType wavefunction
 The wavefunction (representation-specific).
 

Detailed Description

template<typename WavefunctionType>
struct q3::QuantumState< WavefunctionType >

A single quantum state: wavefunction + eigenvalue + occupation.

Definition at line 19 of file quantum_state.hpp.

Member Function Documentation

◆ is_occupied()

template<typename WavefunctionType >
bool q3::QuantumState< WavefunctionType >::is_occupied ( ) const
inline

Whether this state is occupied.

Definition at line 30 of file quantum_state.hpp.

References q3::QuantumState< WavefunctionType >::occupation.

Member Data Documentation

◆ eigenvalue

template<typename WavefunctionType >
Real q3::QuantumState< WavefunctionType >::eigenvalue = 0.0

Energy eigenvalue in Rydberg.

Definition at line 24 of file quantum_state.hpp.

◆ occupation

template<typename WavefunctionType >
Real q3::QuantumState< WavefunctionType >::occupation = 0.0

Occupation number (0.0 to 1.0 per spin channel).

Definition at line 27 of file quantum_state.hpp.

Referenced by q3::QuantumState< WavefunctionType >::is_occupied().

◆ wavefunction

template<typename WavefunctionType >
WavefunctionType q3::QuantumState< WavefunctionType >::wavefunction

The wavefunction (representation-specific).

Definition at line 21 of file quantum_state.hpp.


The documentation for this struct was generated from the following file: