LLVM  4.0.0
Public Types | Public Member Functions | List of all members
llvm::simple_ilist< T, Options > Class Template Reference

A simple intrusive list implementation. More...

#include <simple_ilist.h>

Inheritance diagram for llvm::simple_ilist< T, Options >:
[legend]
Collaboration diagram for llvm::simple_ilist< T, Options >:
[legend]

Public Types

typedef OptionsT::value_type value_type
 
typedef OptionsT::pointer pointer
 
typedef OptionsT::reference reference
 
typedef OptionsT::const_pointer const_pointer
 
typedef OptionsT::const_reference const_reference
 
typedef ilist_iterator
< OptionsT, false, false
iterator
 
typedef ilist_iterator
< OptionsT, false, true
const_iterator
 
typedef ilist_iterator
< OptionsT, true, false
reverse_iterator
 
typedef ilist_iterator
< OptionsT, true, true
const_reverse_iterator
 
typedef size_t size_type
 
typedef ptrdiff_t difference_type
 

Public Member Functions

 simple_ilist ()=default
 
 ~simple_ilist ()=default
 
 simple_ilist (const simple_ilist &)=delete
 
simple_ilistoperator= (const simple_ilist &)=delete
 
 simple_ilist (simple_ilist &&X)
 
simple_ilistoperator= (simple_ilist &&X)
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
LLVM_NODISCARD bool empty () const
 Check if the list is empty in constant time. More...
 
LLVM_NODISCARD size_type size () const
 Calculate the size of the list in linear time. More...
 
reference front ()
 
const_reference front () const
 
reference back ()
 
const_reference back () const
 
void push_front (reference Node)
 Insert a node at the front; never copies. More...
 
void push_back (reference Node)
 Insert a node at the back; never copies. More...
 
void pop_front ()
 Remove the node at the front; never deletes. More...
 
void pop_back ()
 Remove the node at the back; never deletes. More...
 
void swap (simple_ilist &X)
 Swap with another list in place using std::swap. More...
 
iterator insert (iterator I, reference Node)
 Insert a node by reference; never copies. More...
 
template<class Iterator >
void insert (iterator I, Iterator First, Iterator Last)
 Insert a range of nodes; never copies. More...
 
template<class Cloner , class Disposer >
void cloneFrom (const simple_ilist &L2, Cloner clone, Disposer dispose)
 Clone another list. More...
 
void remove (reference N)
 Remove a node by reference; never deletes. More...
 
template<class Disposer >
void removeAndDispose (reference N, Disposer dispose)
 Remove a node by reference and dispose of it. More...
 
iterator erase (iterator I)
 Remove a node by iterator; never deletes. More...
 
iterator erase (iterator First, iterator Last)
 Remove a range of nodes; never deletes. More...
 
template<class Disposer >
iterator eraseAndDispose (iterator I, Disposer dispose)
 Remove a node by iterator and dispose of it. More...
 
template<class Disposer >
iterator eraseAndDispose (iterator First, iterator Last, Disposer dispose)
 Remove a range of nodes and dispose of them. More...
 
void clear ()
 Clear the list; never deletes. More...
 
template<class Disposer >
void clearAndDispose (Disposer dispose)
 Clear the list and dispose of the nodes. More...
 
void splice (iterator I, simple_ilist &L2)
 Splice in another list. More...
 
void splice (iterator I, simple_ilist &L2, iterator Node)
 Splice in a node from another list. More...
 
void splice (iterator I, simple_ilist &, iterator First, iterator Last)
 Splice in a range of nodes from another list. More...
 
void merge (simple_ilist &RHS)
 Merge in another list. More...
 
template<class Compare >
void merge (simple_ilist &RHS, Compare comp)
 
void sort ()
 Sort the list. More...
 
template<class Compare >
void sort (Compare comp)
 

Detailed Description

template<typename T, class... Options>
class llvm::simple_ilist< T, Options >

A simple intrusive list implementation.

