AnalysisUtils::Combination< COLL > Class Template Reference

combination More...

#include <AnalysisCombination.h>

Collaboration diagram for AnalysisUtils::Combination< COLL >:

Public Member Functions
	Combination (COLL *coll, const unsigned int nElement)
	constructor
	~Combination ()
	destructor
void	reset ()
	reset internal indices
template<class OUT>
bool	get (OUT &comb)
	get a combination.
template<class CALLER, class OUT, class CRITERIA>
bool	goodOnes (CALLER *caller, OUT &comb, CRITERIA criteria)
	get a combination which passes a selection criteria
template<class OUT>
bool	get (OUT &comb, OUT &remain)
	get a combination and the remaining elements
template<class CALLER, class OUT, class CRITERIA>
bool	goodOnes (CALLER *caller, OUT &comb, OUT &remain, CRITERIA criteria)
	get a combination and the remaining elements.

Private Member Functions
bool	setNewIndex (int iElement)
	set new index recursively

Private Attributes
COLL *	m_coll
	collection
const unsigned int	m_nElement
	number of elements to be selected
std::vector< unsigned int >	m_index
	indices of elements
bool	m_first
	flag to check if first

Detailed Description

template<class COLL>
class AnalysisUtils::Combination< COLL >

combination

Definition at line 20 of file AnalysisCombination.h.

Constructor & Destructor Documentation

Combination()

template<class COLL>

Combination::Combination ( COLL * coll, const unsigned int nElement )

inline

constructor

Parameters

coll	[in] collection
nElement	[in] number of element to be selected

Definition at line 153 of file AnalysisCombination.h.

    : m_coll(coll), m_nElement(nElement), m_first(true)
  {
    // init indices
    //    internal indices are [0,1,2...] at beginning 
    for (unsigned int i=0; i<nElement; ++i)
      m_index.push_back(i);
  }

~Combination()

template<class COLL>

AnalysisUtils::Combination< COLL >::~Combination ( )

inline

destructor

Definition at line 32 of file AnalysisCombination.h.

{}

Member Function Documentation

get() [1/2]

template<class COLL>

template<class OUT>

bool AnalysisUtils::Combination< COLL >::get ( OUT & comb )

inline

get a combination.

internal indices are incremented

Parameters

comb	[out] combination of elements

Returns

true:success false:end of selection

Definition at line 43 of file AnalysisCombination.h.

    {
      // init returned combination
      comb.clear();
      
      if (m_first) {
    if (m_index[m_nElement-1] >= m_coll->size()) return false;
    m_first = false;
      } else {
    // increment indices
    if (!setNewIndex(m_nElement-1)) return false;
      }
      
      // assign to returned combination
      for (unsigned int i=0; i<m_nElement; ++i)
    comb.push_back((*m_coll)[m_index[i]]);
      
      return true;
    }

get() [2/2]

template<class COLL>

template<class OUT>

bool AnalysisUtils::Combination< COLL >::get ( OUT & comb, OUT & remain )

inline

get a combination and the remaining elements

Definition at line 85 of file AnalysisCombination.h.

    {
      // init returned vector
      remain.clear();
 
      bool ret = get(comb);
      if (!ret) return false;
 
      // assigin to remain
      unsigned int sIndex = 0;
      std::vector<unsigned int>::const_iterator it  = m_index.begin();
      std::vector<unsigned int>::const_iterator itE = m_index.end();
      for (; ; ++it)
    {
      unsigned int eIndex;
      if (it!=itE)
        eIndex = *it;
      else
        eIndex = m_coll->size();
 
      for (unsigned int i=sIndex; i<eIndex; ++i)
        remain.push_back((*m_coll)[i]);
      sIndex = eIndex+1;
 
      if (it == itE) break;
    }
 
      return true;
    }

goodOnes() [1/2]

template<class COLL>

template<class CALLER, class OUT, class CRITERIA>

bool AnalysisUtils::Combination< COLL >::goodOnes ( CALLER * caller, OUT & comb, CRITERIA criteria )

inline

get a combination which passes a selection criteria

Parameters

caller
comb	[out] combination of elements
criteria	[in] a function pointer of selection criteria

Returns

true:success false:end of selection

Definition at line 70 of file AnalysisCombination.h.

    {
      bool ret = get(comb);
      if (!ret) return false;
 
      // check if this passes the criteria
      if (criteria(caller, comb)) return true;
 
      // if not, look for next combination
      return goodOnes(caller, comb, criteria);
    }

goodOnes() [2/2]

template<class COLL>

template<class CALLER, class OUT, class CRITERIA>

bool AnalysisUtils::Combination< COLL >::goodOnes ( CALLER * caller, OUT & comb, OUT & remain, CRITERIA criteria )

inline

get a combination and the remaining elements.

the combination passes a selection criteria

Definition at line 119 of file AnalysisCombination.h.

    {
      bool ret = get(comb, remain);
      if (!ret) return false;
 
      // check if this passes the criteria
      if (criteria(caller, comb)) return true;
 
      // if not, look for next combination
      return goodOnes(caller, comb, remain, criteria);
    }

reset()

template<class COLL>

void Combination::reset ( )

inline

reset internal indices

Definition at line 162 of file AnalysisCombination.h.

  {
    // reset indices
    m_index.clear();
    for (unsigned int i=0; i<m_nElement; ++i)
      m_index.push_back(i);
 
    // set first flag
    m_first = true;
  }

setNewIndex()

template<class COLL>

bool Combination::setNewIndex ( int iElement )

inlineprivate

set new index recursively

Definition at line 174 of file AnalysisCombination.h.

  {
    if (iElement < 0) return false;
    
    if (iElement+1 == static_cast<int>(m_nElement))
      {
    if ((m_index[iElement]+1) < m_coll->size())
      {
        ++(m_index[iElement]);
        return true;
      }
      }
    else
      {
    if ((m_index[iElement]+1) < m_index[iElement+1])
      {
        ++(m_index[iElement]);
        return true;
      }
      }
    
    if (setNewIndex (iElement-1))
      {
    m_index[iElement] = m_index[iElement-1]+1;
    return true;
      }
    
    return false;
  }

Member Data Documentation

m_coll

template<class COLL>

COLL* AnalysisUtils::Combination< COLL >::m_coll

private

collection

Definition at line 134 of file AnalysisCombination.h.

m_first

template<class COLL>

bool AnalysisUtils::Combination< COLL >::m_first

private

flag to check if first

Definition at line 143 of file AnalysisCombination.h.

m_index

template<class COLL>

std::vector<unsigned int> AnalysisUtils::Combination< COLL >::m_index

private

indices of elements

Definition at line 140 of file AnalysisCombination.h.

m_nElement

template<class COLL>

const unsigned int AnalysisUtils::Combination< COLL >::m_nElement

private

number of elements to be selected

Definition at line 137 of file AnalysisCombination.h.

---

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

• AnalysisCombination.h