MuonCalib::IndexSet Class Reference

#include <IndexSet.h>

Collaboration diagram for MuonCalib::IndexSet:

Public Member Functions
	IndexSet ()
	default constructor: the number of indices is set to 0
	IndexSet (const unsigned int &r_nb_indices)
	constructor: the number of indices is set to r_nb_indices
	IndexSet (const unsigned int &r_nb_indices, const std::vector< int > &r_index)
	constructor: the number of indices is set to r_nb_indices, the vector r_index contains the indices
unsigned int	size () const
	get the number of indices
void	resize (const unsigned int &r_size)
	resize the index set to r_size; the index store is preserved as far as possible
int	operator[] (const unsigned int &r_k)
	:::::::::::::::::::::::
int	operator[] (const unsigned int &r_k) const
	access to the indices stored in the class, 0 <= r_k < size(); WARNING: no test on the index is performed
void	sort ()
	sort the indices in ascending order
bool	operator== (const IndexSet &r_index_set) const
bool	operator!= (const IndexSet &r_index_set) const
	comparison of two index sets; two index sets are considered equal if they are of the same size and their indices are the same at the same position [.

Private Member Functions
void	init ()
void	init (const unsigned int &r_nb_indices)
void	init (const unsigned int &r_nb_indices, const std::vector< int > &r_index)

Private Attributes
unsigned int	m_nb_indices
std::vector< int >	m_index

Detailed Description

Definition at line 40 of file IndexSet.h.

Constructor & Destructor Documentation

IndexSet() [1/3]

MuonCalib::IndexSet::IndexSet ( )

inline

default constructor: the number of indices is set to 0

Definition at line 57 of file IndexSet.h.

IndexSet() [2/3]

MuonCalib::IndexSet::IndexSet ( const unsigned int & r_nb_indices )

inline

constructor: the number of indices is set to r_nb_indices

Definition at line 60 of file IndexSet.h.

IndexSet() [3/3]

MuonCalib::IndexSet::IndexSet ( const unsigned int & r_nb_indices, const std::vector< int > & r_index )

inline

constructor: the number of indices is set to r_nb_indices, the vector r_index contains the indices

Definition at line 63 of file IndexSet.h.

Member Function Documentation

init() [1/3]

void IndexSet::init ( )

private

Definition at line 27 of file IndexSet.cxx.

                    {
    m_nb_indices = 0;
    return;
}

init() [2/3]

void IndexSet::init ( const unsigned int & r_nb_indices )

private

Definition at line 38 of file IndexSet.cxx.

                                                    {
    m_nb_indices = r_nb_indices;
    m_index = std::vector<int>(m_nb_indices);
    return;
}

init() [3/3]

void IndexSet::init ( const unsigned int & r_nb_indices, const std::vector< int > & r_index )

private

Definition at line 50 of file IndexSet.cxx.

                                                                                   {
    // CHECK VECTOR SIZE //
 
    if (r_index.size() < r_nb_indices) {
        throw std::runtime_error(Form("File: %s, Line: %d\nIndexSet::init() - Index vector too short!", __FILE__, __LINE__));
    }

    // INITIALIZATION //
 
    m_nb_indices = r_nb_indices;
    m_index = std::vector<int>(m_nb_indices);
    for (unsigned int k = 0; k < m_nb_indices; k++) {
        if (k < r_index.size()) {
            m_index[k] = r_index[k];
        } else {
            m_index[k] = 0;
        }
    }
 
    return;
}

operator!=()

bool IndexSet::operator!=

(

const IndexSet &

r_index_set

)

const

comparison of two index sets; two index sets are considered equal if they are of the same size and their indices are the same at the same position [.

]

Definition at line 164 of file IndexSet.cxx.

{ return !(*this == r_index_set); }

operator==()

bool IndexSet::operator==

(

const IndexSet &

r_index_set

)

const

Definition at line 148 of file IndexSet.cxx.

                                                         {
    if (r_index_set.size() != m_nb_indices) { return false; }
 
    for (unsigned int k = 0; k < m_nb_indices; k++) {
        if (m_index[k] != r_index_set[k]) { return false; }
    }
 
    return true;
}

operator[]() [1/2]

int IndexSet::operator[]

(

const unsigned int &

r_k

)

:::::::::::::::::::::::

Definition at line 121 of file IndexSet.cxx.

{ return m_index[r_k]; }

operator[]() [2/2]

int IndexSet::operator[]

(

const unsigned int &

r_k

)

const

access to the indices stored in the class, 0 <= r_k < size(); WARNING: no test on the index is performed

Definition at line 129 of file IndexSet.cxx.

{ return m_index[r_k]; }

resize()

void IndexSet::resize

(

const unsigned int &

r_size

)

resize the index set to r_size; the index store is preserved as far as possible

Definition at line 90 of file IndexSet.cxx.

                                                {
    //:::::::::::::::
    //:: VARIABLES ::
    //:::::::::::::::
 
    std::vector<int> aux_index = m_index;  // vector for temporary storage of
                                           // the indices
 
    //:::::::::::::::::::::::::::::::::::::
    //:: RESIZE AND COPY THE OLD INDICES ::
    //:::::::::::::::::::::::::::::::::::::
 
    m_index = std::vector<int>(r_size);
    for (unsigned int k = 0; k < r_size; k++) {
        if (k < m_nb_indices) {
            m_index[k] = aux_index[k];
        } else {
            m_index[k] = 0;
        }
    }
    m_nb_indices = r_size;
 
    return;
}

size()

unsigned int IndexSet::size

(

)

const

get the number of indices

Definition at line 82 of file IndexSet.cxx.

{ return m_nb_indices; }

sort()

void IndexSet::sort

(

)

sort the indices in ascending order

Definition at line 137 of file IndexSet.cxx.

                    {
    std::stable_sort(m_index.begin(), m_index.end());
    return;
}

Member Data Documentation

m_index

std::vector<int> MuonCalib::IndexSet::m_index

private

Definition at line 44 of file IndexSet.h.

m_nb_indices

unsigned int MuonCalib::IndexSet::m_nb_indices

private

Definition at line 43 of file IndexSet.h.

---

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

• IndexSet.h
• IndexSet.cxx