#include "FileIndex.h"

Classes
struct	Element

struct	Transients

Public Types
enum	EntryType { kRun, kSubRun, kEvent, kEnd }

enum	SortState { kNotSorted, kSorted_Run_SubRun_Event, kSorted_Run_SubRun_EventEntry }

using	EntryNumber_t = long long

using	const_iterator = std::vector< Element >::const_iterator

using	iterator = std::vector< Element >::iterator

Public Member Functions
void	addEntry (EventID const &eID, EntryNumber_t entry)

void	addEntryOnLoad (EventID const &eID, EntryNumber_t entry)

void	sortBy_Run_SubRun_Event ()

void	sortBy_Run_SubRun_EventEntry ()

const_iterator	findPosition (EventID const &eID) const

const_iterator	findPosition (EventID const &eID, bool exact) const

const_iterator	findPosition (SubRunID const &srID, bool exact) const

const_iterator	findPosition (RunID const &rID, bool exact) const

const_iterator	findSubRunOrRunPosition (SubRunID const &srID) const

bool	contains (EventID const &id, bool exact) const

bool	contains (SubRunID const &id, bool exact) const

bool	contains (RunID const &id, bool exact) const

iterator	begin ()

const_iterator	begin () const

const_iterator	cbegin () const

iterator	end ()

const_iterator	end () const

const_iterator	cend () const

std::vector< Element >::size_type	size () const

bool	empty () const

bool	allEventsInEntryOrder () const

bool	eventsUniqueAndOrdered () const

void	print_event_list (std::ostream &os) const

Private Member Functions
bool &	allInEntryOrder () const

bool &	resultCached () const

SortState &	sortState () const

const_iterator	findEventForUnspecifiedSubRun (EventID const &eID, bool exact) const

Private Attributes
std::vector< Element >	entries_ {}

Transient< Transients >	transients_ {}

Friends
bool	operator== (FileIndex const &, FileIndex const &)

Detailed Description

Definition at line 39 of file FileIndex.h.

Member Typedef Documentation

using art::FileIndex::const_iterator = std::vector<Element>::const_iterator

Definition at line 63 of file FileIndex.h.

using art::FileIndex::EntryNumber_t = long long

Definition at line 41 of file FileIndex.h.

using art::FileIndex::iterator = std::vector<Element>::iterator

Definition at line 64 of file FileIndex.h.

Member Enumeration Documentation

enum art::FileIndex::EntryType

Enumerator
kRun
kSubRun
kEvent
kEnd

Definition at line 43 of file FileIndex.h.

                    {
       kRun,    /* 0 */
       kSubRun, /* 1 */
       kEvent,  /* 2 */
       kEnd     /* 3 */
     };

enum art::FileIndex::SortState

Enumerator
kNotSorted
kSorted_Run_SubRun_Event
kSorted_Run_SubRun_EventEntry

Definition at line 66 of file FileIndex.h.

                    {
       kNotSorted,                   /* 0 */
       kSorted_Run_SubRun_Event,     /* 1 */
       kSorted_Run_SubRun_EventEntry /* 2 */
     };

Member Function Documentation

void art::FileIndex::addEntry	(	EventID const &	eID,
		EntryNumber_t	entry
	)

Definition at line 134 of file FileIndex.cc.

References entries_, kNotSorted, resultCached(), and sortState().

   {
     entries_.emplace_back(eID, entry);
     resultCached() = false;
     sortState() = kNotSorted;
   }

void art::FileIndex::addEntryOnLoad	(	EventID const &	eID,
		EntryNumber_t	entry
	)

Definition at line 142 of file FileIndex.cc.

References entries_, and resultCached().

   {
     entries_.emplace_back(eID, entry);
     resultCached() = false;
   }

bool art::FileIndex::allEventsInEntryOrder ( ) const

Definition at line 165 of file FileIndex.cc.

References allInEntryOrder(), e, entries_, art::FileIndex::Element::invalid, kEvent, and resultCached().

   {
     if (!resultCached()) {
       resultCached() = true;
       EntryNumber_t maxEntry{Element::invalid};
       for (auto const& e : entries_) {
         if (e.getEntryType() == kEvent) {
           if (e.entry < maxEntry) {
             allInEntryOrder() = false;
             return false;
           }
           maxEntry = e.entry;
         }
       }
       allInEntryOrder() = true;
       return true;
     }
     return allInEntryOrder();
   }

bool & art::FileIndex::allInEntryOrder ( ) const

private

Definition at line 98 of file FileIndex.cc.

References transients_.

Referenced by allEventsInEntryOrder().

   {
     return transients_.get().allInEntryOrder;
   }

