/
FSharp.Core.xml
10723 lines (9900 loc) · 594 KB
/
FSharp.Core.xml
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly><name>FSharp.Core</name></assembly>
<members>
<member name="">
</member>
<member name="">
</member>
<member name="">
</member>
<member name="">
</member>
<member name="">
</member>
<member name="">
</member>
<member name="T:Microsoft.BuildSettings.BuildDetails">
</member>
<member name="">
</member>
<member name="">
</member>
<member name="">
</member>
<member name="">
</member>
<member name="">
</member>
<member name="T:Microsoft.BuildSettings.Version">
</member>
<member name="">
</member>
<member name="">
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpList`1.Tail">
<summary>Gets the tail of the list, which is a list containing all the elements of the list, excluding the first element </summary>
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpList`1.Length">
<summary>Gets the number of items contained in the list</summary>
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpList`1.Item(System.Int32)">
<summary>Gets the element of the list at the given position.</summary>
<remarks>Lists are represented as linked lists so this is an O(n) operation.</remarks>
<param name="index">The index.</param>
<returns>The value at the given index.</returns>
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpList`1.IsEmpty">
<summary>Gets a value indicating if the list contains no entries</summary>
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpList`1.Head">
<summary>Gets the first element of the list</summary>
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpList`1.Empty">
<summary>Returns an empty list of a particular type</summary>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpList`1.Cons(`0,Microsoft.FSharp.Collections.FSharpList{`0})">
<summary>Returns a list with <c>head</c> as its first element and <c>tail</c> as its subsequent elements</summary>
<param name="head">A new head value for the list.</param>
<param name="tail">The existing list.</param>
<returns>The list with head appended to the front of tail.</returns>
</member>
<member name="T:Microsoft.FSharp.Collections.FSharpList`1">
<summary>The type of immutable singly-linked lists.</summary>
<remarks>Use the constructors <c>[]</c> and <c>::</c> (infix) to create values of this type, or
the notation <c>[1;2;3]</c>. Use the values in the <c>List</c> module to manipulate
values of this type, or pattern match against the values directly.</remarks>
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpMap`2.Item(`0)">
<summary>Lookup an element in the map. Raise <c>KeyNotFoundException</c> if no binding
exists in the map.</summary>
<param name="key">The input key.</param>
<exception cref="System.Collections.Generic.KeyNotFoundException">Thrown when the key is not found.</exception>
<returns>The value mapped to the key.</returns>
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpMap`2.IsEmpty">
<summary>Returns true if there are no bindings in the map.</summary>
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpMap`2.Count">
<summary>The number of bindings in the map.</summary>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpMap`2.TryFind(`0)">
<summary>Lookup an element in the map, returning a <c>Some</c> value if the element is in the domain
of the map and <c>None</c> if not.</summary>
<param name="key">The input key.</param>
<returns>The mapped value, or None if the key is not in the map.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpMap`2.Remove(`0)">
<summary>Removes an element from the domain of the map. No exception is raised if the element is not present.</summary>
<param name="key">The input key.</param>
<returns>The resulting map.</returns>
</member>
<member name="">
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpMap`2.ContainsKey(`0)">
<summary>Tests if an element is in the domain of the map.</summary>
<param name="key">The input key.</param>
<returns>True if the map contains the given key.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpMap`2.Add(`0,`1)">
<summary>Returns a new map with the binding added to the given map.</summary>
<param name="key">The input key.</param>
<returns>The resulting map.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpMap`2.#ctor(System.Collections.Generic.IEnumerable{System.Tuple{`0,`1}})">
<summary>Builds a map that contains the bindings of the given IEnumerable.</summary>
<param name="elements">The input sequence of key/value pairs.</param>
<returns>The resulting map.</returns>
</member>
<member name="T:Microsoft.FSharp.Collections.FSharpMap`2">
<summary>Immutable maps. Keys are ordered by F# generic comparison.</summary>
<remarks>Maps based on generic comparison are efficient for small keys. They are not a suitable choice if keys are recursive data structures
or if keys require bespoke comparison semantics.
All members of this class are thread-safe and may be used concurrently from multiple threads.</remarks>
</member>
<member name="T:Microsoft.FSharp.Collections.ResizeArray`1">
<summary>An abbreviation for the CLI type <c>System.Collections.Generic.List<_></c></summary>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpSet`1.op_Subtraction(Microsoft.FSharp.Collections.FSharpSet{`0},Microsoft.FSharp.Collections.FSharpSet{`0})">
<summary>Returns a new set with the elements of the second set removed from the first.</summary>
<param name="set1">The first input set.</param>
<param name="set2">The second input set.</param>
<returns>A set containing elements of the first set that are not contained in the second set.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpSet`1.op_Addition(Microsoft.FSharp.Collections.FSharpSet{`0},Microsoft.FSharp.Collections.FSharpSet{`0})">
<summary>Compute the union of the two sets.</summary>
<param name="set1">The first input set.</param>
<param name="set2">The second input set.</param>
<returns>The union of the two input sets.</returns>
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpSet`1.MinimumElement">
<summary>Returns the lowest element in the set according to the ordering being used for the set.</summary>
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpSet`1.MaximumElement">
<summary>Returns the highest element in the set according to the ordering being used for the set.</summary>
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpSet`1.IsEmpty">
<summary>A useful shortcut for Set.isEmpty. See the Set module for further operations on sets.</summary>
</member>
<member name="P:Microsoft.FSharp.Collections.FSharpSet`1.Count">
<summary>The number of elements in the set</summary>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpSet`1.Remove(`0)">
<summary>A useful shortcut for Set.remove. Note this operation produces a new set
and does not mutate the original set. The new set will share many storage
nodes with the original. See the Set module for further operations on sets.</summary>
<param name="value">The value to remove from the set.</param>
<returns>The result set.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpSet`1.IsSupersetOf(Microsoft.FSharp.Collections.FSharpSet{`0})">
<summary>Evaluates to "true" if all elements of the second set are in the first.</summary>
<param name="otherSet">The set to test against.</param>
<returns>True if this set is a superset of <c>otherSet</c>.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpSet`1.IsSubsetOf(Microsoft.FSharp.Collections.FSharpSet{`0})">
<summary>Evaluates to "true" if all elements of the first set are in the second.</summary>
<param name="otherSet">The set to test against.</param>
<returns>True if this set is a subset of <c>otherSet</c>.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpSet`1.IsProperSupersetOf(Microsoft.FSharp.Collections.FSharpSet{`0})">
<summary>Evaluates to "true" if all elements of the second set are in the first, and at least
one element of the first is not in the second.</summary>
<param name="otherSet">The set to test against.</param>
<returns>True if this set is a proper superset of <c>otherSet</c>.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpSet`1.IsProperSubsetOf(Microsoft.FSharp.Collections.FSharpSet{`0})">
<summary>Evaluates to "true" if all elements of the first set are in the second, and at least
one element of the second is not in the first.</summary>
<param name="otherSet">The set to test against.</param>
<returns>True if this set is a proper subset of <c>otherSet</c>.</returns>
</member>
<member name="">
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpSet`1.Contains(`0)">
<summary>A useful shortcut for Set.contains. See the Set module for further operations on sets.</summary>
<param name="value">The value to check.</param>
<returns>True if the set contains <c>value</c>.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpSet`1.Add(`0)">
<summary>A useful shortcut for Set.add. Note this operation produces a new set
and does not mutate the original set. The new set will share many storage
nodes with the original. See the Set module for further operations on sets.</summary>
<param name="value">The value to add to the set.</param>
<returns>The result set.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.FSharpSet`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
<summary>Create a set containing elements drawn from the given sequence.</summary>
<param name="elements">The input sequence.</param>
<returns>The result set.</returns>
</member>
<member name="T:Microsoft.FSharp.Collections.FSharpSet`1">
<summary>Immutable sets based on binary trees, where comparison is the
F# structural comparison function, potentially using implementations
of the IComparable interface on key values.</summary>
<remarks>See the Set module for further operations on sets.
All members of this class are thread-safe and may be used concurrently from multiple threads.</remarks>
</member>
<member name="T:Microsoft.FSharp.Collections.list`1">
<summary>An abbreviation for the type of immutable singly-linked lists. </summary>
<remarks>Use the constructors <c>[]</c> and <c>::</c> (infix) to create values of this type, or
the notation <c>[1;2;3]</c>. Use the values in the <c>List</c> module to manipulate
values of this type, or pattern match against the values directly.</remarks>
</member>
<member name="T:Microsoft.FSharp.Collections.seq`1">
<summary>An abbreviation for the CLI type <c>System.Collections.Generic.IEnumerable<_></c></summary>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.Get``1(``0[0:,0:],System.Int32,System.Int32)">
<summary>Fetches an element from a 2D array. You can also use the syntax <c>array.[index1,index2]</c>.</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>
<returns>The value of the array at the given index.</returns>
<exception cref="System.ArgumentException">Thrown when the indices are negative or exceed the bounds of the array.</exception>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.Set``1(``0[0:,0:],System.Int32,System.Int32,``0)">
<summary>Sets the value of an element in an array. You can also use the syntax <c>array.[index1,index2] <- value</c>.</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="value">The value to set in the array.</param>
<exception cref="System.ArgumentException">Thrown when the indices are negative or exceed the bounds of the array.</exception>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.Rebase``1(``0[0:,0:])">
<summary>Builds a new array whose elements are the same as the input array but
where a non-zero-based input array generates a corresponding zero-based
output array.</summary>
<param name="array">The input array.</param>
<returns>The zero-based output array.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.MapIndexed``2(Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{``0,``1}}},``0[0:,0:])">
<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">A function that is applied to transform each element of the array. The two integers
provide the index of the element.</param>
<param name="array">The input array.</param>
<returns>An array whose elements have been transformed by the given mapping.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.Map``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},``0[0:,0:])">
<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 propogated to the output
array.</remarks>
<param name="mapping">A function that is applied to transform each item of the input array.</param>
<param name="array">The input array.</param>
<returns>An array whose elements have been transformed by the given mapping.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.Length2``1(``0[0:,0:])">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.Length1``1(``0[0:,0:])">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.IterateIndexed``1(Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.Unit}}},``0[0:,0:])">
<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">A function to apply to each element of the array with the indices available as an argument.</param>
<param name="array">The input array.</param>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.Iterate``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.Unit},``0[0:,0:])">
<summary>Applies the given function to each element of the array.</summary>
<param name="action">A function to apply to each element of the array.</param>
<param name="array">The input array.</param>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.ZeroCreateBased``1(System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>Creates a based array where the entries are initially Unchecked.defaultof<'T>.</summary>
<param name="base1">The base for the first dimension of the array.</param>
<param name="base2">The base for the second dimension of the array.</param>
<param name="length1">The length of the first dimension of the array.</param>
<param name="length2">The length of the second dimension of the array.</param>
<returns>The created array.</returns>
<exception cref="System.ArgumentException">Thrown when base1, base2, length1, or length2 is negative.</exception>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.CreateBased``1(System.Int32,System.Int32,System.Int32,System.Int32,``0)">
<summary>Creates a based array whose elements are all initially the given value.</summary>
<param name="base1">The base for the first dimension of the array.</param>
<param name="base2">The base for the second dimension of the array.</param>
<param name="length1">The length of the first dimension of the array.</param>
<param name="length2">The length of the second dimension of the array.</param>
<param name="initial">The value to populate the new array.</param>
<returns>The created array.</returns>
<exception cref="System.ArgumentException">Thrown when base1, base2, length1, or length2 is negative.</exception>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.InitializeBased``1(System.Int32,System.Int32,System.Int32,System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,``0}})">
<summary>Creates a based array given the dimensions and a generator function to compute the elements.</summary>
<param name="base1">The base for the first dimension of the array.</param>
<param name="base2">The base for the second dimension of the array.</param>
<param name="length1">The length of the first dimension of the array.</param>
<param name="length2">The length of the second dimension of the array.</param>
<param name="initializer">A function to produce elements of the array given the two indices.</param>
<returns>The created array.</returns>
<exception cref="System.ArgumentException">Thrown when base1, base2, length1, or length2 is negative.</exception>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.ZeroCreate``1(System.Int32,System.Int32)">
<summary>Creates an array where the entries are initially Unchecked.defaultof<'T>.</summary>
<param name="length1">The length of the first dimension of the array.</param>
<param name="length2">The length of the second dimension of the array.</param>
<returns>The created array.</returns>
<exception cref="System.ArgumentException">Thrown when length1 or length2 is negative.</exception>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.Create``1(System.Int32,System.Int32,``0)">
<summary>Creates an array whose elements are all initially the given value.</summary>
<param name="length1">The length of the first dimension of the array.</param>
<param name="length2">The length of the second dimension of the array.</param>
<param name="value">The value to populate the new array.</param>
<returns>The created array.</returns>
<exception cref="System.ArgumentException">Thrown when length1 or length2 is negative.</exception>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.Initialize``1(System.Int32,System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,``0}})">
<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 of the array.</param>
<param name="length2">The length of the second dimension of the array.</param>
<param name="initializer">A function to produce elements of the array given the two indices.</param>
<returns>The generated array.</returns>
<exception cref="System.ArgumentException">Thrown when either of the lengths is negative.</exception>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.CopyTo``1(``0[0:,0:],System.Int32,System.Int32,``0[0:,0:],System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>Reads a range of elements from the first array and write them into the second.</summary>
<param name="source">The source array.</param>
<param name="sourceIndex1">The first-dimension index to begin copying from in the source array.</param>
<param name="sourceIndex2">The second-dimension index to begin copying from in the source array.</param>
<param name="target">The target array.</param>
<param name="targetIndex1">The first-dimension index to begin copying into in the target array.</param>
<param name="targetIndex2">The second-dimension index to begin copying into in the target array.</param>
<param name="length1">The number of elements to copy across the first dimension of the arrays.</param>
<param name="length2">The number of elements to copy across the second dimension of the arrays.</param>
<exception cref="System.ArgumentException">Thrown when any of the indices are negative or if either of
the counts are larger than the dimensions of the array allow.</exception>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.Copy``1(``0[0:,0:])">
<summary>Builds a new array whose elements are the same as the input array.</summary>
<remarks>For non-zero-based arrays the basing on an input array will be propogated to the output
array.</remarks>
<param name="array">The input array.</param>
<returns>A copy of the input array.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.Base2``1(``0[0:,0:])">
<summary>Fetches the base-index for the second dimension of the array.</summary>
<param name="array">The input array.</param>
<returns>The base-index of the second dimension of the array.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.Array2DModule.Base1``1(``0[0:,0:])">
<summary>Fetches the base-index for the first dimension of the array.</summary>
<param name="array">The input array.</param>
<returns>The base-index of the first dimension of the array.</returns>
</member>
<member name="T:Microsoft.FSharp.Collections.Array2DModule">
<summary>Basic operations on 2-dimensional arrays.</summary>
<remarks>F# and CLI multi-dimensional arrays are typically zero-based.
However, CLI multi-dimensional arrays used in conjunction with external
libraries (e.g. libraries associated with Visual Basic) be
non-zero based, using a potentially different base for each dimension.
The operations in this module will accept such arrays, and
the basing on an input array will be propagated to a matching output
array on the <c>Array2D.map</c> and <c>Array2D.mapi</c> operations.
Non-zero-based arrays can also be created using <c>Array2D.zeroCreateBased</c>,
<c>Array2D.createBased</c> and <c>Array2D.initBased</c>.</remarks>
</member>
<member name="M:Microsoft.FSharp.Collections.Array3DModule.ZeroCreate``1(System.Int32,System.Int32,System.Int32)">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array3DModule.Set``1(``0[0:,0:,0:],System.Int32,System.Int32,System.Int32,``0)">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array3DModule.MapIndexed``2(Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{``0,``1}}}},``0[0:,0:,0:])">
<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 propogated 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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array3DModule.Map``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},``0[0:,0:,0:])">
<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 propogated 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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array3DModule.Length3``1(``0[0:,0:,0:])">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array3DModule.Length2``1(``0[0:,0:,0:])">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array3DModule.Length1``1(``0[0:,0:,0:])">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array3DModule.IterateIndexed``1(Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.Unit}}}},``0[0:,0:,0:])">
<summary>Applies the given function to each element of the array. The integer indicies 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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array3DModule.Iterate``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.Unit},``0[0:,0:,0:])">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array3DModule.Get``1(``0[0:,0:,0:],System.Int32,System.Int32,System.Int32)">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array3DModule.Initialize``1(System.Int32,System.Int32,System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,``0}}})">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array3DModule.Create``1(System.Int32,System.Int32,System.Int32,``0)">
<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>
</member>
<member name="T:Microsoft.FSharp.Collections.Array3DModule">
<summary>Basic operations on rank 3 arrays.</summary>
</member>
<member name="M:Microsoft.FSharp.Collections.Array4DModule.Set``1(``0[0:,0:,0:,0:],System.Int32,System.Int32,System.Int32,System.Int32,``0)">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array4DModule.Get``1(``0[0:,0:,0:,0:],System.Int32,System.Int32,System.Int32,System.Int32)">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array4DModule.ZeroCreate``1(System.Int32,System.Int32,System.Int32,System.Int32)">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array4DModule.Length4``1(``0[0:,0:,0:,0:])">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array4DModule.Length3``1(``0[0:,0:,0:,0:])">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array4DModule.Length2``1(``0[0:,0:,0:,0:])">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array4DModule.Length1``1(``0[0:,0:,0:,0:])">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array4DModule.Initialize``1(System.Int32,System.Int32,System.Int32,System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,``0}}}})">
<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>
</member>
<member name="M:Microsoft.FSharp.Collections.Array4DModule.Create``1(System.Int32,System.Int32,System.Int32,System.Int32,``0)">
<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>
</member>
<member name="T:Microsoft.FSharp.Collections.Array4DModule">
<summary>Basic operations on rank 4 arrays. </summary>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Zip3``3(``0[],``1[],``2[])">
<summary>Combines three arrays into an array of pairs. The three arrays must have equal lengths, otherwise an <c>ArgumentException</c> is
raised.</summary>
<param name="array1">The first input array.</param>
<param name="array2">The second input array.</param>
<param name="array3">The third input array.</param>
<exception cref="System.ArgumentException">Thrown when the input arrays differ in length.</exception>
<returns>The array of tupled elements.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Zip``2(``0[],``1[])">
<summary>Combines the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an <c>ArgumentException</c> is
raised.</summary>
<param name="array1">The first input array.</param>
<param name="array2">The second input array.</param>
<exception cref="System.ArgumentException">Thrown when the input arrays differ in length.</exception>
<returns>The array of tupled elements.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Unzip3``3(System.Tuple{``0,``1,``2}[])">
<summary>Splits an array of triples into three arrays.</summary>
<param name="array">The input array.</param>
<returns>The tuple of three arrays.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Unzip``2(System.Tuple{``0,``1}[])">
<summary>Splits an array of pairs into two arrays.</summary>
<param name="array">The input array.</param>
<returns>The two arrays.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.TryFindIndex``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},``0[])">
<summary>Returns the index of the first element in the array
that satisfies the given predicate.</summary>
<param name="predicate">The function to test the input elements.</param>
<param name="array">The input array.</param>
<returns>The index of the first element that satisfies the predicate, or None.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.TryFind``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},``0[])">
<summary>Returns the first element for which the given function returns <c>true</c>.
Return <c>None</c> if no such element exists.</summary>
<param name="predicate">The function to test the input elements.</param>
<param name="array">The input array.</param>
<returns>The first element that satisfies the predicate, or None.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.ToSeq``1(``0[])">
<summary>Views the given array as a sequence.</summary>
<param name="array">The input array.</param>
<returns>The sequence of array elements.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.ToList``1(``0[])">
<summary>Builds a list from the given array.</summary>
<param name="array">The input array.</param>
<returns>The list of array elements.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.SumBy``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},``0[])">
<summary>Returns the sum of the results generated by applying the function to each element of the array.</summary>
<param name="projection">The function to transform the array elements into the type to be summed.</param>
<param name="array">The input array.</param>
<returns>The resulting sum.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Sum``1(``0[])">
<summary>Returns the sum of the elements in the array.</summary>
<param name="array">The input array.</param>
<returns>The resulting sum.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.SortInPlace``1(``0[])">
<summary>Sorts the elements of an array by mutating the array in-place, using the given comparison function.
Elements are compared using Operators.compare.</summary>
<param name="array">The input array.</param>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.SortInPlaceWith``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``0,System.Int32}},``0[])">
<summary>Sorts the elements of an array by mutating the array in-place, using the given comparison function as the order.</summary>
<param name="comparer">The function to compare pairs of array elements.</param>
<param name="array">The input array.</param>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.SortInPlaceBy``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},``0[])">
<summary>Sorts the elements of an array by mutating the array in-place, using the given projection for the keys.
Elements are compared using Operators.compare.</summary>
<remarks>This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved.
For a stable sort, consider using Seq.sort.</remarks>
<param name="projection">The function to transform array elements into the type that is compared.</param>
<param name="array">The input array.</param>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.SortWith``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``0,System.Int32}},``0[])">
<summary>Sorts the elements of an array, using the given comparison function as the order, returning a new array.</summary>
<remarks>This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved.
For a stable sort, consider using Seq.sort.</remarks>
<param name="comparer">The function to compare pairs of array elements.</param>
<param name="array">The input array.</param>
<returns>The sorted array.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.SortBy``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},``0[])">
<summary>Sorts the elements of an array, using the given projection for the keys and returning a new array.
Elements are compared using Operators.compare.</summary>
<remarks>This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved.
For a stable sort, consider using Seq.sort.</remarks>
<param name="projection">The function to transform array elements into the type that is compared.</param>
<param name="array">The input array.</param>
<returns>The sorted array.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Sort``1(``0[])">
<summary>Sorts the elements of an array, returning a new array. Elements are compared using Operators.compare. </summary>
<remarks>This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved.
For a stable sort, consider using Seq.sort.</remarks>
<param name="array">The input array.</param>
<returns>The sorted array.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.GetSubArray``1(``0[],System.Int32,System.Int32)">
<summary>Builds a new array that contains the given subrange specified by
starting index and length.</summary>
<param name="array">The input array.</param>
<param name="startIndex">The index of the first element of the sub array.</param>
<param name="count">The length of the sub array.</param>
<returns>The created sub array.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Set``1(``0[],System.Int32,``0)">
<summary>Sets an element of an array.</summary>
<param name="array">The input array.</param>
<param name="index">The input index.</param>
<param name="value">The input value.</param>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.ScanBack``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,``1}},``0[],``1)">
<summary>Like <c>foldBack</c>, but return both the intermediary and final results.</summary>
<param name="folder">The function to update the state given the input elements.</param>
<param name="array">The input array.</param>
<param name="state">The initial state.</param>
<returns>The array of state values.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Scan``2(Microsoft.FSharp.Core.FSharpFunc{``1,Microsoft.FSharp.Core.FSharpFunc{``0,``1}},``1,``0[])">
<summary>Like <c>fold</c>, but return the intermediary and final results.</summary>
<param name="folder">The function to update the state given the input elements.</param>
<param name="state">The initial state.</param>
<param name="array">The input array.</param>
<returns>The array of state values.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Reverse``1(``0[])">
<summary>Returns a new array with the elements in reverse order.</summary>
<param name="array">The input array.</param>
<returns>The reversed array.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.ReduceBack``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``0,``0}},``0[])">
<summary>Applies 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.</summary>
<param name="reduction">The function to reduce a pair of elements to a single element.</param>
<param name="array">The input array.</param>
<exception cref="System.ArgumentException">Thrown when the input array is empty.</exception>
<returns>The final result of the reductions.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Reduce``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``0,``0}},``0[])">
<summary>Applies 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.</summary>
<param name="reduction">The function to reduce a pair of elements to a single element.</param>
<param name="array">The input array.</param>
<exception cref="System.ArgumentException">Thrown when the input array is empty.</exception>
<returns>The final result of the redcutions.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Permute``1(Microsoft.FSharp.Core.FSharpFunc{System.Int32,System.Int32},``0[])">
<summary>Returns an array with all elements permuted according to the
specified permutation.</summary>
<param name="indexMap">The function that maps input indices to output indices.</param>
<param name="array">The input array.</param>
<returns>The output array.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Partition``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},``0[])">
<summary>Splits the collection into two collections, containing the
elements for which the given predicate returns "true" and "false"
respectively.</summary>
<param name="predicate">The function to test the input elements.</param>
<param name="array">The input array.</param>
<returns>A pair of arrays. The first containing the elements the predicate evaluated to true,
and the second containing those evaluated to false.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.OfSeq``1(System.Collections.Generic.IEnumerable{``0})">
<summary>Builds a new array from the given enumerable object.</summary>
<param name="source">The input sequence.</param>
<returns>The array of elements from the sequence.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.OfList``1(Microsoft.FSharp.Collections.FSharpList{``0})">
<summary>Builds an array from the given list.</summary>
<param name="list">The input list.</param>
<returns>The array of elements from the list.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.MinBy``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},``0[])">
<summary>Returns the lowest of all elements of the array, compared via Operators.min on the function result.</summary>
<remarks>Throws ArgumentException for empty arrays.</remarks>
<param name="projection">The function to transform the elements into a type supporting comparison.</param>
<param name="array">The input array.</param>
<exception cref="System.ArgumentException">Thrown when the input array is empty.</exception>
<returns>The minimum element.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Min``1(``0[])">
<summary>Returns the lowest of all elements of the array, compared via Operators.min.</summary>
<remarks>Throws ArgumentException for empty arrays</remarks>
<param name="array">The input array.</param>
<exception cref="System.ArgumentException">Thrown when the input array is empty.</exception>
<returns>The minimum element.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.MaxBy``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},``0[])">
<summary>Returns the greatest of all elements of the array, compared via Operators.max on the function result.</summary>
<remarks>Throws ArgumentException for empty arrays.</remarks>
<param name="projection">The function to transform the elements into a type supporting comparison.</param>
<param name="array">The input array.</param>
<exception cref="System.ArgumentException">Thrown when the input array is empty.</exception>
<returns>The maximum element.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Max``1(``0[])">
<summary>Returns the greatest of all elements of the array, compared via Operators.max on the function result.</summary>
<remarks>Throws ArgumentException for empty arrays.</remarks>
<param name="array">The input array.</param>
<exception cref="System.ArgumentException">Thrown when the input array is empty.</exception>
<returns>The maximum element.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.MapIndexed``2(Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{``0,``1}},``0[])">
<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 index passed to the
function indicates the index of element being transformed.</summary>
<param name="mapping">The function to transform elements and their indices.</param>
<param name="array">The input array.</param>
<returns>The array of transformed elements.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.MapIndexed2``3(Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,``2}}},``0[],``1[])">
<summary>Builds a new collection whose elements are the results of applying the given function
to the corresponding elements of the two collections pairwise, also passing the index of
the elements. The two input arrays must have the same lengths, otherwise an <c>ArgumentException</c> is
raised.</summary>
<param name="mapping">The function to transform pairs of input elements and their indices.</param>
<param name="array1">The first input array.</param>
<param name="array2">The second input array.</param>
<exception cref="System.ArgumentException">Thrown when the input arrays differ in length.</exception>
<returns>The array of transformed elements.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Map2``3(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,``2}},``0[],``1[])">
<summary>Builds 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.</summary>
<param name="mapping">The function to transform the pairs of the input elements.</param>
<param name="array1">The first input array.</param>
<param name="array2">The second input array.</param>
<exception cref="System.ArgumentException">Thrown when the input arrays differ in length.</exception>
<returns>The array of transformed elements.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Map``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},``0[])">
<summary>Builds a new array whose elements are the results of applying the given function
to each of the elements of the array.</summary>
<param name="mapping">The function to transform elements of the array.</param>
<param name="array">The input array.</param>
<returns>The array of transformed elements.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Length``1(``0[])">
<summary>Returns the length of an array. You can also use property arr.Length.</summary>
<param name="array">The input array.</param>
<returns>The length of the array.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.IterateIndexed2``2(Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,Microsoft.FSharp.Core.Unit}}},``0[],``1[])">
<summary>Applies 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.</summary>
<param name="action">The function to apply to each index and pair of elements.</param>
<param name="array1">The first input array.</param>
<param name="array2">The second input array.</param>
<exception cref="System.ArgumentException">Thrown when the input arrays differ in length.</exception>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.IterateIndexed``1(Microsoft.FSharp.Core.FSharpFunc{System.Int32,Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.Unit}},``0[])">
<summary>Applies the given function to each element of the array. The integer passed to the
function indicates the index of element.</summary>
<param name="action">The function to apply to each index and element.</param>
<param name="array">The input array.</param>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Iterate2``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,Microsoft.FSharp.Core.Unit}},``0[],``1[])">
<summary>Applies the given function to pair of elements drawn from matching indices in two arrays. The
two arrays must have the same lengths, otherwise an <c>ArgumentException</c> is
raised.</summary>
<param name="action">The function to apply.</param>
<param name="array1">The first input array.</param>
<param name="array2">The second input array.</param>
<exception cref="System.ArgumentException">Thrown when the input arrays differ in length.</exception>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Iterate``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.Unit},``0[])">
<summary>Applies the given function to each element of the array.</summary>
<param name="action">The function to apply.</param>
<param name="array">The input array.</param>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.IsEmpty``1(``0[])">
<summary>Returns true if the given array is empty, otherwise false.</summary>
<param name="array">The input array.</param>
<returns>True if the array is empty.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.ZeroCreate``1(System.Int32)">
<summary>Creates an array where the entries are initially the default value Unchecked.defaultof<'T>.</summary>
<param name="count">The length of the array to create.</param>
<returns>The created array.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Initialize``1(System.Int32,Microsoft.FSharp.Core.FSharpFunc{System.Int32,``0})">
<summary>Creates an array given the dimension and a generator function to compute the elements.</summary>
<param name="count">The number of elements to initialize.</param>
<param name="initializer">The function to generate the initial values for each index.</param>
<returns>The created array.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Get``1(``0[],System.Int32)">
<summary>Gets an element from an array.</summary>
<param name="array">The input array.</param>
<param name="index">The input index.</param>
<returns>The value of the array at the given index.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.FoldBack2``3(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,Microsoft.FSharp.Core.FSharpFunc{``2,``2}}},``0[],``1[],``2)">
<summary>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.</summary>
<param name="folder">The function to update the state given the input elements.</param>
<param name="array1">The first input array.</param>
<param name="array2">The second input array.</param>
<param name="state">The initial state.</param>
<exception cref="System.ArgumentException">Thrown when the input arrays differ in length.</exception>
<returns>The final state.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Fold2``3(Microsoft.FSharp.Core.FSharpFunc{``2,Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,``2}}},``2,``0[],``1[])">
<summary>Applies 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.</summary>
<param name="folder">The function to update the state given the input elements.</param>
<param name="state">The initial state.</param>
<param name="array1">The first input array.</param>
<param name="array2">The second input array.</param>
<exception cref="System.ArgumentException">Thrown when the input arrays differ in length.</exception>
<returns>The final state.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.FoldBack``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,``1}},``0[],``1)">
<summary>Applies 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></summary>
<param name="folder">The function to update the state given the input elements.</param>
<param name="array">The input array.</param>
<param name="state">The initial state.</param>
<returns>The final state.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Fold``2(Microsoft.FSharp.Core.FSharpFunc{``1,Microsoft.FSharp.Core.FSharpFunc{``0,``1}},``1,``0[])">
<summary>Applies 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></summary>
<param name="folder">The function to update the state given the input elements.</param>
<param name="state">The initial state.</param>
<param name="array">The input array.</param>
<returns>The final state.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.ForAll2``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,System.Boolean}},``0[],``1[])">
<summary>Tests if all corresponding elements of the array satisfy the given predicate pairwise.</summary>
<remarks>The predicate is applied to matching elements in the two collections up to the lesser of the
two lengths of the collections. If any application returns false then the overall result is
false and no further elements are tested. Otherwise, if one collection is longer
than the other then the <c>ArgumentException</c> exception is raised.
Otherwise, true is returned.</remarks>
<param name="predicate">The function to test the input elements.</param>
<param name="array1">The first input array.</param>
<param name="array2">The second input array.</param>
<exception cref="System.ArgumentException">Thrown when the input arrays differ in length.</exception>
<returns>True if all of the array elements satisfy the predicate.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.ForAll``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},``0[])">
<summary>Tests if all elements of the array satisfy the given predicate.</summary>
<remarks>The predicate is applied to the elements of the input collection. If any application
returns false then the overall result is false and no further elements are tested.
Otherwise, true is returned.</remarks>
<param name="predicate">The function to test the input elements.</param>
<param name="array">The input array.</param>
<returns>True if all of the array elements satisfy the predicate.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.FindIndex``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},``0[])">
<summary>Returns the index of the first element in the array
that satisfies the given predicate. Raise <c>KeyNotFoundException</c> if
none of the elements satisy the predicate.</summary>
<param name="predicate">The function to test the input elements.</param>
<param name="array">The input array.</param>
<exception cref="System.Collections.Generic.KeyNotFoundException">Thrown if <c>predicate</c>
never returns true.</exception>
<returns>The index of the first element in the array that satisfies the given predicate.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Find``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},``0[])">
<summary>Returns the first element for which the given function returns 'true'.
Raise <c>KeyNotFoundException</c> if no such element exists.</summary>
<param name="predicate">The function to test the input elements.</param>
<param name="array">The input array.</param>
<exception cref="System.Collections.Generic.KeyNotFoundException">Thrown if <c>predicate</c>
never returns true.</exception>
<returns>The first element for which <c>predicate</c> returns true.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Filter``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},``0[])">
<summary>Returns a new collection containing only the elements of the collection
for which the given predicate returns "true".</summary>
<param name="predicate">The function to test the input elements.</param>
<param name="array">The input array.</param>
<returns>An array containing the elements for which the given predicate returns true.</returns>
</member>
<member name="M:Microsoft.FSharp.Collections.ArrayModule.Exists2``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,System.Boolean}},``0[],``1[])">
<summary>Tests if any pair of corresponding elements of the arrays satisfies the given predicate.</summary>
<remarks>The predicate is applied to matching elements in the two collections up to the lesser of the
two lengths of the collections. If any application returns true then the overall result is
true and no further elements are tested. Otherwise, if one collections is longer
than the other then the <c>ArgumentException</c> exception is raised.
Otherwise, false is returned.</remarks>
<param name="predicate">The function to test the input elements.</param>
<param name="array1">The first input array.</param>
<param name="array2">The second input array.</param>