LLVM  14.0.0git
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator Class Reference

#include "llvm/ADT/IntervalMap.h"

Inheritance diagram for llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator:
Inheritance graph
[legend]
Collaboration diagram for llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator:
Collaboration graph
[legend]

Public Types

using iterator_category = std::bidirectional_iterator_tag
 
using value_type = ValT
 
using difference_type = std::ptrdiff_t
 
using pointer = value_type *
 
using reference = value_type &
 

Public Member Functions

 const_iterator ()=default
 const_iterator - Create an iterator that isn't pointing anywhere. More...
 
void setMap (const IntervalMap &m)
 setMap - Change the map iterated over. More...
 
bool valid () const
 valid - Return true if the current position is valid, false for end(). More...
 
bool atBegin () const
 atBegin - Return true if the current position is the first map entry. More...
 
const KeyTstart () const
 start - Return the beginning of the current interval. More...
 
const KeyTstop () const
 stop - Return the end of the current interval. More...
 
const ValTvalue () const
 value - Return the mapped value at the current interval. More...
 
const ValToperator* () const
 
bool operator== (const const_iterator &RHS) const
 
bool operator!= (const const_iterator &RHS) const
 
void goToBegin ()
 goToBegin - Move to the first interval in map. More...
 
void goToEnd ()
 goToEnd - Move beyond the last interval in map. More...
 
const_iteratoroperator++ ()
 preincrement - Move to the next interval. More...
 
const_iterator operator++ (int)
 postincrement - Don't do that! More...
 
const_iteratoroperator-- ()
 predecrement - Move to the previous interval. More...
 
const_iterator operator-- (int)
 postdecrement - Don't do that! More...
 
void find (KeyT x)
 find - Move to the first interval with stop >= x, or end(). More...
 
void advanceTo (KeyT x)
 advanceTo - Move to the first interval with stop >= x, or end(). More...
 

Protected Member Functions

 const_iterator (const IntervalMap &map)
 
bool branched () const
 
void setRoot (unsigned Offset)
 
void pathFillFind (KeyT x)
 pathFillFind - Complete path by searching for x. More...
 
void treeFind (KeyT x)
 treeFind - Find in a branched tree. More...
 
void treeAdvanceTo (KeyT x)
 treeAdvanceTo - Find position after the current one. More...
 
KeyTunsafeStart () const
 unsafeStart - Writable access to start() for iterator. More...
 
KeyTunsafeStop () const
 unsafeStop - Writable access to stop() for iterator. More...
 
ValTunsafeValue () const
 unsafeValue - Writable access to value() for iterator. More...
 

Protected Attributes

IntervalMapmap = nullptr
 
IntervalMapImpl::Path path
 

Friends

class IntervalMap
 

Detailed Description

template<typename KeyT, typename ValT, unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
class llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator

Definition at line 1297 of file IntervalMap.h.

Member Typedef Documentation

◆ difference_type

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
using llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::difference_type = std::ptrdiff_t

Definition at line 1303 of file IntervalMap.h.

◆ iterator_category

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
using llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::iterator_category = std::bidirectional_iterator_tag

Definition at line 1301 of file IntervalMap.h.

◆ pointer

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
using llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::pointer = value_type *

Definition at line 1304 of file IntervalMap.h.

◆ reference

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
using llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::reference = value_type &

Definition at line 1305 of file IntervalMap.h.

◆ value_type

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
using llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::value_type = ValT

Definition at line 1302 of file IntervalMap.h.

Constructor & Destructor Documentation

◆ const_iterator() [1/2]

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::const_iterator ( const IntervalMap map)
inlineexplicitprotected

Definition at line 1315 of file IntervalMap.h.

◆ const_iterator() [2/2]

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::const_iterator ( )
default

const_iterator - Create an iterator that isn't pointing anywhere.

Member Function Documentation

◆ advanceTo()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
void llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::advanceTo ( KeyT  x)
inline

advanceTo - Move to the first interval with stop >= x, or end().

The search is started from the current position, and no earlier positions can be found. This is much faster than find() for small moves.

Definition at line 1448 of file IntervalMap.h.

References llvm::IntervalMapImpl::LeafNode< KeyT, ValT, N, Traits >::findFrom(), llvm::IntervalMapImpl::Path::leafOffset(), and x.

◆ atBegin()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
bool llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::atBegin ( ) const
inline

atBegin - Return true if the current position is the first map entry.

Definition at line 1367 of file IntervalMap.h.

References llvm::IntervalMapImpl::Path::atBegin().

◆ branched()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
bool llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::branched ( ) const
inlineprotected

◆ find()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
void llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::find ( KeyT  x)
inline

find - Move to the first interval with stop >= x, or end().

This is a full search from the root, the current position is ignored.

Definition at line 1438 of file IntervalMap.h.

References llvm::IntervalMapImpl::LeafNode< KeyT, ValT, N, Traits >::findFrom(), and x.

◆ goToBegin()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
void llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::goToBegin ( )
inline