FileIndex::iterator art::FileIndex::begin ( )

Definition at line 50 of file FileIndex.cc.

References entries_.

   {
     return entries_.begin();
   }

FileIndex::const_iterator art::FileIndex::begin ( ) const

Definition at line 56 of file FileIndex.cc.

References entries_.

   {
     return entries_.begin();
   }

FileIndex::const_iterator art::FileIndex::cbegin ( ) const

Definition at line 62 of file FileIndex.cc.

References entries_.

Referenced by eventsUniqueAndOrdered().

   {
     return entries_.begin();
   }

FileIndex::const_iterator art::FileIndex::cend ( ) const

Definition at line 80 of file FileIndex.cc.

References entries_.

Referenced by eventsUniqueAndOrdered().

   {
     return entries_.end();
   }

bool art::FileIndex::contains	(	EventID const &	id,
		bool	exact
	)		const

Definition at line 116 of file FileIndex.cc.

References entries_, and findPosition().

   {
     return findPosition(id, exact) != entries_.end();
   }

bool art::FileIndex::contains	(	SubRunID const &	id,
		bool	exact
	)		const

Definition at line 122 of file FileIndex.cc.

References entries_, and findPosition().

   {
     return findPosition(id, exact) != entries_.end();
   }

bool art::FileIndex::contains	(	RunID const &	id,
		bool	exact
	)		const

Definition at line 128 of file FileIndex.cc.

References entries_, and findPosition().

   {
     return findPosition(id, exact) != entries_.end();
   }

bool art::FileIndex::empty ( ) const

Definition at line 92 of file FileIndex.cc.

References entries_.

   {
     return entries_.empty();
   }

FileIndex::iterator art::FileIndex::end ( void )

Definition at line 68 of file FileIndex.cc.

References entries_.

   {
     return entries_.end();
   }

FileIndex::const_iterator art::FileIndex::end ( void ) const

Definition at line 74 of file FileIndex.cc.

References entries_.

   {
     return entries_.end();
   }

bool art::FileIndex::eventsUniqueAndOrdered ( ) const

Definition at line 186 of file FileIndex.cc.

References cbegin(), cend(), and kEvent.

   {
     auto it = cbegin();
     auto itEnd = cend();
     // Set up the iterators to point to first two events
     // (In the trivial case where there is zero or one event,
     // the set is unique and ordered by construction).
     if (it == itEnd) {
       return true;
     }
     // Step to first event
     while (it->getEntryType() != kEvent) {
       ++it;
       if (it == itEnd) {
         return true;
       }
     }
     auto itPrevious = it;
     // Step to second event
     ++it;
     if (it == itEnd) {
       return true;
     }
     while (it->getEntryType() != kEvent) {
       ++it;
       if (it == itEnd) {
         return true;
       }
     }
     for (; it != itEnd; ++it) {
       if (it->getEntryType() == kEvent) {
         if (it->eventID <= itPrevious->eventID) {
           return false;
         }
         itPrevious = it;
       }
     }
     return true; // finished and found no duplicates
   }

FileIndex::const_iterator art::FileIndex::findEventForUnspecifiedSubRun	(	EventID const &	eID,
		bool	exact
	)		const

private

Definition at line 347 of file FileIndex.cc.

References entries_, art::EventID::event(), findPosition(), art::EventID::firstEvent(), art::SubRunID::firstSubRun(), art::SubRunID::isValid(), art::SubRunID::next(), and art::EventID::runID().

