#include <Combination.h>

Collaboration diagram for MuonCalib::Combination:

Public Member Functions
	Combination ()
	Default construcor. A combination of 1 out of 1 is created.
	Combination (const unsigned int &n, const unsigned int &k)
	Constructor.
unsigned int	numberOfElements () const
	get the number of elements
unsigned int	whichClass () const
	get the class of which the combination is
unsigned int	numberOfCombinations () const
	get the number of combinations
void	currentCombination (std::vector< unsigned int > &index_array) const
	get the current combination; the result is stored in the vector index_array
void	nextCombination (std::vector< unsigned int > &index_array)
	get the next combination; the results is stored in the array index_array
void	reset ()
	go back to the first combination
void	setNewParameters (const unsigned int &nb_elements, const unsigned int &wh_class)
	set the number of elements = nb_elements; set the class of which the combination is = wh_class

Private Member Functions
void	init (const unsigned int &n, const unsigned int &k)

Private Attributes
unsigned int	m_n = 0U
unsigned int	m_k = 0U
std::vector< unsigned int >	m_index
std::vector< unsigned int >	m_flag

Detailed Description

Definition at line 33 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/MuonCalibMath/Combination.h.

Constructor & Destructor Documentation

◆ Combination() [1/2]

Combination::Combination ( )

Default construcor. A combination of 1 out of 1 is created.

Definition at line 20 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/src/Combination.cxx.

                         {
 
    init(1,1);
 
}

◆ Combination() [2/2]

Combination::Combination	(	const unsigned int &	n,
		const unsigned int &	k )

Constructor.

Parameters

n	Number of elements.
k	Class of the combination.

Definition at line 32 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/src/Combination.cxx.

                                                                       {
 
    init(n, k);
 
}

Member Function Documentation

◆ currentCombination()

void Combination::currentCombination ( std::vector< unsigned int > & index_array ) const

get the current combination; the result is stored in the vector index_array

Definition at line 125 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/src/Combination.cxx.

                                                         {
 
    if (index_array.size()<m_k) {
        index_array = std::vector<unsigned int>(m_k);
    }
    for (unsigned int j=0; j<m_k; j++) {
        index_array[j] = m_index[j];
    }
 
    return;
 
}

◆ init()

void Combination::init	(	const unsigned int &	n,
		const unsigned int &	k )

private

Definition at line 44 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/src/Combination.cxx.

                                                                     {
// CHECK IF k<=n //
 
    if (k>n) {
        throw std::runtime_error(Form("File: %s, Line: %d\nCombination::init() - error, class number greater than number of elements!", __FILE__, __LINE__));
    }
// ALLOCATE MEMORY //
 
    m_k = k;
    m_n = n;
    m_index = std::vector<unsigned int>(m_k);
    m_flag = std::vector<unsigned int>(m_k);
// SETUP START CONFIGURATION //
 
    reset();
 
    return;
 
}

◆ nextCombination()

void Combination::nextCombination ( std::vector< unsigned int > & index_array )

get the next combination; the results is stored in the array index_array

Definition at line 145 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/src/Combination.cxx.

                                                                       {
// VARIABLES //
 
    int loc_flag; // local flag
// CHECK SIZE OF index_array//
 
    if (index_array.size()<m_k) {
        index_array = std::vector<unsigned int>(m_k);
    }
// CHECK FLAGS //
 
    for (unsigned int j=0; j<m_k; j++) {
        if (m_index[j] == (m_n-(m_k-j-1))) {
            m_flag[j] = 1;
        }
    }
    if (m_flag[0] == 1) {
        reset();
        currentCombination(index_array);
        return;
    }
    loc_flag = 0;
    for (unsigned int j=1; j<m_k; j++) {
        if (m_flag[j] == 1) {
            m_index[j-1] = m_index[j-1]+1;
            for (unsigned int l=j; l<m_k; l++) {
                m_index[l] = m_index[l-1]+1;
            }
            loc_flag = 1;
            break;
        }
    }
    if (loc_flag == 0) {
        m_index[m_k-1] = m_index[m_k-1]+1;
    }
    for (unsigned int j=0; j<m_k; j++) {
        if (m_index[j] == (m_n-(m_k-j-1))) {
            m_flag[j] = 1;
        }
        else {
            m_flag[j] = 0;
        }
        index_array[j] = m_index[j];
    }
// RETURN THE DESIRED COMBINATION //
 
    return;
 
}

◆ numberOfCombinations()

unsigned int Combination::numberOfCombinations ( ) const

get the number of combinations

Definition at line 103 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/src/Combination.cxx.

                                                     {
// VARIABLES //
 
    int ncomb = TMath::Binomial(m_n, m_k);
// RETURN THE NUMBER OF COMBINATIONS //
 
    return ncomb;
 
}

◆ numberOfElements()

unsigned int Combination::numberOfElements ( ) const

get the number of elements

Definition at line 79 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/src/Combination.cxx.

                                                 {
 
    return m_n;
 
}

◆ reset()

void Combination::reset ( )

go back to the first combination

Definition at line 213 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/src/Combination.cxx.

                        {
 
    for (unsigned int j=0; j<m_k; j++) {
        m_index[j] = j+1;
        m_flag[j] = 0;
    }
 
    return;
 
}

◆ setNewParameters()

void Combination::setNewParameters	(	const unsigned int &	nb_elements,
		const unsigned int &	wh_class )

set the number of elements = nb_elements; set the class of which the combination is = wh_class

Definition at line 230 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/src/Combination.cxx.

                                                   {
 
    init(nb_elements, wh_class);
 
    return;
 
}

◆ whichClass()

unsigned int Combination::whichClass ( ) const

get the class of which the combination is

Definition at line 91 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/src/Combination.cxx.

                                           {
 
    return m_k;
 
}

Member Data Documentation

◆ m_flag

std::vector<unsigned int> MuonCalib::Combination::m_flag

private

Definition at line 74 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/MuonCalibMath/Combination.h.

◆ m_index

std::vector<unsigned int> MuonCalib::Combination::m_index

private

Definition at line 72 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/MuonCalibMath/Combination.h.

◆ m_k

unsigned int MuonCalib::Combination::m_k = 0U

private

Definition at line 71 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/MuonCalibMath/Combination.h.

◆ m_n

unsigned int MuonCalib::Combination::m_n = 0U

private

Definition at line 70 of file MuonSpectrometer/MuonCalib/MuonCalibUtils/MuonCalibMath/MuonCalibMath/Combination.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Combination() [1/2]

◆ Combination() [2/2]

Member Function Documentation

◆ currentCombination()

◆ init()

◆ nextCombination()

◆ numberOfCombinations()

◆ numberOfElements()

◆ reset()

◆ setNewParameters()

◆ whichClass()

Member Data Documentation

◆ m_flag

◆ m_index

◆ m_k

◆ m_n