ResizeArray (TDesu.FSharp)

ResizeArray Module

Namespace: TDesu.FSharp.Collections
Assembly: TDesu.FSharp.dll

Functional operations on List{T} (ResizeArray).

Functions and values

Function or value	Description
`ResizeArray.add item ra` Full Usage: `ResizeArray.add item ra` Parameters: item : `'T` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Adds an item and returns the ResizeArray (pipeable). is the mutation target: unlike the read-only helpers in this module, a null has no empty instance to add to, so it is a programmer error. When is null. The item to add. The ResizeArray to add to. item : `'T` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>`
`ResizeArray.addRange items ra` Full Usage: `ResizeArray.addRange items ra` Parameters: items : `'T seq` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Adds multiple items and returns the ResizeArray (pipeable). A null source is treated as empty (nothing is added). is the mutation target, so — unlike a null source — a null has no empty instance to add to and is a programmer error. When is null. The items to add. The ResizeArray to add to. items : `'T seq` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>`
`ResizeArray.choose f ra` Full Usage: `ResizeArray.choose f ra` Parameters: f : `'T -> 'TResult option` ra : `ResizeArray<'T>` Returns: `ResizeArray<'TResult>` Modifiers: inline Type parameters: 'T, 'TResult	Applies a function to each element, keeping the results that are Some. Returns a new ResizeArray. A null is treated as empty and yields an empty result. The function to apply; an element is kept when it returns Some. The input ResizeArray. f : `'T -> 'TResult option` ra : `ResizeArray<'T>` Returns: `ResizeArray<'TResult>`
`ResizeArray.clear ra` Full Usage: `ResizeArray.clear ra` Parameters: ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Clears all elements. Returns the ResizeArray. is the mutation target: a null has no empty instance to clear, so it is a programmer error. When is null. The ResizeArray to clear. ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>`
`ResizeArray.count ra` Full Usage: `ResizeArray.count ra` Parameters: ra : `ResizeArray<'T>` Returns: `int` Modifiers: inline Type parameters: 'T	Returns the number of elements. A null is treated as empty (0). The ResizeArray to count. ra : `ResizeArray<'T>` Returns: `int`
`ResizeArray.create ()` Full Usage: `ResizeArray.create ()` Parameters: () : `unit` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Creates an empty ResizeArray. () : `unit` Returns: `ResizeArray<'T>`
`ResizeArray.exists f ra` Full Usage: `ResizeArray.exists f ra` Parameters: f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `bool` Modifiers: inline Type parameters: 'T	Returns true if any element satisfies the predicate. False for an empty or null ResizeArray. The predicate to test each element. The input ResizeArray. f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `bool`
`ResizeArray.filter f ra` Full Usage: `ResizeArray.filter f ra` Parameters: f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Filters elements, returning a new ResizeArray. A null is treated as empty and yields an empty result. The predicate to filter by. The input ResizeArray. f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>`
`ResizeArray.fold f state ra` Full Usage: `ResizeArray.fold f state ra` Parameters: f : `'State -> 'T -> 'State` state : `'State` ra : `ResizeArray<'T>` Returns: `'State` Modifiers: inline Type parameters: 'State, 'T	Folds over the elements from left to right. A null is treated as empty and yields unchanged. The accumulator function. The initial state. The input ResizeArray. f : `'State -> 'T -> 'State` state : `'State` ra : `ResizeArray<'T>` Returns: `'State`
`ResizeArray.forall f ra` Full Usage: `ResizeArray.forall f ra` Parameters: f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `bool` Modifiers: inline Type parameters: 'T	Returns true if all elements satisfy the predicate. Vacuously true for an empty or null ResizeArray. The predicate to test each element. The input ResizeArray. f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `bool`
`ResizeArray.isEmpty ra` Full Usage: `ResizeArray.isEmpty ra` Parameters: ra : `ResizeArray<'T>` Returns: `bool` Modifiers: inline Type parameters: 'T	Returns true if the ResizeArray is empty. A null counts as empty. The ResizeArray to check. ra : `ResizeArray<'T>` Returns: `bool`
`ResizeArray.iter f ra` Full Usage: `ResizeArray.iter f ra` Parameters: f : `'T -> unit` ra : `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Applies an action to each element. A null is treated as empty (no-op). The action to apply to each element. The input ResizeArray. f : `'T -> unit` ra : `ResizeArray<'T>`
`ResizeArray.iteri f ra` Full Usage: `ResizeArray.iteri f ra` Parameters: f : `int -> 'T -> unit` ra : `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Applies an action with index to each element. A null is treated as empty (no-op). The action to apply, receiving index and element. The input ResizeArray. f : `int -> 'T -> unit` ra : `ResizeArray<'T>`
`ResizeArray.joinWith separator ra` Full Usage: `ResizeArray.joinWith separator ra` Parameters: separator : `string` ra : `ResizeArray<string>` Returns: `string` Modifiers: inline	Joins elements as strings with a separator. A null is treated as empty and yields "". The separator string. The ResizeArray of strings to join. separator : `string` ra : `ResizeArray<string>` Returns: `string`
`ResizeArray.map f ra` Full Usage: `ResizeArray.map f ra` Parameters: f : `'T -> 'TResult` ra : `ResizeArray<'T>` Returns: `ResizeArray<'TResult>` Modifiers: inline Type parameters: 'T, 'TResult	Maps each element, returning a new ResizeArray. A null is treated as empty and yields an empty result. The mapping function. The input ResizeArray. f : `'T -> 'TResult` ra : `ResizeArray<'T>` Returns: `ResizeArray<'TResult>`
`ResizeArray.mapi f ra` Full Usage: `ResizeArray.mapi f ra` Parameters: f : `int -> 'T -> 'TResult` ra : `ResizeArray<'T>` Returns: `ResizeArray<'TResult>` Modifiers: inline Type parameters: 'T, 'TResult	Maps each element together with its index, returning a new ResizeArray. A null is treated as empty and yields an empty result. The mapping function, receiving the index and the element. The input ResizeArray. f : `int -> 'T -> 'TResult` ra : `ResizeArray<'T>` Returns: `ResizeArray<'TResult>`
`ResizeArray.ofArray source` Full Usage: `ResizeArray.ofArray source` Parameters: source : `'T[]` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Creates a ResizeArray from an array. A null is treated as empty. The input array. source : `'T[]` Returns: `ResizeArray<'T>`
`ResizeArray.ofList source` Full Usage: `ResizeArray.ofList source` Parameters: source : `'T list` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Creates a ResizeArray from a list. A null is treated as empty (F# lists represent [] this way when handed a raw null reference from a non-F# caller). The input list. source : `'T list` Returns: `ResizeArray<'T>`
`ResizeArray.ofSeq source` Full Usage: `ResizeArray.ofSeq source` Parameters: source : `'T seq` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Creates a ResizeArray from a sequence. A null is treated as empty. The input sequence. source : `'T seq` Returns: `ResizeArray<'T>`
`ResizeArray.partition f ra` Full Usage: `ResizeArray.partition f ra` Parameters: f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T> * ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Splits into two new ResizeArrays: elements satisfying the predicate, then the rest. A null is treated as empty and yields two empty ResizeArrays. The predicate to test each element. The input ResizeArray. f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T> * ResizeArray<'T>`
`ResizeArray.removeWhere f ra` Full Usage: `ResizeArray.removeWhere f ra` Parameters: f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Removes all elements matching the predicate. Returns the ResizeArray. is the mutation target: a null has no empty instance to remove from, so it is a programmer error. When is null. The predicate identifying elements to remove. The ResizeArray to remove from. f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>`
`ResizeArray.rev ra` Full Usage: `ResizeArray.rev ra` Parameters: ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Returns a new ResizeArray with elements in reverse order. A null is treated as empty and yields an empty result. The input ResizeArray. ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>`
`ResizeArray.singleton item` Full Usage: `ResizeArray.singleton item` Parameters: item : `'T` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Creates a ResizeArray with a single element. The single element to include. item : `'T` Returns: `ResizeArray<'T>`
`ResizeArray.sort ra` Full Usage: `ResizeArray.sort ra` Parameters: ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Sorts the ResizeArray in-place and returns it (pipeable). is the mutation target: a null has no empty instance to sort, so it is a programmer error. When is null. The ResizeArray to sort. ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>`
`ResizeArray.sortBy projection ra` Full Usage: `ResizeArray.sortBy projection ra` Parameters: projection : `'T -> 'Key` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T, 'Key	Sorts by a key projection in-place and returns it. is the mutation target: a null has no empty instance to sort, so it is a programmer error. When is null. The function to extract a comparison key. The ResizeArray to sort. projection : `'T -> 'Key` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>`
`ResizeArray.sortWith comparer ra` Full Usage: `ResizeArray.sortWith comparer ra` Parameters: comparer : `'T -> 'T -> int` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Sorts with a comparison function in-place and returns it. is the mutation target: a null has no empty instance to sort, so it is a programmer error. When is null. The comparison function. The ResizeArray to sort. comparer : `'T -> 'T -> int` ra : `ResizeArray<'T>` Returns: `ResizeArray<'T>`
`ResizeArray.toArray ra` Full Usage: `ResizeArray.toArray ra` Parameters: ra : `ResizeArray<'T>` Returns: `'T[]` Modifiers: inline Type parameters: 'T	Converts to an array. A null is treated as empty and yields [\|\|]. The ResizeArray to convert. ra : `ResizeArray<'T>` Returns: `'T[]`
`ResizeArray.toList ra` Full Usage: `ResizeArray.toList ra` Parameters: ra : `ResizeArray<'T>` Returns: `'T list` Modifiers: inline Type parameters: 'T	Converts to an F# list. A null is treated as empty and yields []. The ResizeArray to convert. ra : `ResizeArray<'T>` Returns: `'T list`
`ResizeArray.tryFind f ra` Full Usage: `ResizeArray.tryFind f ra` Parameters: f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `'T option` Modifiers: inline Type parameters: 'T	Returns the first element matching the predicate, or None. A null is treated as empty and yields None. The predicate to match against. The input ResizeArray. f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `'T option`
`ResizeArray.tryFindIndex f ra` Full Usage: `ResizeArray.tryFindIndex f ra` Parameters: f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `int option` Modifiers: inline Type parameters: 'T	Returns the index of the first element matching the predicate, or None. A null is treated as empty and yields None. The predicate to match against. The input ResizeArray. f : `'T -> bool` ra : `ResizeArray<'T>` Returns: `int option`
`ResizeArray.tryItem index ra` Full Usage: `ResizeArray.tryItem index ra` Parameters: index : `int` ra : `ResizeArray<'T>` Returns: `'T option` Modifiers: inline Type parameters: 'T	Safe index access. A null , or an out-of-range , yields None. The zero-based index to access. The input ResizeArray. index : `int` ra : `ResizeArray<'T>` Returns: `'T option`
`ResizeArray.withCapacity capacity` Full Usage: `ResizeArray.withCapacity capacity` Parameters: capacity : `int` Returns: `ResizeArray<'T>` Modifiers: inline Type parameters: 'T	Creates a ResizeArray with the given initial capacity. The initial capacity. capacity : `int` Returns: `ResizeArray<'T>`