edm::helper::IndexRangeAssociation Class Reference

#include <MultiAssociation.h>

Classes
class	FastFiller
struct	IDComparator

Public Types
typedef std::pair< unsigned int, unsigned int >	range

Public Member Functions
bool	contains (ProductID id) const
	True if this IndexRangeAssociation has info for this product id. More...
bool	empty () const
	True if it's empty (no keys) More...
range	get (const edm::ProductID &id, unsigned int t) const
	IndexRangeAssociation ()
template<typename RefKey >
range	operator[] (const RefKey &r) const
unsigned int	size () const
	Size of this collection (number of keys) More...
void	swap (IndexRangeAssociation &other)

Static Public Member Functions
static void	throwUnexpectedProductID (ProductID found, ProductID expected, const char *where)

Private Types
typedef std::pair < edm::ProductID, unsigned int >	id_off_pair
typedef std::vector< id_off_pair >	id_offset_vector
typedef std::vector< int >	offset_vector

Private Attributes
id_offset_vector	id_offsets_
bool	isFilling_
offset_vector	ref_offsets_

Friends
class	FastFiller

Detailed Description

Base class to map to items one a range within a target collection. All items in a target collection must be mapped to one and only one key. The target collection will normally be a RefVector (also PtrVector and std::vector could work) To be used by MultiAssociation. Any other usage beyond MultiAssociation is not supported. This class holds:

• ref_offsets_: A non decreasing list of offsets in the target collection, with one item for each key plus one end item. A range is given by a consecutive pair of offsets. While filling the map, some items can be '-1', but not the last one.
• id_offsets_ : A list of pairs, mapping a product id to its associated range in ref_offsets_ This class can be filled through a FastFiller, that requires to fill keys and offsets in strictly increasing order, and without gaps. Only one FastFiller can exist at time, and each FastFiller fills only for a given key collection.

Definition at line 73 of file MultiAssociation.h.

Member Typedef Documentation

typedef std::pair<edm::ProductID,unsigned int> edm::helper::IndexRangeAssociation::id_off_pair

private

Definition at line 132 of file MultiAssociation.h.

typedef std::vector<id_off_pair> edm::helper::IndexRangeAssociation::id_offset_vector

private

Definition at line 133 of file MultiAssociation.h.

typedef std::vector<int> edm::helper::IndexRangeAssociation::offset_vector

private

Definition at line 134 of file MultiAssociation.h.

typedef std::pair<unsigned int, unsigned int> edm::helper::IndexRangeAssociation::range

Definition at line 75 of file MultiAssociation.h.

Constructor & Destructor Documentation

edm::helper::IndexRangeAssociation::IndexRangeAssociation ( )

inline

Definition at line 77 of file MultiAssociation.h.

: isFilling_(false) {}

Member Function Documentation

bool IndexRangeAssociation::contains

(

ProductID

id

)

const

True if this IndexRangeAssociation has info for this product id.

Definition at line 32 of file MultiAssociation.cc.

References id_offsets_.

Referenced by LumiList.LumiList::__contains__(), and edm::MultiAssociation< C >::contains().

                                                  {
    typedef IndexRangeAssociation::id_offset_vector::const_iterator iter;
    iter pos = std::lower_bound(id_offsets_.begin(), id_offsets_.end(), id, IDComparator());
    return (pos != id_offsets_.end()) && (pos->first == id);
}

bool edm::helper::IndexRangeAssociation::empty ( ) const

inline

True if it's empty (no keys)

Definition at line 97 of file MultiAssociation.h.

References ref_offsets_.

Referenced by edm::MultiAssociation< C >::empty(), Vispa.Gui.VispaWidget.TextField::setAutosizeFont(), and Vispa.Gui.VispaWidget.TextField::setAutotruncate().

{ return ref_offsets_.empty(); }

IndexRangeAssociation::range IndexRangeAssociation::get	(	const edm::ProductID &	id,
		unsigned int	t
	)		const

Get a range of indices for this product id and key (non-template version) And end value of -1 means 'until the end of the other collection, AFAICT'

Definition at line 11 of file MultiAssociation.cc.

References Exception, id_offsets_, relval_steps::key, ref_offsets_, and edm::second().

