JTOOLS::JCombinatorics Class Reference

Auxiliary class to convert pair of indices to unique index and back. More...

#include <JCombinatorics.hh>

Inheritance diagram for JTOOLS::JCombinatorics:

Public Types
typedef std::pair< int, int >	pair_type
	Data structure for a pair of indices. More...

Public Member Functions
	JCombinatorics ()
	Default constructor. More...
	JCombinatorics (const int numberOfIndices)
	Constructor. More...
void	configure (const int numberOfIndices)
	Configure. More...
unsigned int	getNumberOfIndices () const
	Get number of indices. More...
unsigned int	getNumberOfPairs () const
	Get number of pairs. More...
int	getIndex (const int first, const int second) const
	Get index of pair of indices. More...
const pair_type &	getPair (const int index) const
	Get pair of indices for given index. More...
template<class JComparator_t >
void	sort (JComparator_t comparator)
	Sort address pairs. More...

Static Public Member Functions
static int	getSign (const int first, const int second)
	Sign of pair of indices. More...
static int	getSign (const pair_type &pair)
	Sign of pair of indices. More...

Protected Attributes
std::vector< pair_type >	zbuf1D
std::vector< std::vector< int > >	zbuf2D

Detailed Description

Auxiliary class to convert pair of indices to unique index and back.

Definition at line 22 of file JCombinatorics.hh.

Member Typedef Documentation

typedef std::pair<int, int> JTOOLS::JCombinatorics::pair_type

Data structure for a pair of indices.

Definition at line 28 of file JCombinatorics.hh.

Constructor & Destructor Documentation

JTOOLS::JCombinatorics::JCombinatorics ( )

inline

Default constructor.

Definition at line 34 of file JCombinatorics.hh.

    {}

JTOOLS::JCombinatorics::JCombinatorics ( const int  numberOfIndices )

inline

Constructor.

Parameters

numberOfIndices

number of indices

Definition at line 43 of file JCombinatorics.hh.

    {
      configure(numberOfIndices);
    }

Member Function Documentation

void JTOOLS::JCombinatorics::configure ( const int  numberOfIndices )

inline

Configure.

Parameters

numberOfIndices

number of indices

Definition at line 54 of file JCombinatorics.hh.

    {
      zbuf1D.clear();

      zbuf2D.resize(numberOfIndices);

      for (int i = 0; i != numberOfIndices; ++i) {
        zbuf2D[i].resize(numberOfIndices);
      }

      for (int i = 0; i != numberOfIndices; ++i) {

        zbuf2D[i][i] = -1;

        for (int j = i; ++j != numberOfIndices; ) {

          zbuf2D[i][j] = zbuf1D.size();
          zbuf2D[j][i] = zbuf1D.size();

          zbuf1D.push_back(pair_type(i,j));
        }
      }
    }

unsigned int JTOOLS::JCombinatorics::getNumberOfIndices ( ) const

inline

Get number of indices.

Returns

number of indices

Definition at line 84 of file JCombinatorics.hh.

    {
      return zbuf2D.size();
    }

unsigned int JTOOLS::JCombinatorics::getNumberOfPairs ( ) const

inline

Get number of pairs.

Returns

number of pairs

Definition at line 95 of file JCombinatorics.hh.

    {
      return zbuf1D.size();
    }

int JTOOLS::JCombinatorics::getIndex ( const int  first, const int  second  ) const

inline

Get index of pair of indices.

Parameters

first	first address
second	second address

Returns

index (-1 if first and second address are equal)

Definition at line 108 of file JCombinatorics.hh.

    {
      return zbuf2D[first][second];
    }

const pair_type& JTOOLS::JCombinatorics::getPair ( const int  index ) const

inline

Get pair of indices for given index.

Parameters

index

index

Returns

pair of indices

Definition at line 120 of file JCombinatorics.hh.

    {
      return zbuf1D[index];
    }

template<class JComparator_t >

void JTOOLS::JCombinatorics::sort ( JComparator_t  comparator )

inline

Sort address pairs.

Parameters

comparator

comparator for pairs

Definition at line 132 of file JCombinatorics.hh.

    {
      std::stable_sort(zbuf1D.begin(), zbuf1D.end(), comparator);

      for (int i = 0; i != (int) zbuf1D.size(); ++i) {
        
        const pair_type pair = zbuf1D[i];

        zbuf2D[pair.first][pair.second] = i;
        zbuf2D[pair.second][pair.first] = i;
      }

      for (int i = 0; i != (int) zbuf2D.size(); ++i) {
        zbuf2D[i][i] = -1;
      }
    }

static int JTOOLS::JCombinatorics::getSign ( const int  first, const int  second  )

inlinestatic

Sign of pair of indices.

Parameters

first	first address
second	second address

Returns

+1 if second >= first; else -1

Definition at line 157 of file JCombinatorics.hh.

    {
      return (second >= first ? +1 : -1);
    }

static int JTOOLS::JCombinatorics::getSign ( const pair_type &  pair )

inlinestatic

Sign of pair of indices.

Parameters

pair	pair of indices

Returns

+1 if second >= first; else -1

Definition at line 169 of file JCombinatorics.hh.

    {
      return getSign(pair.first, pair.second);
    }

Member Data Documentation

std::vector<pair_type> JTOOLS::JCombinatorics::zbuf1D

protected

Definition at line 176 of file JCombinatorics.hh.

std::vector<std::vector<int> > JTOOLS::JCombinatorics::zbuf2D

protected

Definition at line 177 of file JCombinatorics.hh.

---

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

• JCombinatorics.hh