From Operators.id<'T> Function (F#):
The identity function.
Parameters: x Type: 'T (The input value)
Return Value: The same value
F# Core Library Versions, supported in: 2.0, 4.0, Portable
Why is there a function that returns its input?
When working with higher-order functions (i.e. functions that return other functions and/or take other functions as parameters), you always have to provide something as parameter, but there isn't always an actual data transformation that you'd want to apply.
For example, the function Seq.collect
flattens a sequence of sequences, and takes a function that returns the "nested" sequence for each element of the "outer" sequence. For example, this is how you might get the list of all grandchildren of a UI control of some sort:
let control = ... let allGrandChildren = control.Children |> Seq.collect (fun c -> c.Children)
But a lot of times, each element of the sequence will already be a sequence by itself - for example, you may have a list of lists:
let l = [ [1;2]; [3;4]; [5;6] ]
In this case, the parameter function that you pass to Seq.collect
needs to just return the argument:
let flattened = [ [1;2]; [3;4]; [5;6] ] |> Seq.collect (fun x -> x)
This expression fun x -> x
is a function that just returns its argument, also known as "identity function".
let flattened = [ [1;2]; [3;4]; [5;6] ] |> Seq.collect id
Its usage crops up so often when working with higher-order functions (such as Seq.collect
above) that it deserves a place in the standard library.
Another compelling example is Seq.choose
- a function that filters a sequence of Option
values and unwraps them at the same time. For example, this is how you might parse all strings as numbers and discard those that can't be parsed:
let tryParse s = match System.Int32.TryParse s with | true, x -> Some x | _ -> None let strings = [ "1"; "2"; "foo"; "42" ] let numbers = strings |> Seq.choose tryParse // numbers = [1;2;42]
But what if you're already given a list of Option
values to start with? The identity function to the rescue!
let toNumbers optionNumbers = optionNumbers |> Seq.choose id
It's useful for certain higher order functions (functions that take functions as arguments) so that you can pass id
as the argument instead of writing out the lambda (fun x -> x)
.
[[1;2]; [3]] |> List.collect id // [1; 2; 3]
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With