Pomerol::IndexCombination4 Struct Reference

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

#include <Index.hpp>

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

Data Fields
ParticleIndex	Index1
	First single-particle index. More...
ParticleIndex	Index2
	Second single-particle index. More...
ParticleIndex	Index3
	Third single-particle index. More...
ParticleIndex	Index4
	Fourth single-particle index. More...

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

Detailed Description

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

Definition at line 63 of file Index.hpp.

Constructor & Destructor Documentation

IndexCombination4()

Pomerol::IndexCombination4::IndexCombination4 ( ParticleIndex  Index1, ParticleIndex  Index2, ParticleIndex  Index3, ParticleIndex  Index4  )

inline

Construct from four single-particle indices.

Parameters

[in]	Index1	First single-particle index.
[in]	Index2	Second single-particle index.
[in]	Index3	Third single-particle index.
[in]	Index4	Fourth single-particle index.

Definition at line 78 of file Index.hpp.

Member Function Documentation

operator!=()

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

inline

Unequal comparison operator for 4-tuples of indices.

Parameters

[in]

rhs

Index combination object to compare to.

Definition at line 94 of file Index.hpp.

operator<()

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

inline

Lexicographical less comparison operator for 4-tuples of indices.

Parameters

[in]

rhs

Index combination object to compare to.

Definition at line 83 of file Index.hpp.

operator==()

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

inline

Equal comparison operator for 4-tuples of indices.

Parameters

[in]

rhs

Index combination object to compare to.

Definition at line 89 of file Index.hpp.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, IndexCombination4 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 100 of file Index.hpp.

Field Documentation

Index1

ParticleIndex Pomerol::IndexCombination4::Index1

First single-particle index.

Definition at line 65 of file Index.hpp.

Index2

ParticleIndex Pomerol::IndexCombination4::Index2

Second single-particle index.

Definition at line 67 of file Index.hpp.

Index3

ParticleIndex Pomerol::IndexCombination4::Index3

Third single-particle index.

Definition at line 69 of file Index.hpp.

Index4

ParticleIndex Pomerol::IndexCombination4::Index4

Fourth single-particle index.

Definition at line 71 of file Index.hpp.

---

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

• pomerol/Index.hpp