pairinteraction
A Rydberg Interaction Calculator
Data Structures | Public Member Functions | Friends
pairinteraction::KetPair< Scalar > Class Template Reference

#include <KetPair.hpp>

+ Inheritance diagram for pairinteraction::KetPair< Scalar >:
+ Collaboration diagram for pairinteraction::KetPair< Scalar >:

Data Structures

struct  hash
 

Public Member Functions

 KetPair (Private, std::initializer_list< size_t > atomic_indices, std::initializer_list< std::shared_ptr< const BasisAtom< Scalar > > > atomic_bases, real_t energy)
 
std::string get_label () const override
 
std::shared_ptr< KetPair< Scalar > > get_ket_for_different_quantum_number_m (real_t new_quantum_number_m) const
 
std::vector< std::shared_ptr< const BasisAtom< Scalar > > > get_atomic_states () const
 
bool operator== (const KetPair< Scalar > &other) const
 
bool operator!= (const KetPair< Scalar > &other) const
 
- Public Member Functions inherited from pairinteraction::Ket
 Ket ()=delete
 
virtual ~Ket ()=default
 
bool has_quantum_number_f () const
 
bool has_quantum_number_m () const
 
bool has_parity () const
 
double get_energy () const
 
double get_quantum_number_f () const
 
double get_quantum_number_m () const
 
Parity get_parity () const
 
virtual std::string get_label () const =0
 

Friends

class BasisPairCreator< Scalar >
 

Additional Inherited Members

- Protected Member Functions inherited from pairinteraction::Ket
 Ket (double energy, double f, double m, Parity p)
 
bool operator== (const Ket &other) const
 
- Protected Attributes inherited from pairinteraction::Ket
double energy
 
double quantum_number_f
 
double quantum_number_m
 
Parity parity
 

Detailed Description

template<typename Scalar>
class pairinteraction::KetPair< Scalar >

Definition at line 24 of file KetPair.hpp.

Constructor & Destructor Documentation

◆ KetPair()

template<typename Scalar >
pairinteraction::KetPair< Scalar >::KetPair ( Private  ,
std::initializer_list< size_t >  atomic_indices,
std::initializer_list< std::shared_ptr< const BasisAtom< Scalar > > >  atomic_bases,
real_t  energy 
)

Definition at line 16 of file KetPair.cpp.

Member Function Documentation

◆ get_atomic_states()

template<typename Scalar >
std::vector< std::shared_ptr< const BasisAtom< Scalar > > > pairinteraction::KetPair< Scalar >::get_atomic_states

Definition at line 54 of file KetPair.cpp.

◆ get_ket_for_different_quantum_number_m()

template<typename Scalar >
std::shared_ptr< KetPair< Scalar > > pairinteraction::KetPair< Scalar >::get_ket_for_different_quantum_number_m ( real_t  new_quantum_number_m) const

Definition at line 45 of file KetPair.cpp.

◆ get_label()

template<typename Scalar >
std::string pairinteraction::KetPair< Scalar >::get_label
overridevirtual

Implements pairinteraction::Ket.

Definition at line 30 of file KetPair.cpp.

◆ operator!=()

template<typename Scalar >
bool pairinteraction::KetPair< Scalar >::operator!= ( const KetPair< Scalar > &  other) const

Definition at line 70 of file KetPair.cpp.

◆ operator==()

template<typename Scalar >
bool pairinteraction::KetPair< Scalar >::operator== ( const KetPair< Scalar > &  other) const

Definition at line 64 of file KetPair.cpp.

References pairinteraction::Ket::operator==().

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ BasisPairCreator< Scalar >

template<typename Scalar >
friend class BasisPairCreator< Scalar >
friend

Definition at line 25 of file KetPair.hpp.

The documentation for this class was generated from the following files: