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 | 7cdcbe3788a0e72493d907b09ccefcbfb3cdbade (patch) | |
| tree | 5cc2c554075f5ef02ec2738f4a6b9b9d8910c7b5 /llvm/docs/ProgrammersManual.html | |
| parent | 4134073c4bd049226d9688b8ed3b985b3eb82f88 (diff) | |
| download | bcm5719-llvm-7cdcbe3788a0e72493d907b09ccefcbfb3cdbade.tar.gz bcm5719-llvm-7cdcbe3788a0e72493d907b09ccefcbfb3cdbade.zip | |
add ImmutableSet/Map dox, patch by Caitlin Sadowski!
llvm-svn: 144716
Diffstat (limited to 'llvm/docs/ProgrammersManual.html')
| -rw-r--r-- | llvm/docs/ProgrammersManual.html | 46 |
1 files changed, 45 insertions, 1 deletions
diff --git a/llvm/docs/ProgrammersManual.html b/llvm/docs/ProgrammersManual.html index 2ab1681c47c..51862034b73 100644 --- a/llvm/docs/ProgrammersManual.html +++ b/llvm/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> |

