TBTK
TBTK::HoppingAmplitudeTree::Iterator Class Reference

#include <HoppingAmplitudeTree.h>

Public Member Functions

 Iterator (const Iterator &iterator)
 
 Iterator (Iterator &&iterator)
 
 Iterator (const HoppingAmplitudeTree *tree)
 
Iteratoroperator= (const Iterator &rhs)
 
Iteratoroperator= (Iterator &&rhs)
 
void reset ()
 
void searchNextHA ()
 
const HoppingAmplitudegetHA () const
 
int getMinBasisIndex () const
 
int getMaxBasisIndex () const
 
int getNumBasisIndices () const
 

Public Attributes

const HoppingAmplitudeTreetree
 
std::vector< int > currentIndex
 
int currentHoppingAmplitude
 

Detailed Description

Iterator for iterating through HoppingAmplitudes stored in the tree structure.

Constructor & Destructor Documentation

TBTK::HoppingAmplitudeTree::Iterator::Iterator ( const Iterator iterator)

Copy constructor.

TBTK::HoppingAmplitudeTree::Iterator::Iterator ( Iterator &&  iterator)

Move constructor.

TBTK::HoppingAmplitudeTree::Iterator::Iterator ( const HoppingAmplitudeTree tree)

Constructor.

Member Function Documentation

const HoppingAmplitude* TBTK::HoppingAmplitudeTree::Iterator::getHA ( ) const

Get HoppingAmplitude currently pointed at.

int TBTK::HoppingAmplitudeTree::Iterator::getMaxBasisIndex ( ) const

Get maximum basis index.

int TBTK::HoppingAmplitudeTree::Iterator::getMinBasisIndex ( ) const

Get minimum basis index.

int TBTK::HoppingAmplitudeTree::Iterator::getNumBasisIndices ( ) const

Get number of basis indices.

Iterator& TBTK::HoppingAmplitudeTree::Iterator::operator= ( const Iterator rhs)

Assignment operator.

Iterator& TBTK::HoppingAmplitudeTree::Iterator::operator= ( Iterator &&  rhs)

Move assignment operator.

void TBTK::HoppingAmplitudeTree::Iterator::reset ( )

Reset iterator.

void TBTK::HoppingAmplitudeTree::Iterator::searchNextHA ( )

Advance the iterator by one.

Member Data Documentation

int TBTK::HoppingAmplitudeTree::Iterator::currentHoppingAmplitude

Current HoppingAmplitude that the iterator points at at the currentIndex.

std::vector<int> TBTK::HoppingAmplitudeTree::Iterator::currentIndex

Current index at which the iterator points at.

const HoppingAmplitudeTree* TBTK::HoppingAmplitudeTree::Iterator::tree

Root node to iterate from.


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