aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGabor Greif <ggreif@gmail.com>2009-02-27 12:02:19 +0000
committerGabor Greif <ggreif@gmail.com>2009-02-27 12:02:19 +0000
commit2946d1c928a6933c9f9b0544b58af61cdab36822 (patch)
tree1b28539d1eead2e3b2500d798cff5dc5d540147d /docs
parent3899e498df64aac026cdfc8ab6c8f1d66901dc05 (diff)
downloadexternal_llvm-2946d1c928a6933c9f9b0544b58af61cdab36822.zip
external_llvm-2946d1c928a6933c9f9b0544b58af61cdab36822.tar.gz
external_llvm-2946d1c928a6933c9f9b0544b58af61cdab36822.tar.bz2
Expand a bit on iplist. If you are more expert on this class, please review!
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@65630 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r--docs/ProgrammersManual.html28
1 files changed, 20 insertions, 8 deletions
diff --git a/docs/ProgrammersManual.html b/docs/ProgrammersManual.html
index e2918c0..5068d01 100644
--- a/docs/ProgrammersManual.html
+++ b/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&lt;T&gt;</tt> is <tt>ilist&lt;T&gt;</tt>'s base and as such
+supports a slightly narrower interface. Notably, inserters from <tt>T&amp;</tt>
+are absent.</p>
+</div>
+
+<!-- _______________________________________________________________________ -->
+<div class="doc_subsubsection">
<a name="dss_ilist_node">llvm/ADT/ilist_node.h</a>
</div>