A MultiRange combines several Ranges. More...

#include <MultiRange.h>

Collaboration diagram for MultiRange:

Classes
class	const_identifier_factory
class	identifier_factory
	This factory is able to generate all possible identifiers, from a fully bounded Range. More...

Public Types
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

Public Member Functions
	MultiRange ()=default
	MultiRange (const Range &r, const Range &s)
	Construct a non-overlapping MultiRange from two overlapping ones.
void	clear ()
void	add (const Range &range)
void	add (Range &&range)
	Add with move semantics.
void	add (const ExpandedIdentifier &id)
	Add a Range made from a single ExpandedIdentifier.
void	remove_range (const ExpandedIdentifier &id)
	Remove a Range made from a single ExpandedIdentifier.
Range &	back ()
	Get the last entered Range.
int	match (const ExpandedIdentifier &id) const
	Match an identifier.
const Range &	operator[] (size_type index) const
	Accessors.
size_type	size () const
const_iterator	begin () const
const_iterator	end () const
size_type	cardinality () const
	Computes a possible cardinality from all ranges.
size_type	cardinalityUpTo (const ExpandedIdentifier &id) const
bool	has_overlap () const
	Check if there are overlaps between any couple of Ranges.
identifier_factory	factory_begin ()
const_identifier_factory	factory_begin () const
identifier_factory	factory_end ()
const_identifier_factory	factory_end () const
void	show () const
void	show (std::ostream &s) const
	operator std::string () const
	Generate a textual representation of the multirange using the input format.

Private Types
using	id_vec = std::vector<ExpandedIdentifier>

Private Attributes
range_vector	m_ranges

Friends
class	identifier_factory
class	const_identifier_factory

Detailed Description

A MultiRange combines several Ranges.

Definition at line 17 of file MultiRange.h.

Member Typedef Documentation

◆ const_iterator

using MultiRange::const_iterator = range_vector::const_iterator

Definition at line 22 of file MultiRange.h.

◆ element_type

using MultiRange::element_type = ExpandedIdentifier::element_type

Definition at line 20 of file MultiRange.h.

◆ id_vec

using MultiRange::id_vec = std::vector<ExpandedIdentifier>

private

Definition at line 130 of file MultiRange.h.

◆ range_vector

using MultiRange::range_vector = std::vector<Range>

Definition at line 19 of file MultiRange.h.

◆ size_type

using MultiRange::size_type = ExpandedIdentifier::size_type

Definition at line 21 of file MultiRange.h.

Constructor & Destructor Documentation

◆ MultiRange() [1/2]

MultiRange::MultiRange ( )

default

◆ MultiRange() [2/2]

MultiRange::MultiRange	(	const Range &	r,
		const Range &	s )

Construct a non-overlapping MultiRange from two overlapping ones.

Definition at line 11 of file MultiRange.cxx.

                                                      { 
  m_ranges.push_back (r); 
  m_ranges.push_back (s); 
} 

Member Function Documentation

◆ add() [1/3]

void MultiRange::add ( const ExpandedIdentifier & id )

Add a Range made from a single ExpandedIdentifier.

Definition at line 38 of file MultiRange.cxx.

                                                  { 
  m_ranges.emplace_back (id); 
} 

◆ add() [2/3]

void MultiRange::add ( const Range & range )

Definition at line 22 of file MultiRange.cxx.

                                        { 
  // Add new range ONLY if an equivalent does NOT exist
  if (std::ranges::find(m_ranges, range) == m_ranges.end()) {
    m_ranges.push_back(range);
  }
} 

◆ add() [3/3]

void MultiRange::add ( Range && range )

Add with move semantics.

Definition at line 30 of file MultiRange.cxx.

                                   { 
  // Add new range ONLY if an equivalent does NOT exist
  if (std::ranges::find(m_ranges, range) == m_ranges.end()) {
    m_ranges.emplace_back (std::move(range));
  }
} 

◆ back()

Range & MultiRange::back ( )

Get the last entered Range.

Definition at line 52 of file MultiRange.cxx.

                        { 
  return (m_ranges.back()); 
} 

◆ begin()

MultiRange::const_iterator MultiRange::begin ( ) const

Definition at line 74 of file MultiRange.cxx.

                                                 { 
  return (m_ranges.begin ()); 
} 

◆ cardinality()

MultiRange::size_type MultiRange::cardinality ( ) const

Computes a possible cardinality from all ranges.

Definition at line 82 of file MultiRange.cxx.

                                                  {
  size_type init = 0;
  return std::accumulate(m_ranges.begin(), m_ranges.end(), init, 
    [](size_type a, const Range& b){return a + b.cardinality();});
} 

◆ cardinalityUpTo()

