This repository was archived by the owner on Jan 3, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 313
Expand file tree
/
Copy patharray3.fsi
More file actions
executable file
·194 lines (166 loc) · 11.2 KB
/
array3.fsi
File metadata and controls
executable file
·194 lines (166 loc) · 11.2 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
// Copyright (c) Microsoft Corporation. All Rights Reserved. See License.txt in the project root for license information.
namespace Microsoft.FSharp.Collections
open System
open Microsoft.FSharp.Collections
open Microsoft.FSharp.Core
open Microsoft.FSharp.Core.Operators
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix)>]
[<RequireQualifiedAccess>]
/// <summary>Basic operations on rank 3 arrays.</summary>
module Array3D =
/// <summary>Creates an array whose elements are all initially the given value.</summary>
/// <param name="length1">The length of the first dimension.</param>
/// <param name="length2">The length of the second dimension.</param>
/// <param name="length3">The length of the third dimension.</param>
/// <param name="initial">The value of the array elements.</param>
/// <returns>The created array.</returns>
[<CompiledName("Create")>]
val create: length1:int -> length2:int -> length3:int -> initial:'T -> 'T[,,]
/// <summary>Creates an array given the dimensions and a generator function to compute the elements.</summary>
/// <param name="length1">The length of the first dimension.</param>
/// <param name="length2">The length of the second dimension.</param>
/// <param name="length3">The length of the third dimension.</param>
/// <param name="initializer">The function to create an initial value at each index into the array.</param>
/// <returns>The created array.</returns>
[<CompiledName("Initialize")>]
val init: length1:int -> length2:int -> length3:int -> initializer:(int -> int -> int -> 'T) -> 'T[,,]
/// <summary>Fetches an element from a 3D array. You can also use the syntax 'array.[index1,index2,index3]'</summary>
/// <param name="array">The input array.</param>
/// <param name="index1">The index along the first dimension.</param>
/// <param name="index2">The index along the second dimension.</param>
/// <param name="index3">The index along the third dimension.</param>
/// <returns>The value at the given index.</returns>
[<CompiledName("Get")>]
val get: array:'T[,,] -> index1:int -> index2:int -> index3:int -> 'T
/// <summary>Applies the given function to each element of the array.</summary>
/// <param name="action">The function to apply to each element of the array.</param>
/// <param name="array">The input array.</param>
[<CompiledName("Iterate")>]
val iter: action:('T -> unit) -> array:'T[,,] -> unit
/// <summary>Applies the given function to each element of the array. The integer indices passed to the
/// function indicates the index of element.</summary>
/// <param name="action">The function to apply to each element of the array.</param>
/// <param name="array">The input array.</param>
[<CompiledName("IterateIndexed")>]
val iteri: action:(int -> int -> int -> 'T -> unit) -> array:'T[,,] -> unit
/// <summary>Returns the length of an array in the first dimension </summary>
/// <param name="array">The input array.</param>
/// <returns>The length of the array in the first dimension.</returns>
[<CompiledName("Length1")>]
val length1: array:'T[,,] -> int
/// <summary>Returns the length of an array in the second dimension.</summary>
/// <param name="array">The input array.</param>
/// <returns>The length of the array in the second dimension.</returns>
[<CompiledName("Length2")>]
val length2: array:'T[,,] -> int
/// <summary>Returns the length of an array in the third dimension.</summary>
/// <param name="array">The input array.</param>
/// <returns>The length of the array in the third dimension.</returns>
[<CompiledName("Length3")>]
val length3: array:'T[,,] -> int
/// <summary>Builds a new array whose elements are the results of applying the given function
/// to each of the elements of the array.</summary>
///
/// <remarks>For non-zero-based arrays the basing on an input array will be propagated to the output
/// array.</remarks>
/// <param name="mapping">The function to transform each element of the array.</param>
/// <param name="array">The input array.</param>
/// <returns>The array created from the transformed elements.</returns>
[<CompiledName("Map")>]
val map: mapping:('T -> 'U) -> array:'T[,,] -> 'U[,,]
/// <summary>Builds a new array whose elements are the results of applying the given function
/// to each of the elements of the array. The integer indices passed to the
/// function indicates the element being transformed.</summary>
///
/// <remarks>For non-zero-based arrays the basing on an input array will be propagated to the output
/// array.</remarks>
/// <param name="mapping">The function to transform the elements at each index in the array.</param>
/// <param name="array">The input array.</param>
/// <returns>The array created from the transformed elements.</returns>
[<CompiledName("MapIndexed")>]
val mapi: mapping:(int -> int -> int -> 'T -> 'U) -> array:'T[,,] -> 'U[,,]
/// <summary>Sets the value of an element in an array. You can also
/// use the syntax 'array.[index1,index2,index3] <- value'.</summary>
/// <param name="array">The input array.</param>
/// <param name="index1">The index along the first dimension.</param>
/// <param name="index2">The index along the second dimension.</param>
/// <param name="index3">The index along the third dimension.</param>
/// <param name="value">The value to set at the given index.</param>
[<CompiledName("Set")>]
val set: array:'T[,,] -> index1:int -> index2:int -> index3:int -> value:'T -> unit
/// <summary>Creates an array where the entries are initially the "default" value.</summary>
/// <param name="length1">The length of the first dimension.</param>
/// <param name="length2">The length of the second dimension.</param>
/// <param name="length3">The length of the third dimension.</param>
/// <returns>The created array.</returns>
[<CompiledName("ZeroCreate")>]
val zeroCreate: length1:int -> length2:int -> length3:int -> 'T[,,]
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix)>]
[<RequireQualifiedAccess>]
/// <summary>Basic operations on rank 4 arrays. </summary>
module Array4D =
/// <summary>Creates an array whose elements are all initially the given value</summary>
/// <param name="length1">The length of the first dimension.</param>
/// <param name="length2">The length of the second dimension.</param>
/// <param name="length3">The length of the third dimension.</param>
/// <param name="length4">The length of the fourth dimension.</param>
/// <param name="initial">The initial value for each element of the array.</param>
/// <returns>The created array.</returns>
[<CompiledName("Create")>]
val create: length1:int -> length2:int -> length3:int -> length4:int -> initial:'T -> 'T[,,,]
/// <summary>Creates an array given the dimensions and a generator function to compute the elements.</summary>
/// <param name="length1">The length of the first dimension.</param>
/// <param name="length2">The length of the second dimension.</param>
/// <param name="length3">The length of the third dimension.</param>
/// <param name="length4">The length of the fourth dimension.</param>
/// <param name="initializer">The function to create an initial value at each index in the array.</param>
/// <returns>The created array.</returns>
[<CompiledName("Initialize")>]
val init: length1:int -> length2:int -> length3:int -> length4:int -> initializer:(int -> int -> int -> int -> 'T) -> 'T[,,,]
/// <summary>Returns the length of an array in the first dimension </summary>
/// <param name="array">The input array.</param>
/// <returns>The length of the array in the first dimension.</returns>
[<CompiledName("Length1")>]
val length1: array:'T[,,,] -> int
/// <summary>Returns the length of an array in the second dimension.</summary>
/// <param name="array">The input array.</param>
/// <returns>The length of the array in the second dimension.</returns>
[<CompiledName("Length2")>]
val length2: array:'T[,,,] -> int
/// <summary>Returns the length of an array in the third dimension.</summary>
/// <param name="array">The input array.</param>
/// <returns>The length of the array in the third dimension.</returns>
[<CompiledName("Length3")>]
val length3: array:'T[,,,] -> int
/// <summary>Returns the length of an array in the fourth dimension.</summary>
/// <param name="array">The input array.</param>
/// <returns>The length of the array in the fourth dimension.</returns>
[<CompiledName("Length4")>]
val length4: array:'T[,,,] -> int
/// <summary>Creates an array where the entries are initially the "default" value.</summary>
/// <param name="length1">The length of the first dimension.</param>
/// <param name="length2">The length of the second dimension.</param>
/// <param name="length3">The length of the third dimension.</param>
/// <param name="length4">The length of the fourth dimension.</param>
/// <returns>The created array.</returns>
[<CompiledName("ZeroCreate")>]
val zeroCreate: length1:int -> length2:int -> length3:int -> length4:int -> 'T[,,,]
/// <summary>Fetches an element from a 4D array. You can also use the syntax 'array.[index1,index2,index3,index4]'</summary>
/// <param name="array">The input array.</param>
/// <param name="index1">The index along the first dimension.</param>
/// <param name="index2">The index along the second dimension.</param>
/// <param name="index3">The index along the third dimension.</param>
/// <param name="index4">The index along the fourth dimension.</param>
/// <returns>The value at the given index.</returns>
[<CompiledName("Get")>]
val get: array:'T[,,,] -> index1:int -> index2:int -> index3:int -> index4:int -> 'T
/// <summary>Sets the value of an element in an array. You can also
/// use the syntax 'array.[index1,index2,index3,index4] <- value'.</summary>
/// <param name="array">The input array.</param>
/// <param name="index1">The index along the first dimension.</param>
/// <param name="index2">The index along the second dimension.</param>
/// <param name="index3">The index along the third dimension.</param>
/// <param name="index4">The index along the fourth dimension.</param>
/// <param name="value">The value to set.</param>
[<CompiledName("Set")>]
val set: array:'T[,,,] -> index1:int -> index2:int -> index3:int -> index4:int -> value:'T -> unit