This is a simple intrusive list for a T that inherits from ilist_node<T>. The list never takes ownership of anything inserted in it.

Unlike iplist<T> and ilist<T>, simple_ilist<T> never allocates or deletes values, and has no callback traits.

The API for adding nodes include push_front(), push_back(), and insert(). These all take values by reference (not by pointer), except for the range version of insert().

There are three sets of API for discarding nodes from the list: remove(), which takes a reference to the node to remove, erase(), which takes an iterator or iterator range and returns the next one, and clear(), which empties out the container. All three are constant time operations. None of these deletes any nodes; in particular, if there is a single node in the list, then these have identical semantics:

As a convenience for callers, there are parallel APIs that take a Disposer (such as std::default_delete<T>): removeAndDispose(), eraseAndDispose(), and clearAndDispose(). These have different names because the extra semantic is otherwise non-obvious. They are equivalent to calling std::for_each() on the range to be discarded.

The currently available Options customize the nodes in the list. The same options must be specified in the ilist_node instantation for compatibility (although the order is irrelevant).

Here are examples of Options usage:

See is_valid_option for steps on adding a new option.

Definition at line 74 of file simple_ilist.h.

Member Typedef Documentation

template<typename T, class... Options>
typedef ilist_iterator<OptionsT, false, true> llvm::simple_ilist< T, Options >::const_iterator

Definition at line 92 of file simple_ilist.h.

template<typename T, class... Options>
typedef OptionsT::const_pointer llvm::simple_ilist< T, Options >::const_pointer

Definition at line 89 of file simple_ilist.h.

template<typename T, class... Options>
typedef OptionsT::const_reference llvm::simple_ilist< T, Options >::const_reference

Definition at line 90 of file simple_ilist.h.

template<typename T, class... Options>
typedef ilist_iterator<OptionsT, true, true> llvm::simple_ilist< T, Options >::const_reverse_iterator

Definition at line 94 of file simple_ilist.h.

template<typename T, class... Options>
typedef ptrdiff_t llvm::simple_ilist< T, Options >::difference_type

Definition at line 96 of file simple_ilist.h.

template<typename T, class... Options>
typedef ilist_iterator<OptionsT, false, false> llvm::simple_ilist< T, Options >::iterator

Definition at line 91 of file simple_ilist.h.

template<typename T, class... Options>
typedef OptionsT::pointer llvm::simple_ilist< T, Options >::pointer

Definition at line 87 of file simple_ilist.h.

template<typename T, class... Options>
typedef OptionsT::reference llvm::simple_ilist< T, Options >::reference

Definition at line 88 of file simple_ilist.h.

template<typename T, class... Options>
typedef ilist_iterator<OptionsT, true, false> llvm::simple_ilist< T, Options >::reverse_iterator

Definition at line 93 of file simple_ilist.h.

template<typename T, class... Options>
typedef size_t llvm::simple_ilist< T, Options >::size_type

Definition at line 95 of file simple_ilist.h.

template<typename T, class... Options>
typedef OptionsT::value_type llvm::simple_ilist< T, Options >::value_type

Definition at line 86 of file simple_ilist.h.

Constructor & Destructor Documentation

template<typename T, class... Options>
llvm::simple_ilist< T, Options >::simple_ilist ( )
default
template<typename T, class... Options>
llvm::simple_ilist< T, Options >::~simple_ilist ( )
default
template<typename T, class... Options>
llvm::simple_ilist< T, Options >::simple_ilist ( const simple_ilist< T, Options > &  )
delete
template<typename T, class... Options>
llvm::simple_ilist< T, Options >::simple_ilist ( simple_ilist< T, Options > &&  X)
inline

Definition at line 106 of file simple_ilist.h.

Member Function Documentation

template<typename T, class... Options>
reference llvm::simple_ilist< T, Options >::back ( )
inline

Definition at line 136 of file simple_ilist.h.

template<typename T, class... Options>
const_reference llvm::simple_ilist< T, Options >::back ( ) const
inline

Definition at line 137 of file simple_ilist.h.

template<typename T, class... Options>
iterator llvm::simple_ilist< T, Options >::begin ( )
inline
template<typename T, class... Options>
const_iterator llvm::simple_ilist< T, Options >::begin ( ) const
inline

Definition at line 114 of file simple_ilist.h.

template<typename T, class... Options>
void llvm::simple_ilist< T, Options >::clear ( )
inline

Clear the list; never deletes.

See Also
clearAndDispose() if the nodes should be deleted.

Definition at line 226 of file simple_ilist.h.

Referenced by llvm::simple_ilist< MachineBasicBlock, Options...>::operator=().

template<typename T, class... Options>
template<class Disposer >
void llvm::simple_ilist< T, Options >::clearAndDispose ( Disposer  dispose)
inline

Clear the list and dispose of the nodes.

Definition at line 229 of file simple_ilist.h.

Referenced by llvm::simple_ilist< MachineBasicBlock, Options...>::cloneFrom().

template<typename T, class... Options>
template<class Cloner , class Disposer >
void llvm::simple_ilist< T, Options >::cloneFrom ( const simple_ilist< T, Options > &  L2,
Cloner  clone,
Disposer  dispose 
)
inline

Clone another list.

Definition at line 169 of file simple_ilist.h.

template<typename T, class... Options>
LLVM_NODISCARD bool llvm::simple_ilist< T, Options >::empty ( ) const
inline

Check if the list is empty in constant time.

Definition at line 127 of file simple_ilist.h.

Referenced by llvm::simple_ilist< T, Options >::merge().

template<typename T, class... Options>
iterator llvm::simple_ilist< T, Options >::end ( )
inline
template<typename T, class... Options>
const_iterator llvm::simple_ilist< T, Options >::end ( ) const
inline

Definition at line 116 of file simple_ilist.h.

template<typename T, class... Options>
iterator llvm::simple_ilist< T, Options >::erase ( iterator  I)
inline
template<typename T, class... Options>
iterator llvm::simple_ilist< T, Options >::erase ( iterator  First,
iterator  Last 
)
inline

Remove a range of nodes; never deletes.

See Also
eraseAndDispose() if the nodes should be deleted.

Definition at line 201 of file simple_ilist.h.

template<typename T, class... Options>
template<class Disposer >
iterator llvm::simple_ilist< T, Options >::eraseAndDispose ( iterator  I,
Disposer  dispose 
)
inline
template<typename T, class... Options>
template<class Disposer >
iterator llvm::simple_ilist< T, Options >::eraseAndDispose ( iterator  First,
iterator  Last,
Disposer  dispose 
)
inline

Remove a range of nodes and dispose of them.

Definition at line 217 of file simple_ilist.h.

template<typename T, class... Options>
reference llvm::simple_ilist< T, Options >::front ( )
inline

Definition at line 134 of file simple_ilist.h.

template<typename T, class... Options>
const_reference llvm::simple_ilist< T, Options >::front ( ) const
inline

Definition at line 135 of file simple_ilist.h.

template<typename T, class... Options>
iterator llvm::simple_ilist< T, Options >::insert ( iterator  I,
reference  Node 
)
inline
template<typename T, class... Options>
template<class Iterator >
void llvm::simple_ilist< T, Options >::insert ( iterator  I,
Iterator  First,
Iterator  Last 
)
inline

Insert a range of nodes; never copies.

Definition at line 162 of file simple_ilist.h.

template<typename T, class... Options>
void llvm::simple_ilist< T, Options >::merge ( simple_ilist< T, Options > &  RHS)
inline

Merge in another list.

Precondition
this and RHS are sorted.

Definition at line 253 of file simple_ilist.h.

Referenced by llvm::simple_ilist< MachineBasicBlock, Options...>::merge().

template<class T , class... Options>
template<class Compare >
void llvm::simple_ilist< T, Options >::merge ( simple_ilist< T, Options > &  RHS,
Compare  comp 
)
template<typename T, class... Options>
simple_ilist& llvm::simple_ilist< T, Options >::operator= ( const simple_ilist< T, Options > &  )
delete
template<typename T, class... Options>
simple_ilist& llvm::simple_ilist< T, Options >::operator= ( simple_ilist< T, Options > &&  X)
inline

Definition at line 107 of file simple_ilist.h.

template<typename T, class... Options>
void llvm::simple_ilist< T, Options >::pop_back ( )
inline

Remove the node at the back; never deletes.

Definition at line 149 of file simple_ilist.h.

template<typename T, class... Options>
void llvm::simple_ilist< T, Options >::pop_front ( )
inline

Remove the node at the front; never deletes.

Definition at line 146 of file simple_ilist.h.

template<typename T, class... Options>
void llvm::simple_ilist< T, Options >::push_back ( reference  Node)
inline

Insert a node at the back; never copies.

Definition at line 143 of file simple_ilist.h.

Referenced by llvm::simple_ilist< MachineBasicBlock, Options...>::cloneFrom().

template<typename T, class... Options>
void llvm::simple_ilist< T, Options >::push_front ( reference  Node)
inline

Insert a node at the front; never copies.

Definition at line 140 of file simple_ilist.h.

template<typename T, class... Options>
reverse_iterator llvm::simple_ilist< T, Options >::rbegin ( )
inline
template<typename T, class... Options>
const_reverse_iterator llvm::simple_ilist< T, Options >::rbegin ( ) const
inline

Definition at line 118 of file simple_ilist.h.

template<typename T, class... Options>
void llvm::simple_ilist< T, Options >::remove ( reference  N)
inline

Remove a node by reference; never deletes.

See Also
erase() for removing by iterator.
removeAndDispose() if the node should be deleted.

Definition at line 179 of file simple_ilist.h.

template<typename T, class... Options>
template<class Disposer >
void llvm::simple_ilist< T, Options >::removeAndDispose ( reference  N,
Disposer  dispose 
)
inline

Remove a node by reference and dispose of it.

Definition at line 183 of file simple_ilist.h.

template<typename T, class... Options>
reverse_iterator llvm::simple_ilist< T, Options >::rend ( )
inline

Definition at line 121 of file simple_ilist.h.

template<typename T, class... Options>
const_reverse_iterator llvm::simple_ilist< T, Options >::rend ( ) const
inline

Definition at line 122 of file simple_ilist.h.

template<typename T, class... Options>
LLVM_NODISCARD size_type llvm::simple_ilist< T, Options >::size ( ) const
inline

Calculate the size of the list in linear time.

Definition at line 130 of file simple_ilist.h.

template<typename T, class... Options>
void llvm::simple_ilist< T, Options >::sort ( )
inline
template<class T , class... Options>
template<class Compare >
void llvm::simple_ilist< T, Options >::sort ( Compare  comp)
template<typename T, class... Options>
void llvm::simple_ilist< T, Options >::splice ( iterator  I,
simple_ilist< T, Options > &  L2 
)
inline
template<typename T, class... Options>
void llvm::simple_ilist< T, Options >::splice ( iterator  I,
simple_ilist< T, Options > &  L2,
iterator  Node 
)
inline

Splice in a node from another list.

Definition at line 239 of file simple_ilist.h.

template<typename T, class... Options>
void llvm::simple_ilist< T, Options >::splice ( iterator  I,
simple_ilist< T, Options > &  ,
iterator  First,
iterator  Last 
)
inline

Splice in a range of nodes from another list.

Definition at line 244 of file simple_ilist.h.

template<typename T, class... Options>
void llvm::simple_ilist< T, Options >::swap ( simple_ilist< T, Options > &  X)
inline

Swap with another list in place using std::swap.

Definition at line 152 of file simple_ilist.h.


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