CHROMA
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Chroma::CreateSimpleFermState< T, P, Q > Class Template Reference

Create a simple ferm connection state. More...

#include <simple_fermstate.h>

Inheritance diagram for Chroma::CreateSimpleFermState< T, P, Q >:
Chroma::CreateFermState< T, P, Q > Chroma::CreateState< P, Q >

Public Member Functions

 CreateSimpleFermState (const multi1d< int > &boundary)
 Use only a SimpleFermBC with a boundary flag. More...
 
 CreateSimpleFermState (Handle< FermBC< T, P, Q > > fbc_)
 Full constructor. More...
 
 ~CreateSimpleFermState ()
 Destructor. More...
 
SimpleFermState< T, P, Q > * operator() (const Q &q) const
 Construct a ConnectState. More...
 
const FermBC< T, P, Q > & getBC () const
 Return the ferm BC object for this state. More...
 
Handle< FermBC< T, P, Q > > getFermBC () const
 Return the ferm BC object for this state. More...
 
- Public Member Functions inherited from Chroma::CreateFermState< T, P, Q >
virtual ~CreateFermState ()
 Virtual destructor to help with cleanup;. More...
 
- Public Member Functions inherited from Chroma::CreateState< P, Q >
virtual ~CreateState ()
 Virtual destructor to help with cleanup;. More...
 

Private Member Functions

 CreateSimpleFermState ()
 
void operator= (const CreateSimpleFermState &)
 

Private Attributes

Handle< FermBC< T, P, Q > > fbc
 

Detailed Description

template<typename T, typename P, typename Q>
class Chroma::CreateSimpleFermState< T, P, Q >

Create a simple ferm connection state.

This is a factory class for producing a connection state

Definition at line 71 of file simple_fermstate.h.

Constructor & Destructor Documentation

◆ CreateSimpleFermState() [1/3]

template<typename T , typename P , typename Q >
Chroma::CreateSimpleFermState< T, P, Q >::CreateSimpleFermState ( const multi1d< int > &  boundary)
inline

Use only a SimpleFermBC with a boundary flag.

Definition at line 75 of file simple_fermstate.h.

◆ CreateSimpleFermState() [2/3]

template<typename T , typename P , typename Q >
Chroma::CreateSimpleFermState< T, P, Q >::CreateSimpleFermState ( Handle< FermBC< T, P, Q > >  fbc_)
inline

Full constructor.

Definition at line 79 of file simple_fermstate.h.

◆ ~CreateSimpleFermState()

template<typename T , typename P , typename Q >
Chroma::CreateSimpleFermState< T, P, Q >::~CreateSimpleFermState ( )
inline

Destructor.

Definition at line 82 of file simple_fermstate.h.

◆ CreateSimpleFermState() [3/3]

template<typename T , typename P , typename Q >
Chroma::CreateSimpleFermState< T, P, Q >::CreateSimpleFermState ( )
inlineprivate

Definition at line 97 of file simple_fermstate.h.

Member Function Documentation

◆ getBC()

template<typename T , typename P , typename Q >
const FermBC<T,P,Q>& Chroma::CreateSimpleFermState< T, P, Q >::getBC ( ) const
inlinevirtual

Return the ferm BC object for this state.

Implements Chroma::CreateFermState< T, P, Q >.

Definition at line 91 of file simple_fermstate.h.

References Chroma::CreateSimpleFermState< T, P, Q >::fbc.

◆ getFermBC()

template<typename T , typename P , typename Q >
Handle< FermBC<T,P,Q> > Chroma::CreateSimpleFermState< T, P, Q >::getFermBC ( ) const
inlinevirtual

Return the ferm BC object for this state.

Implements Chroma::CreateFermState< T, P, Q >.

Definition at line 94 of file simple_fermstate.h.

References Chroma::CreateSimpleFermState< T, P, Q >::fbc.

◆ operator()()

template<typename T , typename P , typename Q >
SimpleFermState<T,P,Q>* Chroma::CreateSimpleFermState< T, P, Q >::operator() ( const Q q) const
inlinevirtual

Construct a ConnectState.

Implements Chroma::CreateFermState< T, P, Q >.

Definition at line 85 of file simple_fermstate.h.

References Chroma::CreateSimpleFermState< T, P, Q >::fbc, and q.

◆ operator=()

template<typename T , typename P , typename Q >
void Chroma::CreateSimpleFermState< T, P, Q >::operator= ( const CreateSimpleFermState< T, P, Q > &  )
inlineprivate

Definition at line 98 of file simple_fermstate.h.

Member Data Documentation

◆ fbc

template<typename T , typename P , typename Q >
Handle< FermBC<T,P,Q> > Chroma::CreateSimpleFermState< T, P, Q >::fbc
private

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