[Boost-commit] svn:boost r46352 - sandbox/SOC/2006/tree/trunk/libs/tree/doc

From: ockham_at_[hidden]
Date: 2008-06-12 09:51:38

Author: bernhard.reiter
Date: 2008-06-12 09:51:37 EDT (Thu, 12 Jun 2008)
New Revision: 46352
URL: http://svn.boost.org/trac/boost/changeset/46352

Log:
Remove shoot() from two documentation files.
Text files modified: 
   sandbox/SOC/2006/tree/trunk/libs/tree/doc/glossary.qbk  |     2 --                                      
   sandbox/SOC/2006/tree/trunk/libs/tree/doc/hierarchy.qbk |    20 ++++----------------                    
   2 files changed, 4 insertions(+), 18 deletions(-)

Modified: sandbox/SOC/2006/tree/trunk/libs/tree/doc/glossary.qbk
==============================================================================
--- sandbox/SOC/2006/tree/trunk/libs/tree/doc/glossary.qbk	(original)
+++ sandbox/SOC/2006/tree/trunk/libs/tree/doc/glossary.qbk	2008-06-12 09:51:37 EDT (Thu, 12 Jun 2008)
@@ -22,8 +22,6 @@
 Multiway Tree
 Parent
 root
-(rshoot?)
-shoot
 Sortable?
 Header(really or only impl. detail?)
 

Modified: sandbox/SOC/2006/tree/trunk/libs/tree/doc/hierarchy.qbk
==============================================================================
--- sandbox/SOC/2006/tree/trunk/libs/tree/doc/hierarchy.qbk	(original)
+++ sandbox/SOC/2006/tree/trunk/libs/tree/doc/hierarchy.qbk	2008-06-12 09:51:37 EDT (Thu, 12 Jun 2008)
@@ -99,13 +99,8 @@
                 [`hierarchy_cursor<X>::type` if `a` is mutable, `hierarchy_const_cursor<X>::type` otherwise]
         ]
         [
-		[Hierarchy's shoot]
-		[`shoot(a)`] [/shoot, sprout, twig, leaf? shoot and sprout are functionally good. root-shoot, that sounds nice]
-		[`hierarchy_cursor<X>::type` if `a` is mutable, `hierarchy_const_cursor<X>::type` otherwise]
-	]
-	[
                 [Is the hierarchy empty?]
-		[`shoot(a)`]
+		[`empty(a)`]
                 [`bool`]
         ]
 ]
@@ -119,16 +114,11 @@
         [
                 [`root(a)`]
                 [Returns a cursor pointing to the root element in the hierarchy]
-		[`root(a)` is either dereferenceable or shoot. It is shoot if and only if `empty(a)`.]
-	]
-	[
-		[`shoot(a)`]
-		[Returns a cursor pointing one position past the rightmost element in the hierarchy (the "shoot")]
-		[`shoot(a)` is shoot.]
+		[`root(a)` is either dereferenceable or `empty(a)` is true.]
         ]
         [
                 [`empty(a)`]
-		[Equivalent to `root(a) == shoot(a)`, but possibly faster.]
+		[]
                 [-]
         ]
 ]
@@ -137,11 +127,10 @@
 
 [variablelist Complexity guarantees
     [[`root(a)`]		[O(1)]]
-    [[`shoot(a)`]	[O(log(n))]]
     [[`empty(a)`]	[O(log(n))]]
 ]
 
-Invariants? Completeness could e.g. be done via preorder traversal (whose endpoints are root and shoot)
+Invariants? Completeness could e.g. be done via preorder traversal
 But preorder for multiway?
 
 [endsect] [/ Valid expressions]
@@ -164,7 +153,6 @@
 [caution Need to keep in mind that MultiwayHierarchies are almost exclusively used for searching!]
 
 [variablelist Complexity guarantees
-    [[`shoot(a)`]	[O(1)]]
     [[`empty(a)`]	[O(1)]]
 ]