Referenced by findPosition().

   {
     RunID const& runID = eID.runID();
     EventNumber_t event = eID.event();
     SubRunID last_subRunID;
     // Try to find the event.
     auto const firstEvent =
       findPosition(EventID::firstEvent(SubRunID::firstSubRun(runID)), false);
     const_iterator it = firstEvent;
     const_iterator const itEnd = entries_.end();
     if (it == itEnd) {
       return it;
     }
 
     // Starting with it, jump to the first event of each subrun until
     // we find either:
     //
     // 1. The next run.
     // 2. An event number higher than we want.
     // 3. The end of the file index.
     while ((it != itEnd) && (it->eventID.runID() == runID) &&
            (it->eventID.event() < event)) {
       last_subRunID = it->eventID.subRunID();
       // Get the first event in the next subrun.
       it =
         findPosition(EventID::firstEvent(it->eventID.subRunID().next()), false);
     }
     const_iterator result = itEnd;
     if ((it != itEnd) && (it->eventID.runID() == runID) &&
         (it->eventID.event() == event)) {
       // We started on the correct event.
       result = it;
     } else if (last_subRunID.isValid()) {
       // Find the event in the last subrun.
       result = findPosition(EventID(last_subRunID, event), exact);
     }
     if (result == itEnd) {
       // Did not find anything.
       mf::LogWarning("FileIndex")
         << "Could not find incompletely specified event " << eID
         << " with smart algorithm:\n"
         << "Assuming pathological file structure (event selection?) and\n"
         << "trying again (inefficient).\n"
         << "NOTE: this will find only the event with matching event number "
         << "and the\n"
         << "      lowest subrun number: any others are inaccessible via this "
         << "method.";
       SubRunID trySubRun{SubRunID::firstSubRun(runID)};
       // Try to find the highest subrun number in this run.
       const_iterator findIt(firstEvent);
       SubRunID lastSubRunInRun{trySubRun};
       for (; findIt != itEnd && findIt->eventID.runID() == runID;
            findIt =
              findPosition(EventID::firstEvent(lastSubRunInRun.next()), false)) {
         lastSubRunInRun = findIt->eventID.subRunID();
       }
       // Now loop through each subrun looking for an exact match to our event.
       while ((findIt = findPosition(EventID(trySubRun, event), true)) ==
                itEnd &&
              trySubRun < lastSubRunInRun) {
         trySubRun = trySubRun.next();
       }
       result = findIt;
     }
     return result;
   }

FileIndex::const_iterator art::FileIndex::findPosition ( EventID const & eID ) const

Definition at line 227 of file FileIndex.cc.

References entries_, kSorted_Run_SubRun_Event, and sortState().

Referenced by contains(), findEventForUnspecifiedSubRun(), findPosition(), findSubRunOrRunPosition(), and art::MixHelper::mixAndPut().

   {
     assert(sortState() == kSorted_Run_SubRun_Event);
     Element el{eID};
     return lower_bound_all(entries_, el);
   }

FileIndex::const_iterator art::FileIndex::findPosition	(	EventID const &	eID,
		bool	exact
	)		const

Definition at line 235 of file FileIndex.cc.

References entries_, findEventForUnspecifiedSubRun(), findPosition(), kEvent, kSorted_Run_SubRun_Event, and sortState().

   {
     assert(sortState() == kSorted_Run_SubRun_Event);
     if (subRunUnspecified(eID)) {
       return findEventForUnspecifiedSubRun(eID, exact);
     }
     const_iterator it = findPosition(eID);
     const_iterator itEnd = entries_.end();
     while (it != itEnd && it->getEntryType() != FileIndex::kEvent) {
       ++it;
     }
     if (it == itEnd) {
       return itEnd;
     }
     if (exact && (*it != eID)) {
       return itEnd;
     }
     return it;
   }

FileIndex::const_iterator art::FileIndex::findPosition	(	SubRunID const &	srID,
		bool	exact
	)		const

Definition at line 256 of file FileIndex.cc.

References entries_, findPosition(), art::EventID::invalidEvent(), kNotSorted, kSorted_Run_SubRun_EventEntry, kSubRun, and sortState().

   {
     assert(sortState() != kNotSorted);
     const_iterator it;
     auto const invID = EventID::invalidEvent(srID);
     if (sortState() == kSorted_Run_SubRun_EventEntry) {
       Element const el{invID};
       it = lower_bound_all(entries_, el, Compare_Run_SubRun_EventEntry());
     } else {
       it = findPosition(invID);
     }
     auto const itEnd = entries_.cend();
     while (it != itEnd && it->getEntryType() != FileIndex::kSubRun) {
       ++it;
     }
     if (it == itEnd) {
       return itEnd;
     }
     if (exact && (it->eventID.subRunID() != srID)) {
       return itEnd;
     }
     return it;
   }

FileIndex::const_iterator art::FileIndex::findPosition	(	RunID const &	rID,
		bool	exact
	)		const

Definition at line 281 of file FileIndex.cc.

References entries_, findPosition(), art::EventID::invalidEvent(), kNotSorted, kRun, kSorted_Run_SubRun_EventEntry, and sortState().

   {
     assert(sortState() != kNotSorted);
     const_iterator it;
     auto const invID = EventID::invalidEvent(rID);
     if (sortState() == kSorted_Run_SubRun_EventEntry) {
       Element const el{invID};
       it = lower_bound_all(entries_, el, Compare_Run_SubRun_EventEntry());
     } else {
       it = findPosition(invID);
     }
     auto const itEnd = entries_.cend();
     while (it != itEnd && it->getEntryType() != FileIndex::kRun) {
       ++it;
     }
     if (it == itEnd) {
       return itEnd;
     }
     if (exact && (it->eventID.runID() != rID)) {
       return itEnd;
     }
     return it;
   }

