forked from dotnet/fsharp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathResizeArray.fsi
More file actions
222 lines (165 loc) · 11 KB
/
Copy pathResizeArray.fsi
File metadata and controls
222 lines (165 loc) · 11 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
// Copyright (c) Microsoft Corporation. All Rights Reserved. See License.txt in the project root for license information.
namespace Internal.Utilities
open System
open System.Collections.Generic
open Microsoft.FSharp.Core
open Microsoft.FSharp.Collections
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix)>]
/// Generic operations on the type System.Collections.Generic.List, which is called ResizeArray in the F# libraries.
module internal ResizeArray =
/// Return the length of the collection. You can also use property <c>arr.Length</c>.
val length: ResizeArray<'T> -> int
/// Fetch an element from the collection. You can also use the syntax <c>arr.[idx]</c>.
val get: ResizeArray<'T> -> int -> 'T
/// Set the value of an element in the collection. You can also use the syntax <c>arr.[idx] <- e</c>.
val set: ResizeArray<'T> -> int -> 'T -> unit
/// Create an array whose elements are all initially the given value.
val create: int -> 'T -> ResizeArray<'T>
/// Create an array by calling the given generator on each index.
val init: int -> (int -> 'T) -> ResizeArray<'T>
/// Build a new array that contains the elements of the first array followed by the elements of the second array.
val append: ResizeArray<'T> -> ResizeArray<'T> -> ResizeArray<'T>
/// Build a new array that contains the elements of each of the given list of arrays.
val concat: ResizeArray<'T> list -> ResizeArray<'T>
/// Build a new array that contains the given subrange specified by
/// starting index and length.
val sub: ResizeArray<'T> -> int -> int -> ResizeArray<'T>
/// Build a new array that contains the elements of the given array.
val copy: ResizeArray<'T> -> ResizeArray<'T>
/// Fill a range of the collection with the given element.
val fill: ResizeArray<'T> -> int -> int -> 'T -> unit
/// Read a range of elements from the first array and write them into the second.
val blit: ResizeArray<'T> -> int -> ResizeArray<'T> -> int -> int -> unit
/// Build a list from the given array.
val toList: ResizeArray<'T> -> 'T list
/// Build an array from the given list.
val ofList: 'T list -> ResizeArray<'T>
/// Apply a function to each element of the collection, threading an accumulator argument
/// through the computation. If the input function is <c>f</c> and the elements are <c>i0...iN</c>
/// then computes <c>f (... (f s i0)...) iN</c>
val fold: ('T -> 'U -> 'T) -> 'T -> ResizeArray<'U> -> 'T
/// Apply a function to each element of the array, threading an accumulator argument
/// through the computation. If the input function is <c>f</c> and the elements are <c>i0...iN</c> then
/// computes <c>f i0 (...(f iN s))</c>.
val foldBack: ('T -> 'U -> 'U) -> ResizeArray<'T> -> 'U -> 'U
/// Apply the given function to each element of the array.
val iter: ('T -> unit) -> ResizeArray<'T> -> unit
/// Build a new array whose elements are the results of applying the given function
/// to each of the elements of the array.
val map: ('T -> 'U) -> ResizeArray<'T> -> ResizeArray<'U>
/// Apply the given function to two arrays simultaneously. The
/// two arrays must have the same lengths, otherwise an Invalid_argument exception is
/// raised.
val iter2: ('T -> 'U -> unit) -> ResizeArray<'T> -> ResizeArray<'U> -> unit
/// Build a new collection whose elements are the results of applying the given function
/// to the corresponding elements of the two collections pairwise. The two input
/// arrays must have the same lengths.
val map2: ('T -> 'U -> 'c) -> ResizeArray<'T> -> ResizeArray<'U> -> ResizeArray<'c>
/// Apply the given function to each element of the array. The integer passed to the
/// function indicates the index of element.
val iteri: (int -> 'T -> unit) -> ResizeArray<'T> -> unit
/// Build a new array whose elements are the results of applying the given function
/// to each of the elements of the array. The integer index passed to the
/// function indicates the index of element being transformed.
val mapi: (int -> 'T -> 'U) -> ResizeArray<'T> -> ResizeArray<'U>
/// Test if any element of the array satisfies the given predicate.
/// If the input function is <c>f</c> and the elements are <c>i0...iN</c>
/// then computes <c>p i0 or ... or p iN</c>.
val exists: ('T -> bool) -> ResizeArray<'T> -> bool
/// Test if all elements of the array satisfy the given predicate.
/// If the input function is <c>f</c> and the elements are <c>i0...iN</c> and "j0...jN"
/// then computes <c>p i0 && ... && p iN</c>.
val forall: ('T -> bool) -> ResizeArray<'T> -> bool
/// Return a new collection containing only the elements of the collection
/// for which the given predicate returns True.
val filter: ('T -> bool) -> ResizeArray<'T> -> ResizeArray<'T>
/// Split the collection into two collections, containing the
/// elements for which the given predicate returns True and False
/// respectively.
val partition: ('T -> bool) -> ResizeArray<'T> -> ResizeArray<'T> * ResizeArray<'T>
/// Apply the given function to each element of the array. Return
/// the array comprised of the results "x" for each element where
/// the function returns <c>Some(x)</c>.
val choose: ('T -> 'U option) -> ResizeArray<'T> -> ResizeArray<'U>
/// Return the first element for which the given function returns True.
/// Raise <c>KeyNotFoundException</c> if no such element exists.
val find: ('T -> bool) -> ResizeArray<'T> -> 'T
/// Return the first element for which the given function returns True.
/// Return None if no such element exists.
val tryFind: ('T -> bool) -> ResizeArray<'T> -> 'T option
/// Apply the given function to successive elements, returning the first
/// result where function returns Some(x) for some x.
val tryPick: ('T -> 'U option) -> ResizeArray<'T> -> 'U option
/// Return a new array with the elements in reverse order.
val rev: ResizeArray<'T> -> ResizeArray<'T>
/// Sort the elements using the given comparison function.
val sort: ('T -> 'T -> int) -> ResizeArray<'T> -> unit
/// Sort the elements using the key extractor and generic comparison on the keys.
val sortBy: ('T -> 'Key) -> ResizeArray<'T> -> unit when 'Key : comparison
/// Return a fixed-length array containing the elements of the input <c>ResizeArray</c>.
val toArray : ResizeArray<'T> -> 'T[]
/// Build a <c>ResizeArray</c> from the given elements.
val ofArray : 'T[] -> ResizeArray<'T>
/// Return a view of the array as an enumerable object.
val toSeq : ResizeArray<'T> -> seq<'T>
/// Test elements of the two arrays pairwise to see if any pair of element satisfies the given predicate.
/// Raise ArgumentException if the arrays have different lengths.
val exists2 : ('T -> 'U -> bool) -> ResizeArray<'T> -> ResizeArray<'U> -> bool
/// Return the index of the first element in the array
/// that satisfies the given predicate. Raise <c>KeyNotFoundException</c> if
/// none of the elements satisfy the predicate.
val findIndex : ('T -> bool) -> ResizeArray<'T> -> int
/// Return the index of the first element in the array
/// that satisfies the given predicate. Raise <c>KeyNotFoundException</c> if
/// none of the elements satisfy the predicate.
val findIndexi : (int -> 'T -> bool) -> ResizeArray<'T> -> int
/// Apply a function to each element of the array, threading an accumulator argument
/// through the computation. If the input function is <c>f</c> and the elements are <c>i0...iN</c>
/// then computes <c>f (... (f i0 i1)...) iN</c>. Raises ArgumentException if the array has size zero.
val reduce : ('T -> 'T -> 'T) -> ResizeArray<'T> -> 'T
/// Apply a function to each element of the array, threading an accumulator argument
/// through the computation. If the input function is <c>f</c> and the elements are <c>i0...iN</c> then
/// computes <c>f i0 (...(f iN-1 iN))</c>. Raises ArgumentException if the array has size zero.
val reduceBack : ('T -> 'T -> 'T) -> ResizeArray<'T> -> 'T
/// Apply a function to pairs of elements drawn from the two collections,
/// left-to-right, threading an accumulator argument
/// through the computation. The two input
/// arrays must have the same lengths, otherwise an <c>ArgumentException</c> is
/// raised.
val fold2: ('state -> 'b1 -> 'b2 -> 'state) -> 'state -> ResizeArray<'b1> -> ResizeArray<'b2> -> 'state
/// Apply a function to pairs of elements drawn from the two collections, right-to-left,
/// threading an accumulator argument through the computation. The two input
/// arrays must have the same lengths, otherwise an <c>ArgumentException</c> is
/// raised.
val foldBack2 : ('a1 -> 'a2 -> 'U -> 'U) -> ResizeArray<'a1> -> ResizeArray<'a2> -> 'U -> 'U
/// Test elements of the two arrays pairwise to see if all pairs of elements satisfy the given predicate.
/// Raise <c>ArgumentException</c> if the arrays have different lengths.
val forall2 : ('T -> 'U -> bool) -> ResizeArray<'T> -> ResizeArray<'U> -> bool
/// Return True if the given array is empty, otherwise False.
val isEmpty : ResizeArray<'T> -> bool
/// Apply the given function to pair of elements drawn from matching indices in two arrays,
/// also passing the index of the elements. The two arrays must have the same lengths,
/// otherwise an <c>ArgumentException</c> is raised.
val iteri2 : (int -> 'T -> 'U -> unit) -> ResizeArray<'T> -> ResizeArray<'U> -> unit
/// Build a new collection whose elements are the results of applying the given function
/// to the corresponding elements of the two collections pairwise. The two input
/// arrays must have the same lengths, otherwise an <c>ArgumentException</c> is
/// raised.
val mapi2 : (int -> 'T -> 'U -> 'c) -> ResizeArray<'T> -> ResizeArray<'U> -> ResizeArray<'c>
/// Like <c>fold</c>, but return the intermediary and final results.
val scan : ('U -> 'T -> 'U) -> 'U -> ResizeArray<'T> -> ResizeArray<'U>
/// Like <c>foldBack</c>, but return both the intermediary and final results.
val scanBack : ('T -> 'c -> 'c) -> ResizeArray<'T> -> 'c -> ResizeArray<'c>
/// Return an array containing the given element.
val singleton : 'T -> ResizeArray<'T>
/// Return the index of the first element in the array
/// that satisfies the given predicate.
val tryFindIndex : ('T -> bool) -> ResizeArray<'T> -> int option
/// Return the index of the first element in the array
/// that satisfies the given predicate.
val tryFindIndexi : (int -> 'T -> bool) -> ResizeArray<'T> -> int option
/// Combine the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an <c>ArgumentException</c> is
/// raised..
val zip : ResizeArray<'T> -> ResizeArray<'U> -> ResizeArray<'T * 'U>
/// Split an array of pairs into two arrays.
val unzip : ResizeArray<'T * 'U> -> ResizeArray<'T> * ResizeArray<'U>