From c4fa4b2c2089f8facf883d037e2e94c0199d06c8 Mon Sep 17 00:00:00 2001
From: cxl <cxl@f0d560ea-af0d-0410-9eb7-867de7ffcac7>
Date: Wed, 6 Mar 2013 19:32:06 +0000
Subject: [PATCH] Core: SortedVectorMap docs

git-svn-id: svn://ultimatepp.org/upp/trunk@5889 f0d560ea-af0d-0410-9eb7-867de7ffcac7
---
 uppsrc/Core/src.tpp/SortedVectorMap$en-us.tpp | 82 +++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 uppsrc/Core/src.tpp/SortedVectorMap$en-us.tpp

diff --git a/uppsrc/Core/src.tpp/SortedVectorMap$en-us.tpp b/uppsrc/Core/src.tpp/SortedVectorMap$en-us.tpp
new file mode 100644
index 000000000..18aa1679b
--- /dev/null
+++ b/uppsrc/Core/src.tpp/SortedVectorMap$en-us.tpp
@@ -0,0 +1,82 @@
+topic "SortedVectorMap";
+[2 $$0,0#00000000000000000000000000000000:Default]
+[i448;a25;kKO9;2 $$1,0#37138531426314131252341829483380:class]
+[l288;2 $$2,2#27521748481378242620020725143825:desc]
+[0 $$3,0#96390100711032703541132217272105:end]
+[H6;0 $$4,0#05600065144404261032431302351956:begin]
+[i448;a25;kKO9;2 $$5,0#37138531426314131252341829483370:item]
+[l288;a4;*@5;1 $$6,6#70004532496200323422659154056402:requirement]
+[l288;i1121;b17;O9;~~~.1408;2 $$7,0#10431211400427159095818037425705:param]
+[i448;b42;O9;2 $$8,8#61672508125594000341940100500538:tparam]
+[b42;2 $$9,9#13035079074754324216151401829390:normal]
+[{_}%EN-US 
+[ {{10000@(113.42.0) [s0; [*@7;4 SortedVectorMap]]}}&]
+[s1;@(0.0.255)3%- &]
+[s1;:noref:%- [@(0.0.255)3 template][3 _<][@(0.0.255)3 class][3 _][*@4;3 K][3 , 
+][@(0.0.255)3 class][3 _][*@4;3 T][3 , ][@(0.0.255)3 class][3 _][*@4;3 Less][3 _`=_StdLess<][*@4;3 K
+][3 >_>]&]
+[s1;:SortedVectorMap`:`:class:%- [@(0.0.255) class]_[* SortedVectorMap]_:_[@(0.0.255) public
+]_[*@3 MoveableAndDeepCopyOption]<[* SortedVectorMap]<[*@4 K], [*@4 T], 
+[*@4 Less]>_>, [@(0.0.255) public]_[*@3 SortedAMap]<[*@4 K], [*@4 T], [*@4 Less], 
+[_^Slaved`_InVector`_`_^ Slaved`_InVector`_`_]<[*@4 T]>_>_&]
+[s2; Vector flavor of [^topic`:`/`/Core`/src`/SortedAMap`$en`-us^ SortedAMap]. 
+It has default pick transfer semantics with optional deep`-copy. 
+It is [^topic`:`/`/Core`/srcdoc`/Moveable`$en`-us^ Moveable]. Both 
+elements and values have to be [^topic`:`/`/Core`/srcdoc`/Moveable`$en`-us^ Moveabl
+e].&]
+[s0;*@7;4 &]
+[ {{10000F(128)G(128)@1 [s0; [* Public Method List]]}}&]
+[s3;%- &]
+[s5;:SortedVectorMap`:`:Add`(const K`&`,const T`&`):%- [*@4 T][@(0.0.255) `&]_[* Add]([@(0.0.255) c
+onst]_[*@4 K][@(0.0.255) `&]_[*@3 k], [@(0.0.255) const]_[*@4 T][@(0.0.255) `&]_[*@3 x])&]
+[s2; Inserts a copy of key`-value pair at upper bound key position 
+and returns reference to element value.&]
+[s3; &]
+[s4; &]
+[s5;:SortedVectorMap`:`:Add`(const K`&`):%- [*@4 T][@(0.0.255) `&]_[* Add]([@(0.0.255) const]_
+[*@4 K][@(0.0.255) `&]_[*@3 k])&]
+[s2; Inserts the key at upper bound key position and returns reference 
+to the default constructed value at the same index.&]
+[s3; &]
+[s4; &]
+[s5;:SortedVectorMap`:`:FindAdd`(const K`&`):%- [@(0.0.255) int]_[* FindAdd]([@(0.0.255) co
+nst]_[*@4 K][@(0.0.255) `&]_[*@3 k])&]
+[s2; If key [%-*@3 k] is present, returns index of its lower`-bound 
+position. If not, inserts it at upper`-bound position and returns 
+its index (value of element is default`-constructed).&]
+[s3; &]
+[s4; &]
+[s5;:SortedVectorMap`:`:FindAdd`(const K`&`,const T`&`):%- [@(0.0.255) int]_[* FindAdd]([@(0.0.255) c
+onst]_[*@4 K][@(0.0.255) `&]_[*@3 k], [@(0.0.255) const]_[*@4 T][@(0.0.255) `&]_[*@3 init])&]
+[s2; If key [%-*@3 k] is present, returns index of its lower`-bound 
+position. If not, inserts it at upper`-bound position with value 
+of element copy`-constructed from [%-*@3 init] and returns its 
+index.&]
+[s3; &]
+[s4; &]
+[s5;:SortedVectorMap`:`:GetAdd`(const K`&`):%- [*@4 T][@(0.0.255) `&]_[* GetAdd]([@(0.0.255) c
+onst]_[*@4 K][@(0.0.255) `&]_[*@3 k])&]
+[s2; If key [%-*@3 k] is present, returns reference of value at its 
+lower`-bound position. If not, inserts it at upper`-bound position 
+and returns reference to coresponding value (value of element 
+is default`-constructed).&]
+[s3; &]
+[s4; &]
+[s5;:SortedVectorMap`:`:GetAdd`(const K`&`,const T`&`):%- [*@4 T][@(0.0.255) `&]_[* GetAdd](
+[@(0.0.255) const]_[*@4 K][@(0.0.255) `&]_[*@3 k], [@(0.0.255) const]_[*@4 T][@(0.0.255) `&]_[*@3 x
+])&]
+[s2; If key [%-*@3 k] is present, returns reference of value at its 
+lower`-bound position. If not, inserts it at upper`-bound position 
+and returns reference to coresponding value, which is copy`-constructed 
+from [%-*@3 x].&]
+[s3; &]
+[s4; &]
+[s5;:SortedVectorMap`:`:Pop`(`):%- [*@4 T]_[* Pop]()&]
+[s2; Drops the last element and returns its value.&]
+[s3; &]
+[s4; &]
+[s5;:SortedVectorMap`:`:SortedVectorMap`(const SortedVectorMap`&`,int`):%- [* SortedVec
+torMap]([@(0.0.255) const]_[* SortedVectorMap][@(0.0.255) `&]_[*@3 s], 
+[@(0.0.255) int])&]
+[s2; Deep copy constructor.&]
+[s0; ]]
\ No newline at end of file