Voozh

List Module

Namespace: FSharp.Collections
Assembly: FSharp.Core.dll

Contains operations for working with values of type list.

Functions and values

Function or value	Description
`List.allPairs list1 list2` Full Usage: `List.allPairs list1 list2` Parameters: list1 : `'T1 list` - The first input list. list2 : `'T2 list` - The second input list. Returns: `('T1 * 'T2) list` The resulting list of pairs. Type parameters: 'T1, 'T2
`List.append list1 list2` Full Usage: `List.append list1 list2` Parameters: list1 : `'T list` - The first input list. list2 : `'T list` - The second input list. Returns: `'T list` The resulting list. Type parameters: 'T
`List.average list` Full Usage: `List.average list` Parameters: list : `^T list` - The input list. Returns: `^T` The resulting average. Modifiers: inline Type parameters: ^T (requires (static member op_Addition : ^T * ^T -> ^T) and (static member DivideByInt : ^T * Microsoft.FSharp.Core.int -> ^T) and (static member get_Zero : -> ^T))
`List.averageBy projection list` Full Usage: `List.averageBy projection list` Parameters: projection : `'T -> ^U` - The function to transform the list elements into the values to be averaged. list : `'T list` - The input list. Returns: `^U` The resulting average. Modifiers: inline Type parameters: 'T, ^U (requires (static member op_Addition : ^U * ^U -> ^U) and (static member DivideByInt : ^U * Microsoft.FSharp.Core.int -> ^U) and (static member get_Zero : -> ^U))
`List.choose chooser list` Full Usage: `List.choose chooser list` Parameters: chooser : `'T -> 'U option` - The function to be applied to the list elements. list : `'T list` - The input list. Returns: `'U list` The resulting list comprising the values `v` where the chooser function returned `Some(x)`. Type parameters: 'T, 'U
`List.chunkBySize chunkSize list` Full Usage: `List.chunkBySize chunkSize list` Parameters: chunkSize : `int` - The maximum size of each chunk. list : `'T list` - The input list. Returns: `'T list list` The list divided into chunks. Type parameters: 'T
`List.collect mapping list` Full Usage: `List.collect mapping list` Parameters: mapping : `'T -> 'U list` - The function to transform each input element into a sublist to be concatenated. list : `'T list` - The input list. Returns: `'U list` The concatenation of the transformed sublists. Type parameters: 'T, 'U
`List.compareWith comparer list1 list2` Full Usage: `List.compareWith comparer list1 list2` Parameters: comparer : `'T -> 'T -> int` - A function that takes an element from each list and returns an int. If it evaluates to a non-zero value iteration is stopped and that value is returned. list1 : `'T list` - The first input list. list2 : `'T list` - The second input list. Returns: `int` Returns the first non-zero result from the comparison function. If the first list has a larger element, the return value is always positive. If the second list has a larger element, the return value is always negative. When the elements are equal in the two lists, 1 is returned if the first list is longer, 0 is returned if they are equal in length, and -1 is returned when the second list is longer. Modifiers: inline Type parameters: 'T
`List.concat lists` Full Usage: `List.concat lists` Parameters: lists : `'T list seq` - The input sequence of lists. Returns: `'T list` The resulting concatenated list. Type parameters: 'T
`List.contains value source` Full Usage: `List.contains value source` Parameters: value : `'T` - The value to locate in the input list. source : `'T list` - The input list. Returns: `bool` True if the input list contains the specified element; false otherwise. Modifiers: inline Type parameters: 'T (requires equality)
`List.countBy projection list` Full Usage: `List.countBy projection list` Parameters: projection : `'T -> 'Key` - A function transforming each item of the input list into a key to be compared against the others. list : `'T list` - The input list. Returns: `('Key * int) list` The result list. Type parameters: 'T, 'Key (requires equality)
`List.distinct list` Full Usage: `List.distinct list` Parameters: list : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T (requires equality)
`List.distinctBy projection list` Full Usage: `List.distinctBy projection list` Parameters: projection : `'T -> 'Key` - A function transforming the list items into comparable keys. list : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T, 'Key (requires equality)
`List.empty` Full Usage: `List.empty` Returns: `'T list` Type parameters: 'T
`List.exactlyOne list` Full Usage: `List.exactlyOne list` Parameters: list : `'T list` - The input list. Returns: `'T` The only element of the list. Type parameters: 'T
`List.except itemsToExclude list` Full Usage: `List.except itemsToExclude list` Parameters: itemsToExclude : `'T seq` - A sequence whose elements that also occur in the input list will cause those elements to be removed from the result. list : `'T list` - A list whose elements that are not also in itemsToExclude will be returned. Returns: `'T list` A list that contains the distinct elements of `list` that do not appear in `itemsToExclude`. Type parameters: 'T (requires equality)
`List.exists predicate list` Full Usage: `List.exists predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `bool` True if any element satisfies the predicate. Type parameters: 'T
`List.exists2 predicate list1 list2` Full Usage: `List.exists2 predicate list1 list2` Parameters: predicate : `'T1 -> 'T2 -> bool` - The function to test the input elements. list1 : `'T1 list` - The first input list. list2 : `'T2 list` - The second input list. Returns: `bool` True if any pair of elements satisfy the predicate. Type parameters: 'T1, 'T2
`List.filter predicate list` Full Usage: `List.filter predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `'T list` A list containing only the elements that satisfy the predicate. Type parameters: 'T
`List.find predicate list` Full Usage: `List.find predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `'T` The first element that satisfies the predicate. Type parameters: 'T
`List.findBack predicate list` Full Usage: `List.findBack predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `'T` The last element that satisfies the predicate. Type parameters: 'T
`List.findIndex predicate list` Full Usage: `List.findIndex predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `int` The index of the first element that satisfies the predicate. Type parameters: 'T
`List.findIndexBack predicate list` Full Usage: `List.findIndexBack predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `int` The index of the last element that satisfies the predicate. Type parameters: 'T
`List.fold folder state list` Full Usage: `List.fold folder state list` Parameters: folder : `'State -> 'T -> 'State` - The function to update the state given the input elements. state : `'State` - The initial state. list : `'T list` - The input list. Returns: `'State` The final state value. Type parameters: 'T, 'State
`List.fold2 folder state list1 list2` Full Usage: `List.fold2 folder state list1 list2` Parameters: folder : `'State -> 'T1 -> 'T2 -> 'State` - The function to update the state given the input elements. state : `'State` - The initial state. list1 : `'T1 list` - The first input list. list2 : `'T2 list` - The second input list. Returns: `'State` The final state value. Type parameters: 'T1, 'T2, 'State
`List.foldBack folder list state` Full Usage: `List.foldBack folder list state` Parameters: folder : `'T -> 'State -> 'State` - The function to update the state given the input elements. list : `'T list` - The input list. state : `'State` - The initial state. Returns: `'State` The state object after the folding function is applied to each element of the list. Type parameters: 'T, 'State
`List.foldBack2 folder list1 list2 state` Full Usage: `List.foldBack2 folder list1 list2 state` Parameters: folder : `'T1 -> 'T2 -> 'State -> 'State` - The function to update the state given the input elements. list1 : `'T1 list` - The first input list. list2 : `'T2 list` - The second input list. state : `'State` - The initial state. Returns: `'State` The final state value. Type parameters: 'T1, 'T2, 'State
`List.forall predicate list` Full Usage: `List.forall predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `bool` True if all of the elements satisfy the predicate. Type parameters: 'T
`List.forall2 predicate list1 list2` Full Usage: `List.forall2 predicate list1 list2` Parameters: predicate : `'T1 -> 'T2 -> bool` - The function to test the input elements. list1 : `'T1 list` - The first input list. list2 : `'T2 list` - The second input list. Returns: `bool` True if all of the pairs of elements satisfy the predicate. Type parameters: 'T1, 'T2
`List.groupBy projection list` Full Usage: `List.groupBy projection list` Parameters: projection : `'T -> 'Key` - A function that transforms an element of the list into a comparable key. list : `'T list` - The input list. Returns: `('Key * 'T list) list` The result list. Type parameters: 'T, 'Key (requires equality)
`List.head list` Full Usage: `List.head list` Parameters: list : `'T list` - The input list. Returns: `'T` The first element of the list. Type parameters: 'T
`List.indexed list` Full Usage: `List.indexed list` Parameters: list : `'T list` - The input list. Returns: `(int * 'T) list` The list of indexed elements. Type parameters: 'T
`List.init length initializer` Full Usage: `List.init length initializer` Parameters: length : `int` - The length of the list to generate. initializer : `int -> 'T` - The function to generate an element from an index. Returns: `'T list` The list of generated elements. Type parameters: 'T
`List.insertAt index value source` Full Usage: `List.insertAt index value source` Parameters: index : `int` - The index where the item should be inserted. value : `'T` - The value to insert. source : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T
`List.insertManyAt index values source` Full Usage: `List.insertManyAt index values source` Parameters: index : `int` - The index where the items should be inserted. values : `'T seq` - The values to insert. source : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T
`List.isEmpty list` Full Usage: `List.isEmpty list` Parameters: list : `'T list` - The input list. Returns: `bool` True if the list is empty. Type parameters: 'T
`List.item index list` Full Usage: `List.item index list` Parameters: index : `int` - The index to retrieve. list : `'T list` - The input list. Returns: `'T` The value at the given index. Type parameters: 'T
`List.iter action list` Full Usage: `List.iter action list` Parameters: action : `'T -> unit` - The function to apply to elements from the input list. list : `'T list` - The input list. Modifiers: inline Type parameters: 'T
`List.iter2 action list1 list2` Full Usage: `List.iter2 action list1 list2` Parameters: action : `'T1 -> 'T2 -> unit` - The function to apply to pairs of elements from the input lists. list1 : `'T1 list` - The first input list. list2 : `'T2 list` - The second input list. Type parameters: 'T1, 'T2
`List.iteri action list` Full Usage: `List.iteri action list` Parameters: action : `int -> 'T -> unit` - The function to apply to the elements of the list along with their index. list : `'T list` - The input list. Modifiers: inline Type parameters: 'T
`List.iteri2 action list1 list2` Full Usage: `List.iteri2 action list1 list2` Parameters: action : `int -> 'T1 -> 'T2 -> unit` - The function to apply to a pair of elements from the input lists along with their index. list1 : `'T1 list` - The first input list. list2 : `'T2 list` - The second input list. Type parameters: 'T1, 'T2
`List.last list` Full Usage: `List.last list` Parameters: list : `'T list` - The input list. Returns: `'T` The last element of the list. Type parameters: 'T
`List.length list` Full Usage: `List.length list` Parameters: list : `'T list` - The input list. Returns: `int` The length of the list. Type parameters: 'T
`List.map mapping list` Full Usage: `List.map mapping list` Parameters: mapping : `'T -> 'U` - The function to transform elements from the input list. list : `'T list` - The input list. Returns: `'U list` The list of transformed elements. Type parameters: 'T, 'U
`List.map2 mapping list1 list2` Full Usage: `List.map2 mapping list1 list2` Parameters: mapping : `'T1 -> 'T2 -> 'U` - The function to transform pairs of elements from the input lists. list1 : `'T1 list` - The first input list. list2 : `'T2 list` - The second input list. Returns: `'U list` The list of transformed elements. Type parameters: 'T1, 'T2, 'U
`List.map3 mapping list1 list2 list3` Full Usage: `List.map3 mapping list1 list2 list3` Parameters: mapping : `'T1 -> 'T2 -> 'T3 -> 'U` - The function to transform triples of elements from the input lists. list1 : `'T1 list` - The first input list. list2 : `'T2 list` - The second input list. list3 : `'T3 list` - The third input list. Returns: `'U list` The list of transformed elements. Type parameters: 'T1, 'T2, 'T3, 'U
`List.mapFold mapping state list` Full Usage: `List.mapFold mapping state list` Parameters: mapping : `'State -> 'T -> 'Result * 'State` - The function to transform elements from the input list and accumulate the final value. state : `'State` - The initial state. list : `'T list` - The input list. Returns: `'Result list * 'State` The list of transformed elements, and the final accumulated value. Type parameters: 'T, 'State, 'Result
`List.mapFoldBack mapping list state` Full Usage: `List.mapFoldBack mapping list state` Parameters: mapping : `'T -> 'State -> 'Result * 'State` - The function to transform elements from the input list and accumulate the final value. list : `'T list` - The input list. state : `'State` - The initial state. Returns: `'Result list * 'State` The list of transformed elements, and the final accumulated value. Type parameters: 'T, 'State, 'Result
`List.mapi mapping list` Full Usage: `List.mapi mapping list` Parameters: mapping : `int -> 'T -> 'U` - The function to transform elements and their indices. list : `'T list` - The input list. Returns: `'U list` The list of transformed elements. Type parameters: 'T, 'U
`List.mapi2 mapping list1 list2` Full Usage: `List.mapi2 mapping list1 list2` Parameters: mapping : `int -> 'T1 -> 'T2 -> 'U` - The function to transform pairs of elements from the two lists and their index. list1 : `'T1 list` - The first input list. list2 : `'T2 list` - The second input list. Returns: `'U list` The list of transformed elements. Type parameters: 'T1, 'T2, 'U
`List.max list` Full Usage: `List.max list` Parameters: list : `'T list` - The input list. Returns: `'T` The maximum element. Modifiers: inline Type parameters: 'T (requires comparison)
`List.maxBy projection list` Full Usage: `List.maxBy projection list` Parameters: projection : `'T -> 'U` - The function to transform the list elements into the type to be compared. list : `'T list` - The input list. Returns: `'T` The maximum element. Modifiers: inline Type parameters: 'T, 'U (requires comparison)
`List.min list` Full Usage: `List.min list` Parameters: list : `'T list` - The input list. Returns: `'T` The minimum value. Modifiers: inline Type parameters: 'T (requires comparison)
`List.minBy projection list` Full Usage: `List.minBy projection list` Parameters: projection : `'T -> 'U` - The function to transform list elements into the type to be compared. list : `'T list` - The input list. Returns: `'T` The minimum value. Modifiers: inline Type parameters: 'T, 'U (requires comparison)
`List.ofArray array` Full Usage: `List.ofArray array` Parameters: array : `'T array` - The input array. Returns: `'T list` The list of elements from the array. Type parameters: 'T
`List.ofSeq source` Full Usage: `List.ofSeq source` Parameters: source : `'T seq` - The input sequence. Returns: `'T list` The list of elements from the sequence. Type parameters: 'T
`List.pairwise list` Full Usage: `List.pairwise list` Parameters: list : `'T list` - The input list. Returns: `('T * 'T) list` The result list. Type parameters: 'T
`List.partition predicate list` Full Usage: `List.partition predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `'T list * 'T list` A list containing the elements for which the predicate evaluated to true and a list containing the elements for which the predicate evaluated to false. Type parameters: 'T
`List.partitionWith partitioner list` Full Usage: `List.partitionWith partitioner list` Parameters: partitioner : `'T -> Choice<'T1, 'T2>` - The function to transform and classify each input element into one of two output types. list : `'T list` - The input list. Returns: `'T1 list * 'T2 list` A tuple of two lists. The first containing values from `Choice1Of2` results and the second containing values from `Choice2Of2` results. Modifiers: inline Type parameters: 'T, 'T1, 'T2
`List.permute indexMap list` Full Usage: `List.permute indexMap list` Parameters: indexMap : `int -> int` - The function to map input indices to output indices. list : `'T list` - The input list. Returns: `'T list` The permuted list. Type parameters: 'T
`List.pick chooser list` Full Usage: `List.pick chooser list` Parameters: chooser : `'T -> 'U option` - The function to generate options from the elements. list : `'T list` - The input list. Returns: `'U` The first resulting value. Type parameters: 'T, 'U
`List.randomChoice source` Full Usage: `List.randomChoice source` Parameters: source : `'T list` - The input list. Returns: `'T` A randomly selected element from the input list. Type parameters: 'T
`List.randomChoiceBy randomizer source` Full Usage: `List.randomChoiceBy randomizer source` Parameters: randomizer : `unit -> float` - The randomizer function, must return a float number from [0.0..1.0) range. source : `'T list` - The input list. Returns: `'T` A randomly selected element from the input list. Type parameters: 'T
`List.randomChoiceWith random source` Full Usage: `List.randomChoiceWith random source` Parameters: random : `Random` - The `Random` instance. source : `'T list` - The input list. Returns: `'T` A randomly selected element from the input list. Type parameters: 'T
`List.randomChoices count source` Full Usage: `List.randomChoices count source` Parameters: count : `int` - The number of elements to return. source : `'T list` - The input list. Returns: `'T list` A list of randomly selected elements from the input list. Type parameters: 'T
`List.randomChoicesBy randomizer count source` Full Usage: `List.randomChoicesBy randomizer count source` Parameters: randomizer : `unit -> float` - The randomizer function, must return a float number from [0.0..1.0) range. count : `int` - The number of elements to return. source : `'T list` - The input list. Returns: `'T list` A list of randomly selected elements from the input list. Type parameters: 'T
`List.randomChoicesWith random count source` Full Usage: `List.randomChoicesWith random count source` Parameters: random : `Random` - The `Random` instance. count : `int` - The number of elements to return. source : `'T list` - The input list. Returns: `'T list` A list of randomly selected elements from the input list. Type parameters: 'T
`List.randomSample count source` Full Usage: `List.randomSample count source` Parameters: count : `int` - The number of elements to return. source : `'T list` - The input list. Returns: `'T list` A list of randomly selected elements from the input list. Type parameters: 'T
`List.randomSampleBy randomizer count source` Full Usage: `List.randomSampleBy randomizer count source` Parameters: randomizer : `unit -> float` - The randomizer function, must return a float number from [0.0..1.0) range. count : `int` - The number of elements to return. source : `'T list` - The input list. Returns: `'T list` A list of randomly selected elements from the input list. Type parameters: 'T
`List.randomSampleWith random count source` Full Usage: `List.randomSampleWith random count source` Parameters: random : `Random` - The `Random` instance. count : `int` - The number of elements to return. source : `'T list` - The input list. Returns: `'T list` A list of randomly selected elements from the input list. Type parameters: 'T
`List.randomShuffle source` Full Usage: `List.randomShuffle source` Parameters: source : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T
`List.randomShuffleBy randomizer source` Full Usage: `List.randomShuffleBy randomizer source` Parameters: randomizer : `unit -> float` - The randomizer function, must return a float number from [0.0..1.0) range. source : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T
`List.randomShuffleWith random source` Full Usage: `List.randomShuffleWith random source` Parameters: random : `Random` - The `Random` instance. source : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T
`List.reduce reduction list` Full Usage: `List.reduce reduction list` Parameters: reduction : `'T -> 'T -> 'T` - The function to reduce two list elements to a single element. list : `'T list` - The input list. Returns: `'T` The final reduced value. Type parameters: 'T
`List.reduceBack reduction list` Full Usage: `List.reduceBack reduction list` Parameters: reduction : `'T -> 'T -> 'T` - A function that takes in the next-to-last element of the list and the current accumulated result to produce the next accumulated result. list : `'T list` - The input list. Returns: `'T` The final result of the reductions. Type parameters: 'T
`List.removeAt index source` Full Usage: `List.removeAt index source` Parameters: index : `int` - The index of the item to be removed. source : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T
`List.removeManyAt index count source` Full Usage: `List.removeManyAt index count source` Parameters: index : `int` - The index of the item to be removed. count : `int` - The number of items to remove. source : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T
`List.replicate count initial` Full Usage: `List.replicate count initial` Parameters: count : `int` - The number of elements to replicate. initial : `'T` - The value to replicate Returns: `'T list` The generated list. Type parameters: 'T
`List.rev list` Full Usage: `List.rev list` Parameters: list : `'T list` - The input list. Returns: `'T list` The reversed list. Type parameters: 'T
`List.scan folder state list` Full Usage: `List.scan folder state list` Parameters: folder : `'State -> 'T -> 'State` - The function to update the state given the input elements. state : `'State` - The initial state. list : `'T list` - The input list. Returns: `'State list` The list of states. Type parameters: 'T, 'State
`List.scanBack folder list state` Full Usage: `List.scanBack folder list state` Parameters: folder : `'T -> 'State -> 'State` - The function to update the state given the input elements. list : `'T list` - The input list. state : `'State` - The initial state. Returns: `'State list` The list of states. Type parameters: 'T, 'State
`List.singleton value` Full Usage: `List.singleton value` Parameters: value : `'T` - The input item. Returns: `'T list` The result list of one item. Modifiers: inline Type parameters: 'T
`List.skip count list` Full Usage: `List.skip count list` Parameters: count : `int` - The number of elements to skip. If the number is 0 or negative the input list is returned. list : `'T list` - The input list. Returns: `'T list` The list after removing the first N elements. Type parameters: 'T
`List.skipWhile predicate list` Full Usage: `List.skipWhile predicate list` Parameters: predicate : `'T -> bool` - A function that evaluates an element of the list to a boolean value. list : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T
`List.sort list` Full Usage: `List.sort list` Parameters: list : `'T list` - The input list. Returns: `'T list` The sorted list. Type parameters: 'T (requires comparison)
`List.sortBy projection list` Full Usage: `List.sortBy projection list` Parameters: projection : `'T -> 'Key` - The function to transform the list elements into the type to be compared. list : `'T list` - The input list. Returns: `'T list` The sorted list. Type parameters: 'T, 'Key (requires comparison)
`List.sortByDescending projection list` Full Usage: `List.sortByDescending projection list` Parameters: projection : `'T -> 'Key` - The function to transform the list elements into the type to be compared. list : `'T list` - The input list. Returns: `'T list` The sorted list. Modifiers: inline Type parameters: 'T, 'Key (requires comparison)
`List.sortDescending list` Full Usage: `List.sortDescending list` Parameters: list : `'T list` - The input list. Returns: `'T list` The sorted list. Modifiers: inline Type parameters: 'T (requires comparison)
`List.sortWith comparer list` Full Usage: `List.sortWith comparer list` Parameters: comparer : `'T -> 'T -> int` - The function to compare the list elements. list : `'T list` - The input list. Returns: `'T list` The sorted list. Type parameters: 'T
`List.splitAt index list` Full Usage: `List.splitAt index list` Parameters: index : `int` - The index at which the list is split. list : `'T list` - The input list. Returns: `'T list * 'T list` The two split lists. Type parameters: 'T
`List.splitInto count list` Full Usage: `List.splitInto count list` Parameters: count : `int` - The maximum number of chunks. list : `'T list` - The input list. Returns: `'T list list` The list split into chunks. Type parameters: 'T
`List.sum list` Full Usage: `List.sum list` Parameters: list : `^T list` - The input list. Returns: `^T` The resulting sum. Modifiers: inline Type parameters: ^T (requires (static member op_Addition : ^T * ^T -> ^T) and (static member get_Zero : -> ^T))
`List.sumBy projection list` Full Usage: `List.sumBy projection list` Parameters: projection : `'T -> ^U` - The function to transform the list elements into the type to be summed. list : `'T list` - The input list. Returns: `^U` The resulting sum. Modifiers: inline Type parameters: 'T, ^U (requires (static member op_Addition : ^U * ^U -> ^U) and (static member get_Zero : -> ^U))
`List.tail list` Full Usage: `List.tail list` Parameters: list : `'T list` - The input list. Returns: `'T list` The list after removing the first element. Type parameters: 'T
`List.take count list` Full Usage: `List.take count list` Parameters: count : `int` - The number of items to take. list : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T
`List.takeWhile predicate list` Full Usage: `List.takeWhile predicate list` Parameters: predicate : `'T -> bool` - A function that evaluates to false when no more items should be returned. list : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T
`List.toArray list` Full Usage: `List.toArray list` Parameters: list : `'T list` - The input list. Returns: `'T array` The array containing the elements of the list. Type parameters: 'T
`List.toSeq list` Full Usage: `List.toSeq list` Parameters: list : `'T list` - The input list. Returns: `'T seq` The sequence of elements in the list. Type parameters: 'T
`List.transpose lists` Full Usage: `List.transpose lists` Parameters: lists : `'T list seq` - The input sequence of list. Returns: `'T list list` The transposed list. Type parameters: 'T
`List.truncate count list` Full Usage: `List.truncate count list` Parameters: count : `int` - The maximum number of items to return. list : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T
`List.tryExactlyOne list` Full Usage: `List.tryExactlyOne list` Parameters: list : `'T list` - The input list. Returns: `'T option` The only element of the list or None. Type parameters: 'T
`List.tryFind predicate list` Full Usage: `List.tryFind predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `'T option` The first element for which the predicate returns true, or None if every element evaluates to false. Type parameters: 'T
`List.tryFindBack predicate list` Full Usage: `List.tryFindBack predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `'T option` The last element for which the predicate returns true, or None if every element evaluates to false. Type parameters: 'T
`List.tryFindIndex predicate list` Full Usage: `List.tryFindIndex predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `int option` The index of the first element for which the predicate returns true, or None if every element evaluates to false. Type parameters: 'T
`List.tryFindIndexBack predicate list` Full Usage: `List.tryFindIndexBack predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `int option` The index of the last element for which the predicate returns true, or None if every element evaluates to false. Type parameters: 'T
`List.tryHead list` Full Usage: `List.tryHead list` Parameters: list : `'T list` - The input list. Returns: `'T option` The first element of the list or None. Type parameters: 'T
`List.tryItem index list` Full Usage: `List.tryItem index list` Parameters: index : `int` - The index to retrieve. list : `'T list` - The input list. Returns: `'T option` The value at the given index or `None`. Type parameters: 'T
`List.tryLast list` Full Usage: `List.tryLast list` Parameters: list : `'T list` - The input list. Returns: `'T option` The last element of the list or None. Type parameters: 'T
`List.tryPick chooser list` Full Usage: `List.tryPick chooser list` Parameters: chooser : `'T -> 'U option` - The function to generate options from the elements. list : `'T list` - The input list. Returns: `'U option` The first resulting value or None. Type parameters: 'T, 'U
`List.unfold generator state` Full Usage: `List.unfold generator state` Parameters: generator : `'State -> ('T * 'State) option` - A function that takes in the current state and returns an option tuple of the next element of the list and the next state value. state : `'State` - The initial state value. Returns: `'T list` The result list. Type parameters: 'T, 'State
`List.unzip list` Full Usage: `List.unzip list` Parameters: list : `('T1 * 'T2) list` - The input list. Returns: `'T1 list * 'T2 list` Two lists of split elements. Type parameters: 'T1, 'T2
`List.unzip3 list` Full Usage: `List.unzip3 list` Parameters: list : `('T1 * 'T2 * 'T3) list` - The input list. Returns: `'T1 list * 'T2 list * 'T3 list` Three lists of split elements. Type parameters: 'T1, 'T2, 'T3
`List.updateAt index value source` Full Usage: `List.updateAt index value source` Parameters: index : `int` - The index of the item to be replaced. value : `'T` - The new value. source : `'T list` - The input list. Returns: `'T list` The result list. Type parameters: 'T
`List.where predicate list` Full Usage: `List.where predicate list` Parameters: predicate : `'T -> bool` - The function to test the input elements. list : `'T list` - The input list. Returns: `'T list` A list containing only the elements that satisfy the predicate. Type parameters: 'T
`List.windowed windowSize list` Full Usage: `List.windowed windowSize list` Parameters: windowSize : `int` - The number of elements in each window. list : `'T list` - The input list. Returns: `'T list list` The result list. Type parameters: 'T
`List.zip list1 list2` Full Usage: `List.zip list1 list2` Parameters: list1 : `'T1 list` - The first input list. list2 : `'T2 list` - The second input list. Returns: `('T1 * 'T2) list` A single list containing pairs of matching elements from the input lists. Type parameters: 'T1, 'T2
`List.zip3 list1 list2 list3` Full Usage: `List.zip3 list1 list2 list3` Parameters: list1 : `'T1 list` - The first input list. list2 : `'T2 list` - The second input list. list3 : `'T3 list` - The third input list. Returns: `('T1 * 'T2 * 'T3) list` A single list containing triples of matching elements from the input lists. Type parameters: 'T1, 'T2, 'T3

URL: https://fsharp.github.io/fsharp-core-docs/reference/fsharp-collections-listmodule.html

⇱ List (FSharp.Core) | FSharp.Core

List Module

Functions and values