NonEmptyList Module
Basic operations on NonEmptyList
Functions and values
| Function or value | Description | ||
Full Usage:
NonEmptyList.average list
Parameters:
NonEmptyList<^T>
-
The input list.
Returns: ^T
The resulting average.
Modifiers: inline Type parameters: ^T |
Returns the average of the elements in the list.
|
||
Full Usage:
NonEmptyList.averageBy projection list
Parameters:
'T -> ^U
-
The function to transform the list elements into the type to be averaged.
list : NonEmptyList<'T>
-
The input list.
Returns: ^U
The resulting average.
Modifiers: inline Type parameters: 'T, ^U |
Returns the average of the elements generated by applying the function to each element of the list.
|
||
Full Usage:
NonEmptyList.choice list
Parameters:
NonEmptyList<^Alt<'T>>
Returns: ^Alt<'T>
Modifiers: inline Type parameters: ^Alt<'T> |
Reduces using alternative operator `<|>`.
|
||
Full Usage:
NonEmptyList.cons e arg2
Parameters:
'a
arg1 : NonEmptyList<'a>
Returns: NonEmptyList<'a>
|
Returns a new NonEmptyList with the element added to the beginning.
|
||
|
Builds a non empty list.
|
||
Full Usage:
NonEmptyList.distinct list
Parameters:
NonEmptyList<'T>
-
The input list.
Returns: NonEmptyList<'T>
The resulting list without duplicates.
|
Returns a list that contains no duplicate entries according to the generic hash and equality comparisons on the keys returned by the given key-generating function. If an element occurs multiple times in the list then the later occurrences are discarded.
|
||
|
Returns the first element of a new non empty list. You can also use property nel.Head.
|
||
|
Returns the length of a non empty list. You can also use property nel.Length.
|
||
Full Usage:
NonEmptyList.map f arg2
Parameters:
'a -> 'b
arg1 : NonEmptyList<'a>
Returns: NonEmptyList<'b>
|
Build a new non empty list whose elements are the results of applying the given function to each of the elements of the non empty list.
|
||
Full Usage:
NonEmptyList.map2Shortest f l1 l2
Parameters:
'a -> 'b -> 'c
l1 : NonEmptyList<'a>
l2 : NonEmptyList<'b>
Returns: NonEmptyList<'c>
|
Safely build a new non empty list whose elements are the results of applying the given function to each of the elements of the two non empty list pairwise.
|
||
Full Usage:
NonEmptyList.mapi f arg2
Parameters:
int -> 'a -> 'b
arg1 : NonEmptyList<'a>
Returns: NonEmptyList<'b>
|
Build a new non empty list whose elements are the results of applying the given function with index to each of the elements of the non empty list.
|
||
Full Usage:
NonEmptyList.max list
Parameters:
NonEmptyList<'T>
-
The input list.
Returns: 'T
The maximum element.
|
Returns the greatest of all elements of the list, compared via Operators.max.
|
||
Full Usage:
NonEmptyList.maxBy projection list
Parameters:
'T -> 'U
-
The function to transform the list elements into the type to be compared.
list : NonEmptyList<'T>
-
The input list.
Returns: 'T
The maximum element.
|
Returns the greatest of all elements of the list, compared via Operators.max on the function result.
|
||
Full Usage:
NonEmptyList.min list
Parameters:
NonEmptyList<'T>
-
The input list.
Returns: 'T
The minimum value.
|
Returns the lowest of all elements of the list, compared via Operators.min.
|
||
Full Usage:
NonEmptyList.minBy projection list
Parameters:
'T -> 'U
-
The function to transform list elements into the type to be compared.
list : NonEmptyList<'T>
-
The input list.
Returns: 'T
The minimum value.
|
Returns the lowest of all elements of the list, compared via Operators.min on the function result
|
||
Full Usage:
NonEmptyList.ofArray array
Parameters:
'a array
-
The input array.
Returns: NonEmptyList<'a>
Non empty list containing the elements of the array.
|
Builds a non empty list from the given array. Throws exception for empty array
|
||
Full Usage:
NonEmptyList.ofList list
Parameters:
'c list
-
The input list.
Returns: NonEmptyList<'c>
Non empty list containing the elements of the list.
|
Builds a non empty list from the given list. Throws exception for empty list
|
||
|
|
||
Full Usage:
NonEmptyList.ofSeq seq
Parameters:
seq<'b>
-
The input list.
Returns: NonEmptyList<'b>
Non empty list containing the elements of the list.
|
Builds a non empty list from the given sequence. Throws exception for empty list
|
||
Full Usage:
NonEmptyList.range start stop
Parameters:
^T
stop : ^T
Returns: NonEmptyList<^T>
Modifiers: inline Type parameters: ^T |
Equivalent to [start..stop] on regular lists.
|
||
Full Usage:
NonEmptyList.reduce reduction list
Parameters:
'T -> 'T -> 'T
-
The function to reduce two list elements to a single element.
list : NonEmptyList<'T>
-
The input list.
Returns: 'T
The final reduced value.
|
Applies a function to each element of the list, threading an accumulator argument
through the computation. Apply the function to the first two elements of the list.
Then feed this result into the function along with the third element and so on.
Return the final result. If the input function is
|
||
Full Usage:
NonEmptyList.reduceBack reduction list
Parameters:
'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 : NonEmptyList<'T>
-
The input list.
Returns: 'T
The final result of the reductions.
|
Applies a function to each element of the list, starting from the end, threading an accumulator argument
through the computation. If the input function is
|
||
Full Usage:
NonEmptyList.sequence source
Parameters:
NonEmptyList<^Functor<'T>>
Returns: ^Functor
Modifiers: inline |
Evaluates each action in the list from left to right and collect the results.
|
||
|
Builds a non empty list with a single element.
|
||
|
Returns a new NonEmptyList of the elements trailing the first element. Throws exception for empty tail
|
||
Full Usage:
NonEmptyList.tails s
Parameters:
NonEmptyList<'a>
Returns: NonEmptyList<NonEmptyList<'a>>
|
|
||
|
Builds an array from the given non empty list.
|
||
|
Builds a list from the given non empty list.
|
||
Full Usage:
NonEmptyList.toNonEmptySeq list
Parameters:
NonEmptyList<'a>
Returns: NonEmptySeq<'a>
|
|
||
|
Builds a sequence from the given non empty list.
|
||
Full Usage:
NonEmptyList.traverse f source
Parameters:
'T -> ^Functor<'U>
source : NonEmptyList<'T>
Returns: ^Functor
Modifiers: inline |
Maps each element of the list to an action, evaluates these actions from left to right and collect the results.
|
||
|
Transforms a list to a NonEmptyList, returning an option to signal when the original list was empty.
|
||
Full Usage:
NonEmptyList.unzip list
Parameters:
NonEmptyList<'T1 * 'T2>
-
The input list.
Returns: NonEmptyList<'T1> * NonEmptyList<'T2>
Two lists of split elements.
|
Splits a list of pairs into two lists.
|
||
Full Usage:
NonEmptyList.zip list1 list2
Parameters:
NonEmptyList<'T>
-
The first input list.
list2 : NonEmptyList<'U>
-
The second input list.
Returns: NonEmptyList<'T * 'U>
A single list containing pairs of matching elements from the input lists.
|
Combines the two lists into a list of pairs. The two lists must have equal lengths.
|
||
Full Usage:
NonEmptyList.zipShortest list1 list2
Parameters:
NonEmptyList<'T>
-
First input list.
list2 : NonEmptyList<'U>
-
Second input list.
Returns: NonEmptyList<'T * 'U>
List with corresponding pairs of input lists.
|
Zip safely two lists. If one list is shorter, excess elements are discarded from the right end of the longer list.
|