diff options
| author | Gabor Greif <ggreif@gmail.com> | 2009-02-27 12:02:19 +0000 |
|---|---|---|
| committer | Gabor Greif <ggreif@gmail.com> | 2009-02-27 12:02:19 +0000 |
| commit | 8243b8c1e5f69d333cd07f7c2b4b62743ce008f5 (patch) | |
| tree | 60ad29ef831a4e609461487283a284cc5fd4d97b | |
| parent | d5575adbc4175ea87eedaad189bd4fb0f4a0e955 (diff) | |
| download | bcm5719-llvm-8243b8c1e5f69d333cd07f7c2b4b62743ce008f5.tar.gz bcm5719-llvm-8243b8c1e5f69d333cd07f7c2b4b62743ce008f5.zip | |
Expand a bit on iplist. If you are more expert on this class, please review!
llvm-svn: 65630
| -rw-r--r-- | llvm/docs/ProgrammersManual.html | 28 |
1 files changed, 20 insertions, 8 deletions
diff --git a/llvm/docs/ProgrammersManual.html b/llvm/docs/ProgrammersManual.html index e2918c0438f..5068d011087 100644 --- a/llvm/docs/ProgrammersManual.html +++ b/llvm/docs/ProgrammersManual.html @@ -886,24 +886,36 @@ not invalidate iterator or pointers to other elements in the list.</p> intrusive, because it requires the element to store and provide access to the prev/next pointers for the list.</p> -<p>ilist has the same drawbacks as std::list, and additionally requires an -ilist_traits implementation for the element type, but it provides some novel -characteristics. In particular, it can efficiently store polymorphic objects, -the traits class is informed when an element is inserted or removed from the -list, and ilists are guaranteed to support a constant-time splice operation. -</p> +<p><tt>ilist</tt> has the same drawbacks as <tt>std::list</tt>, and additionally +requires an <tt>ilist_traits</tt> implementation for the element type, but it +provides some novel characteristics. In particular, it can efficiently store +polymorphic objects, the traits class is informed when an element is inserted or +removed from the list, and ilists are guaranteed to support a constant-time splice +operation.</p> -<p>These properties are exactly what we want for things like Instructions and -basic blocks, which is why these are implemented with ilists.</p> +<p>These properties are exactly what we want for things like <tt>Instruction</tt>s +and basic blocks, which is why these are implemented with <tt>ilist</tt>s.</p> Related classes of interest are explained in the following subsections: <ul> + <li><a href="#dss_iplist">iplist</a></li> <li><a href="#dss_ilist_node">llvm/ADT/ilist_node.h</a></li> </ul> </div> <!-- _______________________________________________________________________ --> <div class="doc_subsubsection"> + <a name="dss_iplist">iplist</a> +</div> + +<div class="doc_text"> +<p><tt>iplist<T></tt> is <tt>ilist<T></tt>'s base and as such +supports a slightly narrower interface. Notably, inserters from <tt>T&</tt> +are absent.</p> +</div> + +<!-- _______________________________________________________________________ --> +<div class="doc_subsubsection"> <a name="dss_ilist_node">llvm/ADT/ilist_node.h</a> </div> |
