MultiRange.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef IDENTIFIER_MULTIRANGE_H
#define IDENTIFIER_MULTIRANGE_H
 
#include "Identifier/ExpandedIdentifier.h"
#include "Identifier/Range.h"
#include "Identifier/RangeIterator.h"
#include <vector>
#include <iosfwd>
#include <string>
class MsgStream;

class MultiRange { 
public: 
  using range_vector = std::vector<Range> ; 
  using element_type = ExpandedIdentifier::element_type ; 
  using size_type = ExpandedIdentifier::size_type ;
  using const_iterator = range_vector::const_iterator;
  
  class identifier_factory  { 
  public: 
    identifier_factory () = default; 
    identifier_factory (const MultiRange& multirange); 
    void operator ++ (); 
    const ExpandedIdentifier& operator * () const; 
    bool operator == (const identifier_factory& other) const; 
 
  private: 
    using id_vec = std::vector<ExpandedIdentifier>;
    using id_iterator = id_vec::iterator;
    using id_const_iterator = id_vec::const_iterator;
 
    ExpandedIdentifier      m_id{};
    ConstRangeIterator  m_id_fac_it{}; 
    ConstRangeIterator  m_id_fac_end{}; 
    range_vector::const_iterator    m_range_it{}; 
    range_vector::const_iterator    m_range_end{}; 
    id_iterator         m_id_vec_it{};
    id_iterator         m_id_vec_end{};
  }; 
 
  class const_identifier_factory {
  public: 
    const_identifier_factory () = default;
    const_identifier_factory (const MultiRange& multirange); 
    void operator ++ (); 
    const ExpandedIdentifier& operator * () const; 
    bool operator == (const const_identifier_factory& other) const; 
 
  private: 
    using id_vec = std::vector<ExpandedIdentifier>;
    using id_iterator = id_vec::iterator;
    using id_const_iterator = id_vec::const_iterator;
 
    ExpandedIdentifier      m_id{};
    ConstRangeIterator  m_id_fac_it{}; 
    ConstRangeIterator  m_id_fac_end{}; 
    range_vector::const_iterator    m_range_it{}; 
    range_vector::const_iterator    m_range_end{}; 
    id_iterator         m_id_vec_it{};
    id_iterator         m_id_vec_end{};
  }; 
 
  MultiRange () = default;  
  MultiRange (const Range& r, const Range& s); 
  
  void clear (); 
 
  void add (const Range& range); 

  void add (Range&& range); 

  void add (const ExpandedIdentifier& id); 

  void remove_range (const ExpandedIdentifier& id); 
 
  Range& back (); 
 
  int match (const ExpandedIdentifier& id) const; 
 
  const Range& operator [] (size_type index) const; 
  size_type size () const;
  const_iterator begin () const;
  const_iterator end () const;
  
  size_type cardinality () const;
  
  //  Up to a given id
  size_type cardinalityUpTo (const ExpandedIdentifier& id) const;
 
  bool has_overlap() const; 
 
  // identifier_factory management 
  identifier_factory        factory_begin (); 
  const_identifier_factory  factory_begin () const; 
  identifier_factory        factory_end (); 
  const_identifier_factory  factory_end () const; 
  void show (std::ostream& s) const; 
  void show (MsgStream & out) const; 
  operator std::string () const; 
 
  private: 
    friend class identifier_factory;
    friend class const_identifier_factory;
    using id_vec = std::vector<ExpandedIdentifier>;
    range_vector        m_ranges; 
}; 
 
#endif