PageRenderTime 26ms CodeModel.GetById 39ms RepoModel.GetById 0ms app.codeStats 0ms

/packages/FSharpx.Core.1.7.3/docs/FSharpx.Collections/Vector`1.htm

https://bitbucket.org/EHotwagner/fsharpstarterpack
HTML | 236 lines | 218 code | 18 blank | 0 comment | 0 complexity | 24950d6e1c98be9e81be40cb16e90d8f MD5 | raw file
Possible License(s): Apache-2.0 
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">

    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

    3. 

  3.   <head>

    4. 

  4.     <title>Vector&lt;T&gt; - FSharpx Documentation</title>

    5. 

  5.     <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>

    6. 

  6.     <link type="text/css" rel="stylesheet" href="../main.css"/>

    7. 

  7.     <script type="text/javascript" src="../js/jquery-1.3.2.min.js"></script>

    8. 

  8.     <script type="text/javascript" src="../js/jquery.scrollTo-min.js"></script>

    9. 

  9.     <script type="text/javascript" src="../js/navigation.js"></script>

    10. 

  10.     <script type="text/javascript" src="../js/example.js"></script>

    11. 

  11.   </head>

    12. 

  12.   <body><div id="namespaces">

    13. 

  13. 	<h2 class="fixed">Namespaces</h2>

    14. 

  14. 	<div class="scroll">

    15. 

  15. 		<ul>

    16. 

  16. 			<li>

    17. 

  17.           <a href="../FSharp.Control/index.htm">FSharp.Control</a>

    18. 

  18.       </li>

    19. 

  19. 			<li>

    20. 

  20.           <a href="../FSharp.IO/index.htm">FSharp.IO</a>

    21. 

  21.       </li>

    22. 

  22. 			<li>

    23. 

  23.           <a href="../FSharpx/index.htm">FSharpx</a>

    24. 

  24.       </li>

    25. 

  25. 			<li>

    26. 

  26.           <a href="../FSharpx.Collections/index.htm" class="current">FSharpx.Collections</a>

    27. 

  27.       </li>

    28. 

  28. 			<li>

    29. 

  29.           <a href="../FSharpx.Collections.Mutable/index.htm">FSharpx.Collections.Mutable</a>

    30. 

  30.       </li>

    31. 

  31. 			<li>

    32. 

  32.           <a href="../FSharpx.Core/index.htm">FSharpx.Core</a>

    33. 

  33.       </li>

    34. 

  34. 			<li>

    35. 

  35.           <a href="../FSharpx.DataStructures/index.htm">FSharpx.DataStructures</a>

    36. 

  36.       </li>

    37. 

  37. 			<li>

    38. 

  38.           <a href="../FSharpx.Linq/index.htm">FSharpx.Linq</a>

    39. 

  39.       </li>

    40. 

  40. 			<li>

    41. 

  41.           <a href="../Microsoft.FSharp.Collections/index.htm">Microsoft.FSharp.Collections</a>

    42. 

  42.       </li>

    43. 

  43. 			<li>

    44. 

  44.           <a href="../Microsoft.FSharp.Control/index.htm">Microsoft.FSharp.Control</a>

    45. 

  45.       </li>

    46. 

  46. 		</ul>

    47. 

  47. 	</div>

    48. 

  48. </div><div id="types">

    49. 

  49.   <h2 class="fixed">Types in FSharpx.Collections</h2>

    50. 

  50. 	<div class="scroll">

    51. 

  51. 		<ul>

    52. 

  52. 				<li>

    53. 

  53.             <a href="../FSharpx.Collections/ArrayModule.htm">ArrayModule</a>

    54. 

  54.         </li>

    55. 

  55. 				<li>

    56. 

  56.             <a href="../FSharpx.Collections/ByteString.htm">ByteString</a>

    57. 

  57.         </li>

    58. 

  58. 				<li>

    59. 

  59.             <a href="../FSharpx.Collections/ByteStringModule.htm">ByteStringModule</a>

    60. 

  60.         </li>

    61. 

  61. 				<li>

    62. 

  62.             <a href="../FSharpx.Collections/Deque`1.htm">Deque&lt;T&gt;</a>

    63. 

  63.         </li>

    64. 

  64. 				<li>

    65. 

  65.             <a href="../FSharpx.Collections/DequeModule.htm">DequeModule</a>

    66. 

  66.         </li>

    67. 

  67. 				<li>

    68. 

  68.             <a href="../FSharpx.Collections/DictionaryModule.htm">DictionaryModule</a>

    69. 

  69.         </li>

    70. 

  70. 				<li>

    71. 

  71.             <a href="../FSharpx.Collections/DList`1.htm">DList&lt;T&gt;</a>

    72. 

  72.         </li>

    73. 

  73. 				<li>

    74. 

  74.             <a href="../FSharpx.Collections/DListModule.htm">DListModule</a>

    75. 

  75.         </li>

    76. 

  76. 				<li>

    77. 

  77.             <a href="../FSharpx.Collections/Heap`1.htm">Heap&lt;T&gt;</a>

    78. 

  78.         </li>

    79. 

  79. 				<li>

    80. 

  80.             <a href="../FSharpx.Collections/HeapModule.htm">HeapModule</a>

    81. 

  81.         </li>

    82. 

  82. 				<li>

    83. 

  83.             <a href="../FSharpx.Collections/IPriorityQueue.htm">IPriorityQueue</a>

    84. 

  84.         </li>

    85. 

  85. 				<li>

    86. 

  86.             <a href="../FSharpx.Collections/IPriorityQueue`1.htm">IPriorityQueue`1</a>

    87. 

  87.         </li>

    88. 

  88. 				<li>

    89. 

  89.             <a href="../FSharpx.Collections/LazyList`1.htm">LazyList&lt;T&gt;</a>

    90. 

  90.         </li>

    91. 

  91. 				<li>

    92. 

  92.             <a href="../FSharpx.Collections/LazyListModule.htm">LazyListModule</a>

    93. 

  93.         </li>

    94. 

  94. 				<li>

    95. 

  95.             <a href="../FSharpx.Collections/List.htm">List</a>

    96. 

  96.         </li>

    97. 

  97. 				<li>

    98. 

  98.             <a href="../FSharpx.Collections/Map.htm">Map</a>

    99. 

  99.         </li>

    100. 

  100. 				<li>

    101. 

  101.             <a href="../FSharpx.Collections/NameValueCollectionModule.htm">NameValueCollectionModule</a>

    102. 

  102.         </li>

    103. 

  103. 				<li>

    104. 

  104.             <a href="../FSharpx.Collections/NonEmptyList.htm">NonEmptyList</a>

    105. 

  105.         </li>

    106. 

  106. 				<li>

    107. 

  107.             <a href="../FSharpx.Collections/NonEmptyList`1.htm">NonEmptyList&lt;a&gt;</a>

    108. 

  108.         </li>

    109. 

  109. 				<li>

    110. 

  110.             <a href="../FSharpx.Collections/NonEmptyListSemigroup`1.htm">NonEmptyListSemigroup`1</a>

    111. 

  111.         </li>

    112. 

  112. 				<li>

    113. 

  113.             <a href="../FSharpx.Collections/PriorityQueue.htm">PriorityQueue</a>

    114. 

  114.         </li>

    115. 

  115. 				<li>

    116. 

  116.             <a href="../FSharpx.Collections/Queue`1.htm">Queue&lt;T&gt;</a>

    117. 

  117.         </li>

    118. 

  118. 				<li>

    119. 

  119.             <a href="../FSharpx.Collections/QueueModule.htm">QueueModule</a>

    120. 

  120.         </li>

    121. 

  121. 				<li>

    122. 

  122.             <a href="../FSharpx.Collections/RandomAccessList`1.htm">RandomAccessList&lt;T&gt;</a>

    123. 

  123.         </li>

    124. 

  124. 				<li>

    125. 

  125.             <a href="../FSharpx.Collections/RandomAccessListModule.htm">RandomAccessListModule</a>

    126. 

  126.         </li>

    127. 

  127. 				<li>

    128. 

  128.             <a href="../FSharpx.Collections/Seq.htm">Seq</a>

    129. 

  129.         </li>

    130. 

  130. 				<li>

    131. 

  131.             <a href="../FSharpx.Collections/Set.htm">Set</a>

    132. 

  132.         </li>

    133. 

  133. 				<li>

    134. 

  134.             <a href="../FSharpx.Collections/Vector`1.htm" class="current">Vector&lt;T&gt;</a>

    135. 

  135.         </li>

    136. 

  136. 				<li>

    137. 

  137.             <a href="../FSharpx.Collections/VectorModule.htm">VectorModule</a>

    138. 

  138.         </li>

    139. 

  139. 		</ul>

    140. 

  140. 	</div>

    141. 

  141. </div>

    142. 

  142.     <div class="header">

    143. 

  143. 		<p class="class"><strong>Type</strong> Vector&lt;T&gt;</p>

    144. 

  144. 		<p><strong>Namespace</strong> FSharpx.Collections</p>

    145. 

  145. 		<p><strong>Interfaces</strong> <span title="System.Collections.Generic.IEnumerable<T>">IEnumerable&lt;T&gt;</span></p>

    146. 

  146. 	</div>

    147. 

  147.     <div class="sub-header">

    148. 

  148. 			<div id="summary">Vector is an ordered linear structure implementing the inverse of the List signature,

    149. 

  149. (last, initial, conj) in place of (head, tail, cons). Indexed lookup or update

    150. 

  150. (returning a new immutable instance of Vector) of any element is O(log32n). Length is O(1).

    151. 

  151. Ordering is by insertion history.

    152. 

  152. Original F# adaptation from the clojure implementation by Steffen Forkmann. 

    153. 

  153. 			</div>

    154. 

  154. 		

    155. 

  155. 		

    156. 

  156. 		

    157. 

  157. 			<h3 class="section">Properties</h3>

    158. 

  158. 			<ul>

    159. 

  159. 				<li><a href="../FSharpx.Collections/Vector`1.htm#Initial">Initial</a></li>

    160. 

  160. 				<li><a href="../FSharpx.Collections/Vector`1.htm#IsEmpty">IsEmpty</a></li>

    161. 

  161. 				<li><a href="../FSharpx.Collections/Vector`1.htm#Item">Item</a></li>

    162. 

  162. 				<li><a href="../FSharpx.Collections/Vector`1.htm#Last">Last</a></li>

    163. 

  163. 				<li><a href="../FSharpx.Collections/Vector`1.htm#Length">Length</a></li>

    164. 

  164. 				<li><a href="../FSharpx.Collections/Vector`1.htm#TryInitial">TryInitial</a></li>

    165. 

  165. 				<li><a href="../FSharpx.Collections/Vector`1.htm#TryLast">TryLast</a></li>

    166. 

  166. 				<li><a href="../FSharpx.Collections/Vector`1.htm#TryUnconj">TryUnconj</a></li>

    167. 

  167. 				<li><a href="../FSharpx.Collections/Vector`1.htm#Unconj">Unconj</a></li>

    168. 

  168. 			</ul>

    169. 

  169. 		

    170. 

  170. 	</div>

    171. 

  171. 	

    172. 

  172. 	

    173. 

  173. 	

    174. 

  174. 	

    175. 

  175.   <h3 class="section">Public properties</h3>

    176. 

  176. 

    177. 

  177.   <div id="Initial" class="method">

    178. 

  178.     <h4><a href="../FSharpx.Collections/Vector`1.htm">Vector&lt;T&gt;</a> <strong>Initial</strong> get; </h4>

    179. 

  179.     <div class="content">O(1). Returns a new vector without the last item. If the collection is empty it throws an exception. 

    180. 

  180.       

    181. 

  181.     </div>

    182. 

  182.   </div>

    183. 

  183.   <div id="IsEmpty" class="method">

    184. 

  184.     <h4><span title="System.bool">bool</span> <strong>IsEmpty</strong> get; </h4>

    185. 

  185.     <div class="content">O(1). Returns true if the vector has no elements. 

    186. 

  186.       

    187. 

  187.     </div>

    188. 

  188.   </div>

    189. 

  189.   <div id="Item" class="method">

    190. 

  190.     <h4><span title="FSharpx.Collections.T">T</span> <strong>Item</strong> get; </h4>

    191. 

  191.     <div class="content">O(log32n). Returns vector element at the index. 

    192. 

  192.       

    193. 

  193.     </div>

    194. 

  194.   </div>

    195. 

  195.   <div id="Last" class="method">

    196. 

  196.     <h4><span title="FSharpx.Collections.T">T</span> <strong>Last</strong> get; </h4>

    197. 

  197.     <div class="content">O(1). Returns the last element in the vector. If the vector is empty it throws an exception. 

    198. 

  198.       

    199. 

  199.     </div>

    200. 

  200.   </div>

    201. 

  201.   <div id="Length" class="method">

    202. 

  202.     <h4><span title="System.int">int</span> <strong>Length</strong> get; </h4>

    203. 

  203.     <div class="content">O(1). Returns the number of items in the vector. 

    204. 

  204.       

    205. 

  205.     </div>

    206. 

  206.   </div>

    207. 

  207.   <div id="TryInitial" class="method">

    208. 

  208.     <h4><span title="Microsoft.FSharp.Core.FSharpOption<Vector<T>>">FSharpOption&lt;Vector&lt;T&gt;&gt;</span> <strong>TryInitial</strong> get; </h4>

    209. 

  209.     <div class="content">O(1). Returns option vector without the last item. 

    210. 

  210.       

    211. 

  211.     </div>

    212. 

  212.   </div>

    213. 

  213.   <div id="TryLast" class="method">

    214. 

  214.     <h4><span title="Microsoft.FSharp.Core.FSharpOption<T>">FSharpOption&lt;T&gt;</span> <strong>TryLast</strong> get; </h4>

    215. 

  215.     <div class="content">O(1). Returns option last element in the vector. 

    216. 

  216.       

    217. 

  217.     </div>

    218. 

  218.   </div>

    219. 

  219.   <div id="TryUnconj" class="method">

    220. 

  220.     <h4><span title="Microsoft.FSharp.Core.FSharpOption<Tuple<Vector<T>, T>>">FSharpOption&lt;Tuple&lt;Vector&lt;T&gt;, T&gt;&gt;</span> <strong>TryUnconj</strong> get; </h4>

    221. 

  221.     <div class="content">O(1). Returns option tuple last element and vector without last item 

    222. 

  222.       

    223. 

  223.     </div>

    224. 

  224.   </div>

    225. 

  225.   <div id="Unconj" class="method">

    226. 

  226.     <h4><span title="System.Tuple<Vector<T>, T>">Tuple&lt;Vector&lt;T&gt;, T&gt;</span> <strong>Unconj</strong> get; </h4>

    227. 

  227.     <div class="content">O(1). Returns tuple last element and vector without last item 

    228. 

  228.       

    229. 

  229.     </div>

    230. 

  230.   </div>

    231. 

  231. 	<div id="footer">

    232. 

  232.   <p>Based on v1.7.3.0 of FSharpx</p>

    233. 

  233.   <p>Generated by <a href="http://docu.jagregory.com">docu</a></p>

    234. 

  234. </div>

    235. 

  235.   </body>

    236. 

  236. </html>
    237.