art::FileIndex Class Reference

#include "FileIndex.h"

Classes
class	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
	FileIndex ()=default
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
template<typename ID >
const_iterator	findPosition (ID const &id, bool exact) const
const_iterator	findSubRunOrRunPosition (SubRunID const &srID) const
template<typename ID >
bool	contains (ID 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
template<>
FileIndex::const_iterator	findPosition (EventID const &eID, bool exact) const
template<>
FileIndex::const_iterator	findPosition (SubRunID const &srID, bool exact) const
template<>
FileIndex::const_iterator	findPosition (RunID const &rID, bool exact) 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_ {}

Detailed Description

Definition at line 40 of file FileIndex.h.

Member Typedef Documentation

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

Definition at line 72 of file FileIndex.h.

using art::FileIndex::EntryNumber_t = long long

Definition at line 43 of file FileIndex.h.

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

Definition at line 73 of file FileIndex.h.

Member Enumeration Documentation

enum art::FileIndex::EntryType

Enumerator
kRun
kSubRun
kEvent
kEnd

Definition at line 51 of file FileIndex.h.

{ kRun, kSubRun, kEvent, kEnd };

enum art::FileIndex::SortState

Enumerator
kNotSorted
kSorted_Run_SubRun_Event
kSorted_Run_SubRun_EventEntry

Definition at line 142 of file FileIndex.h.

                 {
    kNotSorted,
    kSorted_Run_SubRun_Event,
    kSorted_Run_SubRun_EventEntry
  };

Constructor & Destructor Documentation

art::FileIndex::FileIndex ( )

default

Member Function Documentation

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

Definition at line 29 of file FileIndex.cc.

Referenced by art::RootOutputFile::writeOne(), art::RootOutputFile::writeRun(), and art::RootOutputFile::writeSubRun().

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

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

Definition at line 37 of file FileIndex.cc.

Referenced by art::detail::readFileIndex().

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

bool art::FileIndex::allEventsInEntryOrder

(

)

const

Definition at line 60 of file FileIndex.cc.

References e.

Referenced by empty().

  {
    if (!resultCached()) {
      resultCached() = true;
      EntryNumber_t maxEntry{Element::invalidEntry};
      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

inlineprivate

Definition at line 161 of file FileIndex.h.

References transients_.

  {
    return transients_.get().allInEntryOrder_;
  }

iterator art::FileIndex::begin ( )

inline

Definition at line 93 of file FileIndex.h.

References entries_.

  {
    return entries_.begin();
  }

const_iterator art::FileIndex::begin ( ) const

inline

Definition at line 98 of file FileIndex.h.

References entries_.

  {
    return entries_.begin();
  }

const_iterator art::FileIndex::cbegin ( ) const

inline

Definition at line 103 of file FileIndex.h.

References entries_.

Referenced by art::detail::InfoDumperInputFile::print_range_sets().

  {
    return entries_.begin();
  }

const_iterator art::FileIndex::cend ( ) const

inline

Definition at line 119 of file FileIndex.h.

References entries_.

Referenced by art::MixHelper::mixAndPut(), and art::detail::InfoDumperInputFile::print_range_sets().

  {
    return entries_.end();
  }

template<typename ID >

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

inline

Definition at line 87 of file FileIndex.h.

References entries_, and findPosition().

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

bool art::FileIndex::empty ( void  ) const

inline

Definition at line 131 of file FileIndex.h.

References allEventsInEntryOrder(), entries_, eventsUniqueAndOrdered(), and print_event_list().

  {
    return entries_.empty();
  }

iterator art::FileIndex::end ( void  )

inline

Definition at line 109 of file FileIndex.h.

References entries_.

  {
    return entries_.end();
  }

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

inline

Definition at line 114 of file FileIndex.h.

References entries_.

  {
    return entries_.end();
  }

bool art::FileIndex::eventsUniqueAndOrdered

(

)

const

Definition at line 81 of file FileIndex.cc.

Referenced by empty(), and art::DuplicateChecker::init().

  {

    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 305 of file FileIndex.cc.

References art::EventID::event(), art::SubRunID::isValid(), art::SubRunID::next(), and art::EventID::runID().

Referenced by sortState().

  {

    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 123 of file FileIndex.cc.

Referenced by contains(), art::MixHelper::mixAndPut(), and art::RootInputFile::setEntry().

  {

    assert(sortState() == kSorted_Run_SubRun_Event);

    Element el{eID};
    return lower_bound_all(entries_, el);
  }

template<typename ID >

const_iterator art::FileIndex::findPosition	(	ID const &	id,
		bool	exact
	)		const

template<>

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

Definition at line 134 of file FileIndex.cc.

  {

    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;
  }

template<>

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

Definition at line 157 of file FileIndex.cc.

  {
    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;
  }

template<>

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

Definition at line 181 of file FileIndex.cc.

  {
    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 204 of file FileIndex.cc.

  {
    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 256 of file FileIndex.cc.

References e.

Referenced by empty(), and art::detail::InfoDumperInputFile::print_event_list().

  {
    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

inlineprivate

Definition at line 166 of file FileIndex.h.

References transients_.

  {
    return transients_.get().resultCached_;
  }

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

inline

Definition at line 125 of file FileIndex.h.

References entries_.

  {
    return entries_.size();
  }

void art::FileIndex::sortBy_Run_SubRun_Event

(

)

Definition at line 44 of file FileIndex.cc.

Referenced by art::RootOutputFile::writeFileIndex().

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

void art::FileIndex::sortBy_Run_SubRun_EventEntry

(

)

Definition at line 52 of file FileIndex.cc.

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

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

inlineprivate

Definition at line 171 of file FileIndex.h.

References findEventForUnspecifiedSubRun(), and transients_.

  {
    return transients_.get().sortState_;
  }

Member Data Documentation

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

private

Definition at line 179 of file FileIndex.h.

Referenced by begin(), cbegin(), cend(), contains(), empty(), end(), and size().

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

mutableprivate

Definition at line 180 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