fable-compiler-netcore

<?xml version="1.0" encoding="utf-8"?> <doc> <assembly><name>FSharp.Core</name></assembly> <members> <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="T:Microsoft.FSharp.Collections.ResizeArray`1"> <summary>An abbreviation for the CLI type <c>System.Collections.Generic.List<_></c></summary> </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="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.GetSlice(Microsoft.FSharp.Core.FSharpOption{System.Int32},Microsoft.FSharp.Core.FSharpOption{System.Int32})"> <summary>Gets a slice of the list, the elements of the list from the given start index to the given end index.</summary> <param name="startIndex">The start index.</param> <param name="endIndex">The end index.</param> <returns>The sub list specified by the input indices.</returns> </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="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. If a binding with the given key already exists in the input map, the existing binding is replaced by the new binding in the result 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="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="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="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 propagated 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 propagated 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.HashIdentity.FromFunctions``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Int32},Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean}})"> <summary>Hash using the given hashing and equality functions.</summary> <param name="hasher">A function to generate a hash code from a value.</param> <param name="equality">A function to test equality of two values.</param> <returns>An object implementing IEqualityComparer using the supplied functions.</returns> </member> <member name="M:Microsoft.FSharp.Collections.HashIdentity.Reference``1"> <summary>Physical hashing (hash on reference identity of objects, and the contents of value types). Hash using LanguagePrimitives.PhysicalEquality and LanguagePrimitives.PhysicalHash, That is, for value types use GetHashCode and Object.Equals (if no other optimization available), and for reference types use System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode and reference equality.</summary> </member> <member name="M:Microsoft.FSharp.Collections.HashIdentity.NonStructural``1"> <summary>Non-structural hashing. Equality using NonStructuralComparison.(=) and NonStructuralComparison.hash.</summary> </member> <member name="M:Microsoft.FSharp.Collections.HashIdentity.Structural``1"> <summary>Structural hashing. Hash using Operators.(=) and Operators.hash.</summary> </member> <member name="T:Microsoft.FSharp.Collections.HashIdentity"> <summary>Common notions of value identity used with hash tables.</summary> </member> <member name="M:Microsoft.FSharp.Collections.ComparisonIdentity.FromFunction``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``0,System.Int32}})"> <summary>Compare using the given comparer function.</summary> <param name="comparer">A function to compare two values.</param> <returns>An object implementing IComparer using the supplied comparer.</returns> </member> <member name="M:Microsoft.FSharp.Collections.ComparisonIdentity.NonStructural``1"> <summary>Non-structural comparison. Compare using NonStructuralComparison.compare.</summary> </member> <member name="M:Microsoft.FSharp.Collections.ComparisonIdentity.Structural``1"> <summary>Structural comparison. Compare using Operators.compare.</summary> </member> <member name="T:Microsoft.FSharp.Collections.ComparisonIdentity"> <summary>Common notions of comparison identity used with sorted data structures.</summary> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Zip3``3(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``1},System.Collections.Generic.IEnumerable{``2})"> <summary>Combines the three sequences into a list of triples. The sequences need not have equal lengths: when one sequence is exhausted any remaining elements in the other sequences are ignored.</summary> <param name="source1">The first input sequence.</param> <param name="source2">The second input sequence.</param> <param name="source3">The third input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when any of the input sequences is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Zip``2(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``1})"> <summary>Combines the two sequences into a list of pairs. The two sequences need not have equal lengths: when one sequence is exhausted any remaining elements in the other sequence are ignored.</summary> <param name="source1">The first input sequence.</param> <param name="source2">The second input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when either of the input sequences is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Windowed``1(System.Int32,System.Collections.Generic.IEnumerable{``0})"> <summary>Returns a sequence that yields sliding windows containing elements drawn from the input sequence. Each window is returned as a fresh array.</summary> <param name="windowSize">The number of elements in each window.</param> <param name="source">The input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> <exception cref="System.ArgumentException">Thrown when windowSize is not positive.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Unfold``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpOption{System.Tuple{``1,``0}}},``0)"> <summary>Returns a sequence that contains the elements generated by the given computation. The given initial <c>state</c> argument is passed to the element generator. For each IEnumerator elements in the stream are generated on-demand by applying the element generator, until a None value is returned by the element generator. Each call to the element generator returns a new residual <c>state</c>.</summary> <remarks>The stream will be recomputed each time an IEnumerator is requested and iterated for the Seq. The returned sequence may be passed between threads safely. However, individual IEnumerator values generated from the returned sequence should not be accessed concurrently.</remarks> <param name="generator">A function that takes in the current state and returns an option tuple of the next element of the sequence and the next state value.</param> <param name="state">The initial state value.</param> <returns>The result sequence.</returns> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Truncate``1(System.Int32,System.Collections.Generic.IEnumerable{``0})"> <summary>Returns a sequence that when enumerated returns at most N elements.</summary> <param name="count">The maximum number of items to enumerate.</param> <param name="source">The input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.TryPick``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpOption{``1}},System.Collections.Generic.IEnumerable{``0})"> <summary>Applies the given function to successive elements, returning the first result where the function returns "Some(x)".</summary> <param name="chooser">A function that transforms items from the input sequence into options.</param> <param name="source">The input sequence.</param> <returns>The chosen element or <c>None</c>.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.TryFindIndexBack``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},System.Collections.Generic.IEnumerable{``0})"> <summary>Returns the index of the last element in the sequence that satisfies the given predicate. Return <c>None</c> if no such element exists.</summary> <remarks>This function digests the whole initial sequence as soon as it is called. As a result this function should not be used with large or infinite sequences.</remarks> <param name="predicate">A function that evaluates to a Boolean when given an item in the sequence.</param> <param name="source">The input sequence.</param> <returns>The found index or <c>None</c>.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> <remarks>This function consumes the whole input sequence before returning the result.</remarks> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.TryItem``1(System.Int32,System.Collections.Generic.IEnumerable{``0})"> <summary>Tries to find the nth element in the sequence. Returns <c>None</c> if index is negative or the input sequence does not contain enough elements.</summary> <param name="index">The index of element to retrieve.</param> <param name="source">The input sequence.</param> <returns>The nth element of the sequence or <c>None</c>.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.TryFindIndex``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},System.Collections.Generic.IEnumerable{``0})"> <summary>Returns the index of the first element in the sequence that satisfies the given predicate. Return <c>None</c> if no such element exists.</summary> <param name="predicate">A function that evaluates to a Boolean when given an item in the sequence.</param> <param name="source">The input sequence.</param> <returns>The found index or None.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.TryFindBack``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},System.Collections.Generic.IEnumerable{``0})"> <summary>Returns the last element for which the given function returns True. Return None if no such element exists.</summary> <remarks>This function digests the whole initial sequence as soon as it is called. As a result this function should not be used with large or infinite sequences.</remarks> <param name="predicate">A function that evaluates to a Boolean when given an item in the sequence.</param> <param name="source">The input sequence.</param> <returns>The found element or None.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> <remarks>This function consumes the whole input sequence before returning the result.</remarks> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.TryFind``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},System.Collections.Generic.IEnumerable{``0})"> <summary>Returns the first element for which the given function returns True. Return None if no such element exists.</summary> <param name="predicate">A function that evaluates to a Boolean when given an item in the sequence.</param> <param name="source">The input sequence.</param> <returns>The found element or None.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.ToList``1(System.Collections.Generic.IEnumerable{``0})"> <summary>Builds a list from the given collection.</summary> <param name="source">The input sequence.</param> <returns>The result list.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.ToArray``1(System.Collections.Generic.IEnumerable{``0})"> <summary>Builds an array from the given collection.</summary> <param name="source">The input sequence.</param> <returns>The result array.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.TakeWhile``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},System.Collections.Generic.IEnumerable{``0})"> <summary>Returns a sequence that, when iterated, yields elements of the underlying sequence while the given predicate returns True, and then returns no further elements.</summary> <param name="predicate">A function that evaluates to false when no more items should be returned.</param> <param name="source">The input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Take``1(System.Int32,System.Collections.Generic.IEnumerable{``0})"> <summary>Returns the first N elements of the sequence.</summary> <remarks>Throws <c>InvalidOperationException</c> if the count exceeds the number of elements in the sequence. <c>Seq.truncate</c> returns as many items as the sequence contains instead of throwing an exception.</remarks> <param name="count">The number of items to take.</param> <param name="source">The input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> <exception cref="System.ArgumentException">Thrown when the input sequence is empty.</exception> <exception cref="System.InvalidOperationException">Thrown when count exceeds the number of elements in the sequence.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Tail``1(System.Collections.Generic.IEnumerable{``0})"> <summary>Returns a sequence that skips 1 element of the underlying sequence and then yields the remaining elements of the sequence.</summary> <param name="source">The input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> <exception cref="System.InvalidOperationException">Thrown when the input sequence is empty.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.SumBy``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},System.Collections.Generic.IEnumerable{``0})"> <summary>Returns the sum of the results generated by applying the function to each element of the sequence.</summary> <remarks>The generated elements are summed using the <c>+</c> operator and <c>Zero</c> property associated with the generated type.</remarks> <param name="projection">A function to transform items from the input sequence into the type that will be summed.</param> <param name="source">The input sequence.</param> <returns>The computed sum.</returns> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Sum``1(System.Collections.Generic.IEnumerable{``0})"> <summary>Returns the sum of the elements in the sequence.</summary> <remarks>The elements are summed using the <c>+</c> operator and <c>Zero</c> property associated with the generated type.</remarks> <param name="source">The input sequence.</param> <returns>The computed sum.</returns> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.SortByDescending``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},System.Collections.Generic.IEnumerable{``0})"> <summary>Applies a key-generating function to each element of a sequence and yield a sequence ordered descending by keys. The keys are compared using generic comparison as implemented by <c>Operators.compare</c>.</summary> <remarks>This function returns a sequence that digests the whole initial sequence as soon as that sequence is iterated. As a result this function should not be used with large or infinite sequences. The function makes no assumption on the ordering of the original sequence. This is a stable sort, that is the original order of equal elements is preserved.</remarks> <param name="projection">A function to transform items of the input sequence into comparable keys.</param> <param name="source">The input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.SortDescending``1(System.Collections.Generic.IEnumerable{``0})"> <summary>Yields a sequence ordered descending by keys.</summary> <remarks>This function returns a sequence that digests the whole initial sequence as soon as that sequence is iterated. As a result this function should not be used with large or infinite sequences. The function makes no assumption on the ordering of the original sequence. This is a stable sort, that is the original order of equal elements is preserved.</remarks> <param name="source">The input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.SortBy``2(Microsoft.FSharp.Core.FSharpFunc{``0,``1},System.Collections.Generic.IEnumerable{``0})"> <summary>Applies a key-generating function to each element of a sequence and yield a sequence ordered by keys. The keys are compared using generic comparison as implemented by <c>Operators.compare</c>.</summary> <remarks>This function returns a sequence that digests the whole initial sequence as soon as that sequence is iterated. As a result this function should not be used with large or infinite sequences. The function makes no assumption on the ordering of the original sequence. This is a stable sort, that is the original order of equal elements is preserved.</remarks> <param name="projection">A function to transform items of the input sequence into comparable keys.</param> <param name="source">The input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.SortWith``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``0,System.Int32}},System.Collections.Generic.IEnumerable{``0})"> <summary>Yields a sequence ordered using the given comparison function.</summary> <remarks>This function returns a sequence that digests the whole initial sequence as soon as that sequence is iterated. As a result this function should not be used with large or infinite sequences. The function makes no assumption on the ordering of the original sequence. This is a stable sort, that is the original order of equal elements is preserved.</remarks> <param name="comparer">The function to compare the collection elements.</param> <param name="list">The input sequence.</param> <returns>The result sequence.</returns> <remarks>This function consumes the whole input sequence before yielding the first element of the result sequence.</remarks> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Sort``1(System.Collections.Generic.IEnumerable{``0})"> <summary>Yields a sequence ordered by keys.</summary> <remarks>This function returns a sequence that digests the whole initial sequence as soon as that sequence is iterated. As a result this function should not be used with large or infinite sequences. The function makes no assumption on the ordering of the original sequence. This is a stable sort, that is the original order of equal elements is preserved.</remarks> <param name="source">The input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> <remarks>This function consumes the whole input sequence before yielding the first element of the result sequence.</remarks> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.SkipWhile``1(Microsoft.FSharp.Core.FSharpFunc{``0,System.Boolean},System.Collections.Generic.IEnumerable{``0})"> <summary>Returns a sequence that, when iterated, skips elements of the underlying sequence while the given predicate returns True, and then yields the remaining elements of the sequence.</summary> <param name="predicate">A function that evaluates an element of the sequence to a boolean value.</param> <param name="source">The input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Skip``1(System.Int32,System.Collections.Generic.IEnumerable{``0})"> <summary>Returns a sequence that skips N elements of the underlying sequence and then yields the remaining elements of the sequence.</summary> <param name="count">The number of items to skip.</param> <param name="source">The input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> <exception cref="System.InvalidOperationException">Thrown when count exceeds the number of elements in the sequence.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Singleton``1(``0)"> <summary>Returns a sequence that yields one item only.</summary> <param name="value">The input item.</param> <returns>The result sequence of one item.</returns> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.ScanBack``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``1,``1}},System.Collections.Generic.IEnumerable{``0},``1)"> <summary>Like <c>foldBack</c>, but returns the sequence of intermediary and final results.</summary> <remarks>This function returns a sequence that digests the whole initial sequence as soon as that sequence is iterated. As a result this function should not be used with large or infinite sequences. </remarks> <param name="folder">A function that updates the state with each element from the sequence.</param> <param name="source">The input sequence.</param> <param name="state">The initial state.</param> <returns>The resulting sequence of computed states.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> <remarks>This function consumes the whole input sequence before yielding the first element of the result sequence.</remarks> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Scan``2(Microsoft.FSharp.Core.FSharpFunc{``1,Microsoft.FSharp.Core.FSharpFunc{``0,``1}},``1,System.Collections.Generic.IEnumerable{``0})"> <summary>Like fold, but computes on-demand and returns the sequence of intermediary and final results.</summary> <param name="folder">A function that updates the state with each element from the sequence.</param> <param name="state">The initial state.</param> <param name="source">The input sequence.</param> <returns>The resulting sequence of computed states.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Reverse``1(System.Collections.Generic.IEnumerable{``0})"> <summary>Returns a new sequence with the elements in reverse order.</summary> <param name="source">The input sequence.</param> <returns>The reversed sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> <remarks>This function consumes the whole input sequence before yielding the first element of the reversed sequence.</remarks> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.ReduceBack``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``0,``0}},System.Collections.Generic.IEnumerable{``0})"> <summary>Applies a function to each element of the sequence, starting from the end, 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>.</summary> <param name="reduction">A function that takes in the next-to-last element of the sequence and the current accumulated result to produce the next accumulated result.</param> <param name="source">The input sequence.</param> <returns>The final result of the reductions.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> <exception cref="System.ArgumentException">Thrown when the input sequence is empty.</exception> <remarks>This function consumes the whole input sequence before returning the result.</remarks> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Replicate``1(System.Int32,``0)"> <summary>Creates a sequence by replicating the given initial value.</summary> <param name="count">The number of elements to replicate.</param> <param name="initial">The value to replicate</param> <returns>The generated sequence.</returns> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Reduce``1(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpFunc{``0,``0}},System.Collections.Generic.IEnumerable{``0})"> <summary>Applies a function to each element of the sequence, threading an accumulator argument through the computation. Begin by applying the function to the first two elements. Then feed this result into the function along with the third element and so on. Return the final result.</summary> <param name="reduction">A function that takes in the current accumulated result and the next element of the sequence to produce the next accumulated result.</param> <param name="source">The input sequence.</param> <returns>The final result of the reduction function.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> <exception cref="System.ArgumentException">Thrown when the input sequence is empty.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.ReadOnly``1(System.Collections.Generic.IEnumerable{``0})"> <summary>Builds a new sequence object that delegates to the given sequence object. This ensures the original sequence cannot be rediscovered and mutated by a type cast. For example, if given an array the returned sequence will return the elements of the array, but you cannot cast the returned sequence object to an array.</summary> <param name="source">The input sequence.</param> <returns>The result sequence.</returns> <exception cref="System.ArgumentNullException">Thrown when the input sequence is null.</exception> </member> <member name="M:Microsoft.FSharp.Collections.SeqModule.Pick``2(Microsoft.FSharp.Core.FSharpFunc{``0,Microsoft.FSharp.Core.FSharpOption{``1}},System.Collections.Generic.IEnumerable{``0})"> <summary>Applies the given function to successive elements, returning the first <c>x</c> where the function returns "Some(x)".</summary> <param name="chooser">A function to transform each item of the input sequence into an option of the output type.</param> <param name="source">The input sequence.</param> <returns>The selected element.</returns> <exception cref="System.ArgumentNullExcep