MultiRange::size_type MultiRange::cardinalityUpTo ( const ExpandedIdentifier & id ) const

Definition at line 88 of file MultiRange.cxx.

                                                                                 {
  // Loop over ranges in MultiRange and calculate hash for each
  // range
  size_type init = 0;
  return std::accumulate(m_ranges.begin(), m_ranges.end(), init, 
    [&id](size_type a, const Range& b){return a + b.cardinalityUpTo(id);});
}

◆ clear()

void MultiRange::clear ( )

Definition at line 17 of file MultiRange.cxx.

                        { 
  m_ranges.clear (); 
} 

◆ end()

MultiRange::const_iterator MultiRange::end ( ) const

Definition at line 78 of file MultiRange.cxx.

                                               { 
  return (m_ranges.end ()); 
} 

◆ factory_begin() [1/2]

MultiRange::identifier_factory MultiRange::factory_begin ( )

Definition at line 112 of file MultiRange.cxx.

                                                       { 
  const MultiRange& me = *this; 
  return (identifier_factory (me)); 
} 

◆ factory_begin() [2/2]

MultiRange::const_identifier_factory MultiRange::factory_begin ( ) const

Definition at line 118 of file MultiRange.cxx.

                                                                   { 
  const MultiRange& me = *this; 
  return (const_identifier_factory (me)); 
} 

◆ factory_end() [1/2]

MultiRange::identifier_factory MultiRange::factory_end ( )

Definition at line 124 of file MultiRange.cxx.

                                                     { 
  static const identifier_factory factory(*this);
  return (factory); 
} 

◆ factory_end() [2/2]

MultiRange::const_identifier_factory MultiRange::factory_end ( ) const

Definition at line 130 of file MultiRange.cxx.

                                                                 { 
  static const const_identifier_factory factory; 
  return (factory); 
} 

◆ has_overlap()

bool MultiRange::has_overlap ( ) const

Check if there are overlaps between any couple of Ranges.

Definition at line 98 of file MultiRange.cxx.

                                   { 
  range_vector::size_type i; 
  range_vector::size_type j; 
  for (i = 0; i < m_ranges.size (); ++i) { 
    const Range& r = m_ranges[i]; 
    for (j = i + 1; j < m_ranges.size (); ++j) { 
      const Range& s = m_ranges[j]; 
      if (r.overlaps_with (s)) return (true); 
    } 
  } 
  return (false); 
} 

◆ match()

int MultiRange::match ( const ExpandedIdentifier & id ) const

Match an identifier.

Definition at line 57 of file MultiRange.cxx.

                                                        { 
  bool result = std::ranges::any_of(m_ranges, [&id](const Range & r){return r.match(id);});
  return result ? 1:0;
} 

◆ operator std::string()

MultiRange::operator std::string ( ) const

Generate a textual representation of the multirange using the input format.

Definition at line 251 of file MultiRange.cxx.

                                      { 
  std::string result; 
  range_vector::size_type i{}; 
  for ( ; i < m_ranges.size (); ++i){ 
    if (i > 0) result += " | "; 
    const Range& r = m_ranges[i]; 
    result += (std::string) r; 
  } 
  return (result); 
} 

◆ operator[]()

const Range & MultiRange::operator[] ( MultiRange::size_type index ) const

Accessors.

Definition at line 63 of file MultiRange.cxx.

                                                                     { 
  static const Range null_range; 
  if (index >= m_ranges.size ()) return (null_range); 
  return (m_ranges[index]); 
} 

◆ remove_range()

void MultiRange::remove_range ( const ExpandedIdentifier & id )

Remove a Range made from a single ExpandedIdentifier.

Definition at line 43 of file MultiRange.cxx.

                                                           {
  // Remove all ranges for which id matches
  [[maybe_unused]] auto erased = std::erase_if (m_ranges,
    [&id] (const Range& r) { return r.match(id); });
}

◆ show() [1/2]

void MultiRange::show ( ) const

Definition at line 237 of file MultiRange.cxx.

                             {
  show (std::cout);
}

◆ show() [2/2]

void MultiRange::show ( std::ostream & s ) const

Definition at line 241 of file MultiRange.cxx.

                                          { 
  range_vector::size_type i; 
  for (i = 0; i < m_ranges.size (); ++i) { 
    if (i > 0) s << std::endl; 
    const Range& r = m_ranges[i]; 
    r.show (s); 
  } 
} 

◆ size()

MultiRange::size_type MultiRange::size ( ) const

Definition at line 70 of file MultiRange.cxx.

                                           { 
  return (m_ranges.size ()); 
} 

◆ const_identifier_factory

friend class const_identifier_factory

friend

Definition at line 129 of file MultiRange.h.

◆ identifier_factory

friend class identifier_factory