Pomerol::IndexCombination2 Struct Reference

A tuple-like combination of two single-particle indices. More...

#include <Index.hpp>

Public Member Functions
	IndexCombination2 (ParticleIndex Index1, ParticleIndex Index2)
bool	operator< (IndexCombination2 const &rhs) const
bool	operator== (IndexCombination2 const &rhs) const
bool	operator!= (IndexCombination2 const &rhs) const

Data Fields
ParticleIndex	Index1
	First single-particle index. More...
ParticleIndex	Index2
	Second single-particle index. More...

Friends
std::ostream &	operator<< (std::ostream &os, IndexCombination2 const &ic)

Detailed Description

A tuple-like combination of two single-particle indices.

Definition at line 30 of file Index.hpp.

Constructor & Destructor Documentation

IndexCombination2()

Pomerol::IndexCombination2::IndexCombination2 ( ParticleIndex  Index1, ParticleIndex  Index2  )

inline

Construct from two single-particle indices.

Parameters

[in]	Index1	First single-particle index.
[in]	Index2	Second single-particle index.

Definition at line 39 of file Index.hpp.

Member Function Documentation

operator!=()

bool Pomerol::IndexCombination2::operator!= ( IndexCombination2 const &  rhs ) const

inline

Unequal comparison operator for pairs of indices.

Parameters

[in]

rhs

Index combination object to compare to.

Definition at line 51 of file Index.hpp.

operator<()

bool Pomerol::IndexCombination2::operator< ( IndexCombination2 const &  rhs ) const

inline

Lexicographical less comparison operator for pairs of indices.

Parameters

[in]

rhs

Index combination object to compare to.

Definition at line 43 of file Index.hpp.

operator==()

bool Pomerol::IndexCombination2::operator== ( IndexCombination2 const &  rhs ) const

inline

Equal comparison operator for pairs of indices.

Parameters

[in]

rhs

Index combination object to compare to.

Definition at line 48 of file Index.hpp.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, IndexCombination2 const &  ic  )

friend

Output stream insertion operator.

Parameters

[out]	os	Output stream.
[in]	ic	Index combination to be inserted.

Returns

Reference to the output stream.

Definition at line 57 of file Index.hpp.

Field Documentation

Index1

ParticleIndex Pomerol::IndexCombination2::Index1

First single-particle index.

Definition at line 32 of file Index.hpp.

Index2

ParticleIndex Pomerol::IndexCombination2::Index2

Second single-particle index.

Definition at line 34 of file Index.hpp.

---

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

• pomerol/Index.hpp