Referenced by Options.Options::__getitem__(), betterConfigParser.BetterConfigParser::__updateDict(), rrapi.RRApi::columns(), util.rrapi.RRApi::columns(), rrapi.RRApi::count(), util.rrapi.RRApi::count(), rrapi.RRApi::data(), util.rrapi.RRApi::data(), edm::MultiAssociation< C >::get(), betterConfigParser.BetterConfigParser::getCompares(), betterConfigParser.BetterConfigParser::getGeneral(), betterConfigParser.BetterConfigParser::getResultingSection(), rrapi.RRApi::report(), util.rrapi.RRApi::report(), rrapi.RRApi::reports(), util.rrapi.RRApi::reports(), util.rrapi.RRApi::tables(), rrapi.RRApi::tables(), util.rrapi.RRApi::tags(), rrapi.RRApi::tags(), util.rrapi.RRApi::templates(), rrapi.RRApi::templates(), rrapi.RRApi::workspaces(), and util.rrapi.RRApi::workspaces().

                                                                      {
    typedef IndexRangeAssociation::id_offset_vector::const_iterator iter;
    iter pos = std::lower_bound(id_offsets_.begin(), id_offsets_.end(), id, IDComparator()); 
    if ((pos == id_offsets_.end()) || (pos->first != id)) {
        throw cms::Exception("Bad Key") << "Product ID " << id << " not found in this IndexRangeAssociation\n";
    }
    // === Do we want this check ? I would say yes, even if it costs some extra CPU cycles
    if ((pos + 1 != id_offsets_.end()) && (pos->second + key >= (pos+1)->second)) {
        throw cms::Exception("Bad Offset") << "Key " << key << " goes beyond bounds " 
                    << ((pos+1)->second - pos->second) 
                    << " of this key collection within IndexRangeAssociation\n";
    }
    // === End check
    offset_vector::const_iterator offs = ref_offsets_.begin() + pos->second + key;
    if (offs >= ref_offsets_.end()-1) {
        throw cms::Exception("Bad Offset") << "Key " << key << " goes beyond bounds " << ref_offsets_.size()-1 << " of this IndexRangeAssociation\n";
    }
    return range(*offs,*(offs+1));
}

template<typename RefKey >

range edm::helper::IndexRangeAssociation::operator[] ( const RefKey &  r ) const

inline

Get a range of indices for this key. RefKey can be edm::Ref, edm::Ptr, edm::RefToBase And end value of -1 means 'until the end of the other collection, AFAICT'

Definition at line 82 of file MultiAssociation.h.

                                                      {  
                  return get(r.id(), r.key()); 
              }

unsigned int edm::helper::IndexRangeAssociation::size ( void  ) const

inline

Size of this collection (number of keys)

Definition at line 94 of file MultiAssociation.h.

References ref_offsets_.

Referenced by edm::helper::IndexRangeAssociation::FastFiller::insert(), and edm::MultiAssociation< C >::size().

{ return ref_offsets_.empty() ? 0 : ref_offsets_.size() - 1; }

void IndexRangeAssociation::swap

(

IndexRangeAssociation &

other

)

Definition at line 39 of file MultiAssociation.cc.

References Exception, id_offsets_, isFilling_, and ref_offsets_.

Referenced by edm::helper::swap(), and edm::MultiAssociation< C >::swap().

                                                        {
    if (isFilling_ || other.isFilling_) throw cms::Exception("Busy") << "Can't swap an IndexRangeAssociation while it's being filled!\n";
    id_offsets_.swap(other.id_offsets_);
    ref_offsets_.swap(other.ref_offsets_);
}

void IndexRangeAssociation::throwUnexpectedProductID ( ProductID  found, ProductID  expected, const char *  where  )

static

Definition at line 116 of file MultiAssociation.cc.

References Exception.

Referenced by edm::helper::IndexRangeAssociation::FastFiller::insert(), edm::MultiAssociation< C >::LazyFiller::setValues(), and edm::MultiAssociation< C >::LazyFiller::swapValues().

                                                                                                      {
    throw cms::Exception("Unexpected ProductID") << where <<
          ": found product id " << found << ", while expecting " << expected << ".\n" << 
          "Make sure you're not mismatching references from different collections.\n";
}

Friends And Related Function Documentation

friend class FastFiller

friend

Definition at line 126 of file MultiAssociation.h.

Member Data Documentation

id_offset_vector edm::helper::IndexRangeAssociation::id_offsets_

private

Definition at line 135 of file MultiAssociation.h.

Referenced by contains(), edm::helper::IndexRangeAssociation::FastFiller::FastFiller(), get(), and swap().

bool edm::helper::IndexRangeAssociation::isFilling_

private

Definition at line 138 of file MultiAssociation.h.

Referenced by edm::helper::IndexRangeAssociation::FastFiller::FastFiller(), and swap().

offset_vector edm::helper::IndexRangeAssociation::ref_offsets_

private

Definition at line 136 of file MultiAssociation.h.

Referenced by empty(), edm::helper::IndexRangeAssociation::FastFiller::FastFiller(), get(), size(), and swap().