FileIndex::const_iterator art::FileIndex::findSubRunOrRunPosition ( SubRunID const & srID ) const

Definition at line 306 of file FileIndex.cc.

References entries_, findPosition(), art::EventID::invalidEvent(), kNotSorted, kRun, kSorted_Run_SubRun_EventEntry, kSubRun, and sortState().

   {
     assert(sortState() != kNotSorted);
     const_iterator it;
     if (sortState() == kSorted_Run_SubRun_EventEntry) {
       Element el{EventID::invalidEvent(srID)};
       it = lower_bound_all(entries_, el, Compare_Run_SubRun_EventEntry());
     } else {
       it = findPosition(EventID::invalidEvent(srID));
     }
     auto const itEnd = entries_.cend();
     while (it != itEnd && it->getEntryType() != FileIndex::kSubRun &&
            it->getEntryType() != FileIndex::kRun) {
       ++it;
     }
     return it;
   }

void art::FileIndex::print_event_list ( std::ostream & os ) const

Definition at line 325 of file FileIndex.cc.

References e, entries_, kEvent, kRun, and kSubRun.

   {
     os << "\nPrinting the list of Runs, SubRuns, and Events stored in the root "
           "file.\n\n";
     os << setw(15) << "Run" << setw(15) << "SubRun" << setw(15) << "Event"
        << "\n";
     for (auto const& e : entries_) {
       if (e.getEntryType() == FileIndex::kEvent) {
         os << setw(15) << e.eventID.run() << setw(15) << e.eventID.subRun()
            << setw(15) << e.eventID.event() << "\n";
       } else if (e.getEntryType() == FileIndex::kSubRun) {
         os << setw(15) << e.eventID.run() << setw(15) << e.eventID.subRun()
            << setw(15) << " "
            << "\n";
       } else if (e.getEntryType() == FileIndex::kRun) {
         os << setw(15) << e.eventID.run() << setw(15) << " " << setw(15) << " "
            << "\n";
       }
     }
   }

bool & art::FileIndex::resultCached ( ) const

private

Definition at line 104 of file FileIndex.cc.

References transients_.

Referenced by addEntry(), addEntryOnLoad(), allEventsInEntryOrder(), sortBy_Run_SubRun_Event(), and sortBy_Run_SubRun_EventEntry().

   {
     return transients_.get().resultCached;
   }

std::vector< FileIndex::Element >::size_type art::FileIndex::size ( void ) const

Definition at line 86 of file FileIndex.cc.

References entries_.

   {
     return entries_.size();
   }

void art::FileIndex::sortBy_Run_SubRun_Event ( )

Definition at line 149 of file FileIndex.cc.

References entries_, kSorted_Run_SubRun_Event, resultCached(), and sortState().

   {
     stable_sort_all(entries_);
     resultCached() = false;
     sortState() = kSorted_Run_SubRun_Event;
   }

void art::FileIndex::sortBy_Run_SubRun_EventEntry ( )

Definition at line 157 of file FileIndex.cc.

References entries_, kSorted_Run_SubRun_EventEntry, resultCached(), and sortState().

   {
     stable_sort_all(entries_, Compare_Run_SubRun_EventEntry());
     resultCached() = false;
     sortState() = kSorted_Run_SubRun_EventEntry;
   }

FileIndex::SortState & art::FileIndex::sortState ( ) const

private

Definition at line 110 of file FileIndex.cc.

References transients_.

Referenced by addEntry(), findPosition(), findSubRunOrRunPosition(), sortBy_Run_SubRun_Event(), and sortBy_Run_SubRun_EventEntry().

   {
     return transients_.get().sortState;
   }

Friends And Related Function Documentation

bool operator==	(	FileIndex const &	,
		FileIndex const &
	)

friend

Definition at line 451 of file FileIndex.cc.

   {
     return lh.entries_ == rh.entries_;
   }

Member Data Documentation

std::vector<Element> art::FileIndex::entries_ {}

private

Definition at line 126 of file FileIndex.h.

Referenced by addEntry(), addEntryOnLoad(), allEventsInEntryOrder(), begin(), cbegin(), cend(), contains(), empty(), end(), findEventForUnspecifiedSubRun(), findPosition(), findSubRunOrRunPosition(), art::operator==(), print_event_list(), size(), sortBy_Run_SubRun_Event(), and sortBy_Run_SubRun_EventEntry().

Transient<Transients> art::FileIndex::transients_ {}

mutableprivate

Definition at line 127 of file FileIndex.h.

Referenced by allInEntryOrder(), resultCached(), and sortState().

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

canvas/Persistency/Provenance/FileIndex.h
canvas/Persistency/Provenance/FileIndex.cc

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation