#include "RangeSet.h"

Public Types
using	const_iterator = std::vector< EventRange >::const_iterator

Public Member Functions
	RangeSet (RunNumber_t)

	RangeSet (RunNumber_t, std::vector< EventRange > const &eventRanges)

RunNumber_t	run () const

std::vector< EventRange > const &	ranges () const

bool	contains (RunNumber_t, SubRunNumber_t, EventNumber_t) const

bool	is_valid () const

bool	is_full_run () const

bool	is_full_subRun () const

bool	is_sorted () const

bool	is_collapsed () const

std::string	to_compact_string () const

bool	has_disjoint_ranges () const

bool	empty () const

auto	begin () const

auto	end () const

unsigned	checksum () const

decltype(auto)	front ()

decltype(auto)	back ()

void	assign_ranges (const_iterator b, const_iterator e)

void	update (EventID const &)

template<typename... ARGS>
void	emplace_range (ARGS &&...)

RangeSet &	collapse ()

RangeSet &	merge (RangeSet const &other)

std::pair< const_iterator, bool >	split_range (SubRunNumber_t, EventNumber_t)

void	set_run (RunNumber_t const r)

void	sort ()

void	clear ()

template<typename... ARGS>
void	emplace_range (ARGS &&...args)

Static Public Member Functions
static RangeSet	invalid ()

static RangeSet	forRun (RunID)

static RangeSet	forSubRun (SubRunID)

static constexpr unsigned	invalidChecksum ()

Private Member Functions
	RangeSet ()=default

void	require_not_full_run ()

Private Attributes
RunNumber_t	run_ {IDNumber<Level::Run>::invalid()}

std::vector< EventRange >	ranges_ {}

bool	isCollapsed_ {false}

unsigned	checksum_ {invalidChecksum()}

Detailed Description

Definition at line 24 of file RangeSet.h.

Member Typedef Documentation

using art::RangeSet::const_iterator = std::vector<EventRange>::const_iterator

Definition at line 33 of file RangeSet.h.

Constructor & Destructor Documentation

RangeSet::RangeSet ( RunNumber_t r )

explicit

Definition at line 63 of file RangeSet.cc.

63 : RangeSet{r, {}} {}

art::RangeSet

Definition: RangeSet.h:24

RangeSet::RangeSet	(	RunNumber_t	r,
		std::vector< EventRange > const &	eventRanges
	)

explicit

Definition at line 65 of file RangeSet.cc.

References collapse(), ranges_, and sort().

   : run_{r}, ranges_{eventRanges}
 {
   sort();
   collapse();
 }

art::RangeSet::RangeSet ( )

explicitprivatedefault

Member Function Documentation

void RangeSet::assign_ranges	(	const_iterator	b,
		const_iterator	e
	)

Definition at line 109 of file RangeSet.cc.

References ranges_, and require_not_full_run().

 {
   require_not_full_run();
   ranges_.assign(b, e);
 }

decltype(auto) art::RangeSet::back ( void )

inline

Definition at line 88 of file RangeSet.h.

References e, and fhicl::other.

Referenced by collapse(), and update().

     {
       return ranges_.back();
     }

auto art::RangeSet::begin ( ) const

inline

Definition at line 70 of file RangeSet.h.

Referenced by art::ClosedRangeSetHandler::begin(), art::OpenRangeSetHandler::do_getSeenRanges(), split_range(), and to_compact_string().

     {
       return ranges_.begin();
     }

unsigned RangeSet::checksum ( ) const

Definition at line 184 of file RangeSet.cc.

References checksum_, and to_compact_string().

 {
   // Could cache checksums to improve performance when necessary.
   return checksum_ = ::checksum(to_compact_string());
 }

void art::RangeSet::clear ( void )

inline

Definition at line 120 of file RangeSet.h.

Referenced by art::OpenRangeSetHandler::do_rebase().

     {
       ranges_.clear();
     }

RangeSet & RangeSet::collapse ( )

Definition at line 74 of file RangeSet.cc.

References back(), e, is_sorted(), isCollapsed_, art::errors::LogicError, ranges_, run_, and art::throw_if_not_disjoint().

Referenced by art::disjoint_ranges(), merge(), art::Run::put(), art::SubRun::put(), and RangeSet().

 {
   if (isCollapsed_) {
     return *this;
   }
 
   if (ranges_.size() < 2) {
     isCollapsed_ = true;
     return *this;
   }
 
   if (!is_sorted())
     throw art::Exception(art::errors::LogicError, "RangeSet::collapse()")
       << "A range set must be sorted before it is collapsed.\n";
 
   auto processing = ranges_;
   decltype(ranges_) result;
   result.reserve(ranges_.size());
   result.push_back(ranges_.front());
   for (auto ir = ranges_.cbegin() + 1, e = ranges_.cend(); ir != e; ++ir) {
     auto const& r = *ir;
     auto& back = result.back();
     if (back.is_adjacent(r)) {
       back.merge(r);
     } else {
       throw_if_not_disjoint(run_, back, r);
       result.push_back(r);
     }
   }
   std::swap(ranges_, result);
   isCollapsed_ = true;
   return *this;
 }

bool RangeSet::contains	(	RunNumber_t	r,
		SubRunNumber_t	s,
		EventNumber_t	e
	)		const

Definition at line 214 of file RangeSet.cc.

References ranges_, and run_.

Referenced by split_range().

 {
   if (run_ != r)
     return false;
 
   for (auto const& range : ranges_) {
     if (range.contains(s, e))
       return true;
   }
 
   return false;
 }

template<typename... ARGS>

void art::RangeSet::emplace_range ( ARGS && ... )

template<typename... ARGS>

void art::RangeSet::emplace_range ( ARGS &&... args )

Definition at line 173 of file RangeSet.h.

   {
     require_not_full_run();
     ranges_.emplace_back(std::forward<ARGS>(args)...);
     isCollapsed_ = false;
   }

bool RangeSet::empty ( void ) const

Definition at line 204 of file RangeSet.cc.

References ranges_.

Referenced by art::disjoint_ranges().

 {
   for (auto const& range : ranges_) {
     if (!range.empty())
       return false;
   }
   return true;
 }

auto art::RangeSet::end ( void ) const

inline

Definition at line 75 of file RangeSet.h.

Referenced by art::OpenRangeSetHandler::do_rebase(), art::OpenRangeSetHandler::do_update(), art::ClosedRangeSetHandler::end(), split_range(), and to_compact_string().

     {
       return ranges_.end();
     }

RangeSet RangeSet::forRun ( RunID rid )

static

Definition at line 52 of file RangeSet.cc.

References art::detail::full_run_event_range(), and art::RunID::run().

Referenced by art::EDProducer::doBeginRun(), art::EDFilter::doBeginRun(), art::ProducingService::doPostReadRun(), art::RootDelayedReader::getProduct_(), art::detail::makeFullRangeSet< InRun, RunID >(), art::Run::put(), and art::rangeSetFor().

 {
   return RangeSet{rid.run(), {detail::full_run_event_range()}};
 }

RangeSet RangeSet::forSubRun ( SubRunID srid )

static

Definition at line 58 of file RangeSet.cc.

References art::EventRange::forSubRun(), art::SubRunID::run(), and art::SubRunID::subRun().

Referenced by art::EDProducer::doBeginSubRun(), art::EDFilter::doBeginSubRun(), art::ProducingService::doPostReadSubRun(), art::RootDelayedReader::getProduct_(), art::detail::makeFullRangeSet< InSubRun, SubRunID >(), art::SubRun::put(), and art::rangeSetFor().

 {
   return RangeSet{srid.run(), {EventRange::forSubRun(srid.subRun())}};
 }

decltype(auto) art::RangeSet::front ( void )

inline

Definition at line 83 of file RangeSet.h.

     {
       return ranges_.front();
     }

bool RangeSet::has_disjoint_ranges ( ) const

Definition at line 191 of file RangeSet.cc.

References is_sorted(), isCollapsed_, ranges_, and tmp.

Referenced by art::disjoint_ranges().

 {
   if (isCollapsed_ || is_sorted()) {
     return ranges_.size() < 2ull ? true : disjoint(ranges_);
   }
 
   RangeSet tmp{*this};
   tmp.sort();
   tmp.collapse();
   return tmp.has_disjoint_ranges();
 }

RangeSet RangeSet::invalid ( )

static

Definition at line 46 of file RangeSet.cc.

Referenced by art::ResultsPrincipal::fillGroup(), art::RunPrincipal::fillGroup(), art::SubRunPrincipal::fillGroup(), art::EventPrincipal::fillGroup(), art::OutputHandle::invalid(), art::ResultsPrincipal::put(), art::Results::put(), art::EventPrincipal::put(), art::Event::put(), art::ResultsPrincipal::seenRanges(), and art::EventPrincipal::seenRanges().

 {
   return RangeSet{};
 }

static constexpr unsigned art::RangeSet::invalidChecksum ( )

inlinestatic

Definition at line 126 of file RangeSet.h.

References max.

     {
       return std::numeric_limits<unsigned>::max();
     }

bool art::RangeSet::is_collapsed ( ) const

inline

Definition at line 56 of file RangeSet.h.

     {
       return isCollapsed_;
     }

bool RangeSet::is_full_run ( ) const

Definition at line 246 of file RangeSet.cc.

References art::detail::full_run_event_range(), and ranges_.

Referenced by is_valid(), art::operator<<(), and art::Run::put().

 {
   return ranges_.size() == 1ull &&
          ranges_.front() == detail::full_run_event_range();
 }

bool RangeSet::is_full_subRun ( ) const

Definition at line 253 of file RangeSet.cc.

References ranges_.

Referenced by art::SubRun::put().

 {
   return ranges_.size() == 1ull && ranges_.front().is_full_subRun();
 }

bool RangeSet::is_sorted ( ) const

Definition at line 259 of file RangeSet.cc.

References ranges_.

Referenced by collapse(), and has_disjoint_ranges().

 {
   return std::is_sorted(ranges_.cbegin(), ranges_.cend());
 }

bool RangeSet::is_valid ( ) const

Definition at line 230 of file RangeSet.cc.

References is_full_run(), ranges_, and run_.

Referenced by art::RootOutputFile::fillBranches(), art::RootOutputFile::getProduct(), art::RootDelayedReader::getProduct_(), art::SummedValue< T >::isValid(), merge(), art::Run::put_(), art::SubRun::put_(), and art::SummedValue< T >::update_impl().

 {
   if (run_ == IDNumber<Level::Run>::invalid()) {
     return false;
   }
   if (is_full_run()) {
     return true;
   }
   for (auto const& range : ranges_) {
     if (!range.is_valid())
       return false;
   }
   return true;
 }

RangeSet & RangeSet::merge ( RangeSet const & other )

Definition at line 134 of file RangeSet.cc.

References collapse(), is_valid(), isCollapsed_, ranges_, run(), and run_.

Referenced by art::RootDelayedReader::getProduct_(), and art::SummedValue< T >::update_impl().

 {
   if (!other.is_valid())
     return *this;
 
   if (!is_valid())
     run_ = other.run();
 
   std::vector<EventRange> merged;
   std::merge(ranges_.begin(),
              ranges_.end(),
              other.ranges_.begin(),
              other.ranges_.end(),
              std::back_inserter(merged));
   std::unique(merged.begin(), merged.end());
   std::swap(ranges_, merged);
   isCollapsed_ = false;
   collapse();
   return *this;
 }

std::vector<EventRange> const& art::RangeSet::ranges ( ) const

inline

Definition at line 42 of file RangeSet.h.

References art::is_valid().

Referenced by art::disjoint_ranges(), art::operator<<(), and art::operator==().

     {
       return ranges_;
     }

void art::RangeSet::require_not_full_run ( )

inlineprivate

Definition at line 135 of file RangeSet.h.

References art::errors::LogicError.

Referenced by assign_ranges(), split_range(), and update().

     {
       if (is_full_run())
         throw art::Exception(art::errors::LogicError,
                              "RangeSet::require_not_full_run")
           << "\nA RangeSet created using RangeSet::forRun cannot be "
              "modified.\n";
     }

RunNumber_t art::RangeSet::run ( ) const

inline

Definition at line 36 of file RangeSet.h.

Referenced by art::disjoint_ranges(), art::OpenRangeSetHandler::do_getSeenRanges(), art::ClosedRangeSetHandler::do_getSeenRanges(), art::ClosedRangeSetHandler::do_rebase(), merge(), art::operator<<(), art::operator==(), art::RootOutputFile::setRunAuxiliaryRangeSetID(), and art::RootOutputFile::setSubRunAuxiliaryRangeSetID().

     {
       return run_;
     }

void art::RangeSet::set_run ( RunNumber_t const r )

inline

Definition at line 108 of file RangeSet.h.

     {
       run_ = r;
     }

void art::RangeSet::sort ( void )

inline

Definition at line 114 of file RangeSet.h.

Referenced by RangeSet().

     {
       cet::sort_all(ranges_);
     }

std::pair< RangeSet::const_iterator, bool > RangeSet::split_range	(	SubRunNumber_t	s,
		EventNumber_t	e
	)

Definition at line 156 of file RangeSet.cc.

References begin(), contains(), e, end(), ranges_, require_not_full_run(), art::right(), and s.

Referenced by art::ClosedRangeSetHandler::do_maybeSplitRange().

 {
   require_not_full_run();
   bool did_split{false};
   auto result = ranges_.end();
   auto foundRange =
     std::find_if(ranges_.cbegin(), ranges_.cend(), [s, e](auto const& r) {
       return r.contains(s, e);
     });
 
   // Split only if:
   // - the range is found (i.e. the event is contained by the found range)
   // - the range is valid
   // - the size of the range is greater than 1
   if (foundRange != ranges_.cend() && foundRange->is_valid() &&
       foundRange->size() > 1ull) {
     auto const begin = foundRange->begin();
     auto const end = foundRange->end();
     auto leftIt = ranges_.emplace(foundRange, s, begin, e);
     result = std::next(leftIt);
     EventRange right{s, e, end};
     std::swap(*result, right);
     did_split = true;
   }
   return std::make_pair(result, did_split);
 }

std::string RangeSet::to_compact_string ( ) const

Definition at line 265 of file RangeSet.cc.

References begin(), end(), ranges_, run_, s, and art::to_string().

Referenced by checksum().

 {
   using namespace std;
   string s{to_string(run_)};
   if (!ranges_.empty())
     s += ":";
   for (auto const& r : ranges_) {
     s += to_string(r.subRun());
     s += "[";
     s += to_string(r.begin());
     s += ",";
     s += to_string(r.end());
     s += ")";
   }
   return s;
 }

void art::RangeSet::update ( EventID const & id )

Definition at line 117 of file RangeSet.cc.

References back(), ranges_, require_not_full_run(), and run_.

Referenced by art::OpenRangeSetHandler::do_update().

 {
   require_not_full_run();
   if (ranges_.empty()) {
     run_ = id.run();
     ranges_.emplace_back(id.subRun(), id.event(), id.next().event());
     return;
   }
   auto& back = ranges_.back();
   if (back.subRun() == id.subRun() && back.end() == id.event()) {
     back.set_end(id.next().event());
   } else {
     ranges_.emplace_back(id.subRun(), id.event(), id.next().event());
   }
 }

Member Data Documentation

unsigned art::RangeSet::checksum_ {invalidChecksum()}

mutableprivate

Definition at line 149 of file RangeSet.h.

Referenced by checksum().

bool art::RangeSet::isCollapsed_ {false}

private

Definition at line 148 of file RangeSet.h.

Referenced by collapse(), has_disjoint_ranges(), and merge().

std::vector<EventRange> art::RangeSet::ranges_ {}

private

Definition at line 145 of file RangeSet.h.

Referenced by assign_ranges(), collapse(), contains(), empty(), has_disjoint_ranges(), is_full_run(), is_full_subRun(), is_sorted(), is_valid(), merge(), RangeSet(), split_range(), to_compact_string(), and update().

RunNumber_t art::RangeSet::run_ {IDNumber<Level::Run>::invalid()}

private

Definition at line 144 of file RangeSet.h.

Referenced by collapse(), contains(), is_valid(), merge(), to_compact_string(), and update().

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

canvas/Persistency/Provenance/RangeSet.h
canvas/Persistency/Provenance/RangeSet.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation