diff options
author | Chris Lattner <sabre@nondot.org> | 2011-11-15 22:40:14 +0000 |
---|---|---|
committer | Chris Lattner <sabre@nondot.org> | 2011-11-15 22:40:14 +0000 |
commit | 2fdd005d9799289bb2fc96ec0fe92819a4b75bd8 (patch) | |
tree | b3a28510af996241a1ec75628bb12933d508dcba /docs/ProgrammersManual.html | |
parent | ec0af2f4e1401eb5b5d4cecb213064cfa84e5b29 (diff) |
add ImmutableSet/Map dox, patch by Caitlin Sadowski!
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@144716 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/ProgrammersManual.html')
-rw-r--r-- | docs/ProgrammersManual.html | 46 |
1 files changed, 45 insertions, 1 deletions
diff --git a/docs/ProgrammersManual.html b/docs/ProgrammersManual.html index 2ab1681c47..51862034b7 100644 --- a/docs/ProgrammersManual.html +++ b/docs/ProgrammersManual.html @@ -85,7 +85,8 @@ option</a></li> <li><a href="#dss_set"><set></a></li> <li><a href="#dss_setvector">"llvm/ADT/SetVector.h"</a></li> <li><a href="#dss_uniquevector">"llvm/ADT/UniqueVector.h"</a></li> - <li><a href="#dss_otherset">Other Set-Like ContainerOptions</a></li> + <li><a href="#dss_immutableset">"llvm/ADT/ImmutableSet.h"</a></li> + <li><a href="#dss_otherset">Other Set-Like Container Options</a></li> </ul></li> <li><a href="#ds_map">Map-Like Containers (std::map, DenseMap, etc)</a> <ul> @@ -97,6 +98,7 @@ option</a></li> <li><a href="#dss_intervalmap">"llvm/ADT/IntervalMap.h"</a></li> <li><a href="#dss_map"><map></a></li> <li><a href="#dss_inteqclasses">"llvm/ADT/IntEqClasses.h"</a></li> + <li><a href="#dss_immutablemap">"llvm/ADT/ImmutableMap.h"</a></li> <li><a href="#dss_othermap">Other Map-Like Container Options</a></li> </ul></li> <li><a href="#ds_bit">BitVector-like containers</a> @@ -1608,6 +1610,29 @@ factors, and produces a lot of malloc traffic. It should be avoided.</p> </div> +<!-- _______________________________________________________________________ --> +<h4> + <a name="dss_immutableset">"llvm/ADT/ImmutableSet.h"</a> +</h4> + +<div> + +<p> +ImmutableSet is an immutable (functional) set implementation based on an AVL +tree. +Adding or removing elements is done through a Factory object and results in the +creation of a new ImmutableSet object. +If an ImmutableSet already exists with the given contents, then the existing one +is returned; equality is compared with a FoldingSetNodeID. +The time and space complexity of add or remove operations is logarithmic in the +size of the original set. + +<p> +There is no method for returning an element of the set, you can only check for +membership. + +</div> + <!-- _______________________________________________________________________ --> <h4> @@ -1814,6 +1839,25 @@ it can be edited again.</p> <!-- _______________________________________________________________________ --> <h4> + <a name="dss_immutablemap">"llvm/ADT/ImmutableMap.h"</a> +</h4> + +<div> + +<p> +ImmutableMap is an immutable (functional) map implementation based on an AVL +tree. +Adding or removing elements is done through a Factory object and results in the +creation of a new ImmutableMap object. +If an ImmutableMap already exists with the given key set, then the existing one +is returned; equality is compared with a FoldingSetNodeID. +The time and space complexity of add or remove operations is logarithmic in the +size of the original map. + +</div> + +<!-- _______________________________________________________________________ --> +<h4> <a name="dss_othermap">Other Map-Like Container Options</a> </h4> |