goToBegin - Move to the first interval in map.

Definition at line 1394 of file IntervalMap.h.

References llvm::IntervalMapImpl::Path::fillLeft().

◆ goToEnd()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
void llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::goToEnd ( )
inline

goToEnd - Move beyond the last interval in map.

Definition at line 1401 of file IntervalMap.h.

◆ operator!=()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
bool llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::operator!= ( const const_iterator RHS) const
inline

Definition at line 1389 of file IntervalMap.h.

References llvm::operator==().

◆ operator*()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
const ValT& llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::operator* ( ) const
inline

Definition at line 1378 of file IntervalMap.h.

◆ operator++() [1/2]

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
const_iterator& llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::operator++ ( )
inline

◆ operator++() [2/2]

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
const_iterator llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::operator++ ( int  )
inline

postincrement - Don't do that!

Definition at line 1414 of file IntervalMap.h.

◆ operator--() [1/2]

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
const_iterator& llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::operator-- ( )
inline

predecrement - Move to the previous interval.

Definition at line 1421 of file IntervalMap.h.

References llvm::IntervalMapImpl::Path::leafOffset(), and llvm::IntervalMapImpl::Path::moveLeft().

Referenced by llvm::IntervalMap< KeyT, ValT, N, Traits >::iterator::operator--().

◆ operator--() [2/2]

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
const_iterator llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::operator-- ( int  )
inline

postdecrement - Don't do that!

Definition at line 1430 of file IntervalMap.h.

◆ operator==()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
bool llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::operator== ( const const_iterator RHS) const
inline

◆ pathFillFind()

template<typename KeyT , typename ValT , unsigned N, typename Traits >
void llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::pathFillFind ( KeyT  x)
protected

pathFillFind - Complete path by searching for x.

Parameters
xKey to search for.

Definition at line 1463 of file IntervalMap.h.

References llvm::IntervalMapImpl::NodeRef::get(), i, p, llvm::IntervalMapImpl::LeafNode< KeyT, ValT, N, Traits >::safeFind(), llvm::IntervalMapImpl::NodeRef::subtree(), and x.

◆ setMap()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
void llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::setMap ( const IntervalMap m)
inline

setMap - Change the map iterated over.

This call must be followed by a call to goToBegin(), goToEnd(), or find()

Definition at line 1361 of file IntervalMap.h.

◆ setRoot()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
void llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::setRoot ( unsigned  Offset)
inlineprotected

Definition at line 1323 of file IntervalMap.h.

References Offset, and llvm::IntervalMapImpl::Path::setRoot().

◆ start()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
const KeyT& llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::start ( ) const
inline

◆ stop()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
const KeyT& llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::stop ( ) const
inline

◆ treeAdvanceTo()

template<typename KeyT , typename ValT , unsigned N, typename Traits >
void llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::treeAdvanceTo ( KeyT  x)
protected

treeAdvanceTo - Find position after the current one.

Parameters
xKey to search for.

Definition at line 1487 of file IntervalMap.h.

References l, llvm::IntervalMapImpl::LeafNode< KeyT, ValT, N, Traits >::stop(), llvm::IntervalMapImpl::BranchNode< KeyT, ValT, N, Traits >::stop(), and x.

◆ treeFind()

template<typename KeyT , typename ValT , unsigned N, typename Traits >
void llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::treeFind ( KeyT  x)
protected

treeFind - Find in a branched tree.

Parameters
xKey to search for.

Definition at line 1477 of file IntervalMap.h.

References x.

◆ unsafeStart()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
KeyT& llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::unsafeStart ( ) const
inlineprotected

◆ unsafeStop()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
KeyT& llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::unsafeStop ( ) const
inlineprotected

◆ unsafeValue()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
ValT& llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::unsafeValue ( ) const
inlineprotected

◆ valid()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
bool llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::valid ( ) const
inline

valid - Return true if the current position is valid, false for end().

Definition at line 1364 of file IntervalMap.h.

References llvm::IntervalMapImpl::Path::valid().

Referenced by llvm::IntervalMapOverlaps< MapA, MapB >::advanceTo(), and llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::operator==().

◆ value()

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
const ValT& llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::value ( ) const
inline

value - Return the mapped value at the current interval.

Definition at line 1376 of file IntervalMap.h.

Referenced by llvm::IntervalMap< KeyT, ValT, N, Traits >::iterator::setStart(), and llvm::IntervalMap< KeyT, ValT, N, Traits >::iterator::setStop().

Friends And Related Function Documentation

◆ IntervalMap

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
friend class IntervalMap
friend

Definition at line 1298 of file IntervalMap.h.

Member Data Documentation

◆ map

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
IntervalMap* llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::map = nullptr
protected

◆ path

template<typename KeyT , typename ValT , unsigned N = IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize, typename Traits = IntervalMapInfo<KeyT>>
IntervalMapImpl::Path llvm::IntervalMap< KeyT, ValT, N, Traits >::const_iterator::path
protected

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