Skip to content

Inline ValueOption module #15709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 31, 2023
Merged

Inline ValueOption module #15709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ca09dd
Inline ValueOption module
kerams Jul 31, 2023
272fb90
Remove InlineIfLambda
kerams Jul 31, 2023
c3d1a71
Merge branch 'main' into vo
kerams Jul 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 23 additions & 22 deletions src/FSharp.Core/option.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,55 +185,56 @@ module ValueOption =
| ValueSome _ -> false

[<CompiledName("DefaultValue")>]
let defaultValue value voption =
let inline defaultValue value voption =
match voption with
| ValueNone -> value
| ValueSome v -> v

// We're deliberately not using InlineIfLambda, because benchmarked code ends up slightly slower at the time of writing (.NET 8 Preview)
[<CompiledName("DefaultWith")>]
let defaultWith defThunk voption =
let inline defaultWith defThunk voption =
match voption with
| ValueNone -> defThunk ()
| ValueSome v -> v

[<CompiledName("OrElse")>]
let orElse ifNone voption =
let inline orElse ifNone voption =
match voption with
| ValueNone -> ifNone
| ValueSome _ -> voption

[<CompiledName("OrElseWith")>]
let orElseWith ifNoneThunk voption =
let inline orElseWith ([<InlineIfLambda>] ifNoneThunk) voption =
match voption with
| ValueNone -> ifNoneThunk ()
| ValueSome _ -> voption

[<CompiledName("Count")>]
let count voption =
let inline count voption =
match voption with
| ValueNone -> 0
| ValueSome _ -> 1

[<CompiledName("Fold")>]
let fold<'T, 'State> folder (state: 'State) (voption: voption<'T>) =
let inline fold<'T, 'State> ([<InlineIfLambda>] folder) (state: 'State) (voption: voption<'T>) =
match voption with
| ValueNone -> state
| ValueSome x -> folder state x

[<CompiledName("FoldBack")>]
let foldBack<'T, 'State> folder (voption: voption<'T>) (state: 'State) =
let inline foldBack<'T, 'State> ([<InlineIfLambda>] folder) (voption: voption<'T>) (state: 'State) =
match voption with
| ValueNone -> state
| ValueSome x -> folder x state

[<CompiledName("Exists")>]
let exists predicate voption =
let inline exists ([<InlineIfLambda>] predicate) voption =
match voption with
| ValueNone -> false
| ValueSome x -> predicate x

[<CompiledName("ForAll")>]
let forall predicate voption =
let inline forall ([<InlineIfLambda>] predicate) voption =
match voption with
| ValueNone -> true
| ValueSome x -> predicate x
Expand All @@ -245,43 +246,43 @@ module ValueOption =
| ValueSome v -> v = value

[<CompiledName("Iterate")>]
let iter action voption =
let inline iter ([<InlineIfLambda>] action) voption =
match voption with
| ValueNone -> ()
| ValueSome x -> action x

[<CompiledName("Map")>]
let map mapping voption =
let inline map ([<InlineIfLambda>] mapping) voption =
match voption with
| ValueNone -> ValueNone
| ValueSome x -> ValueSome(mapping x)

[<CompiledName("Map2")>]
let map2 mapping voption1 voption2 =
let inline map2 ([<InlineIfLambda>] mapping) voption1 voption2 =
match voption1, voption2 with
| ValueSome x, ValueSome y -> ValueSome(mapping x y)
| _ -> ValueNone

[<CompiledName("Map3")>]
let map3 mapping voption1 voption2 voption3 =
let inline map3 ([<InlineIfLambda>] mapping) voption1 voption2 voption3 =
match voption1, voption2, voption3 with
| ValueSome x, ValueSome y, ValueSome z -> ValueSome(mapping x y z)
| _ -> ValueNone

[<CompiledName("Bind")>]
let bind binder voption =
let inline bind ([<InlineIfLambda>] binder) voption =
match voption with
| ValueNone -> ValueNone
| ValueSome x -> binder x

[<CompiledName("Flatten")>]
let flatten voption =
let inline flatten voption =
match voption with
| ValueNone -> ValueNone
| ValueSome x -> x

[<CompiledName("Filter")>]
let filter predicate voption =
let inline filter ([<InlineIfLambda>] predicate) voption =
match voption with
| ValueNone -> ValueNone
| ValueSome x ->
Expand All @@ -291,38 +292,38 @@ module ValueOption =
ValueNone

[<CompiledName("ToArray")>]
let toArray voption =
let inline toArray voption =
match voption with
| ValueNone -> [||]
| ValueSome x -> [| x |]

[<CompiledName("ToList")>]
let toList voption =
let inline toList voption =
match voption with
| ValueNone -> []
| ValueSome x -> [ x ]

[<CompiledName("ToNullable")>]
let toNullable voption =
let inline toNullable voption =
match voption with
| ValueNone -> System.Nullable()
| ValueSome v -> System.Nullable(v)

[<CompiledName("OfNullable")>]
let ofNullable (value: System.Nullable<'T>) =
let inline ofNullable (value: System.Nullable<'T>) =
if value.HasValue then
ValueSome value.Value
else
ValueNone

[<CompiledName("OfObj")>]
let ofObj value =
let inline ofObj value =
match value with
| null -> ValueNone
| _ -> ValueSome value

[<CompiledName("ToObj")>]
let toObj value =
let inline toObj value =
match value with
| ValueNone -> null
| ValueSome x -> x
44 changes: 22 additions & 22 deletions src/FSharp.Core/option.fsi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("DefaultValue")>]
val defaultValue: value: 'T -> voption: 'T voption -> 'T
val inline defaultValue: value: 'T -> voption: 'T voption -> 'T

/// <summary>Gets the value of the voption if the voption is <c>ValueSome</c>, otherwise evaluates <paramref name="defThunk"/> and returns the result.</summary>
///
Expand All @@ -523,7 +523,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("DefaultWith")>]
val defaultWith: defThunk: (unit -> 'T) -> voption: 'T voption -> 'T
val inline defaultWith: defThunk: (unit -> 'T) -> voption: 'T voption -> 'T

/// <summary>Returns <paramref name="voption"/> if it is <c>Some</c>, otherwise returns <paramref name="ifNone"/>.</summary>
///
Expand All @@ -541,7 +541,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("OrElse")>]
val orElse: ifNone: 'T voption -> voption: 'T voption -> 'T voption
val inline orElse: ifNone: 'T voption -> voption: 'T voption -> 'T voption

/// <summary>Returns <paramref name="voption"/> if it is <c>Some</c>, otherwise evaluates <paramref name="ifNoneThunk"/> and returns the result.</summary>
///
Expand All @@ -560,7 +560,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("OrElseWith")>]
val orElseWith: ifNoneThunk: (unit -> 'T voption) -> voption: 'T voption -> 'T voption
val inline orElseWith: ifNoneThunk: (unit -> 'T voption) -> voption: 'T voption -> 'T voption

/// <summary>Gets the value associated with the option.</summary>
///
Expand Down Expand Up @@ -591,7 +591,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("Count")>]
val count: voption: 'T voption -> int
val inline count: voption: 'T voption -> int

/// <summary><c>fold f s inp</c> evaluates to <c>match inp with ValueNone -> s | ValueSome x -> f s x</c>.</summary>
///
Expand All @@ -610,7 +610,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("Fold")>]
val fold<'T, 'State> : folder: ('State -> 'T -> 'State) -> state: 'State -> voption: 'T voption -> 'State
val inline fold<'T, 'State> : folder: ('State -> 'T -> 'State) -> state: 'State -> voption: 'T voption -> 'State

/// <summary><c>fold f inp s</c> evaluates to <c>match inp with ValueNone -> s | ValueSome x -> f x s</c>.</summary>
///
Expand All @@ -629,7 +629,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("FoldBack")>]
val foldBack<'T, 'State> : folder: ('T -> 'State -> 'State) -> voption: 'T voption -> state: 'State -> 'State
val inline foldBack<'T, 'State> : folder: ('T -> 'State -> 'State) -> voption: 'T voption -> state: 'State -> 'State

/// <summary><c>exists p inp</c> evaluates to <c>match inp with ValueNone -> false | ValueSome x -> p x</c>.</summary>
///
Expand All @@ -647,7 +647,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("Exists")>]
val exists: predicate: ('T -> bool) -> voption: 'T voption -> bool
val inline exists: predicate: ('T -> bool) -> voption: 'T voption -> bool

/// <summary><c>forall p inp</c> evaluates to <c>match inp with ValueNone -> true | ValueSome x -> p x</c>.</summary>
///
Expand All @@ -665,7 +665,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("ForAll")>]
val forall: predicate: ('T -> bool) -> voption: 'T voption -> bool
val inline forall: predicate: ('T -> bool) -> voption: 'T voption -> bool

/// <summary>Evaluates to true if <paramref name="voption"/> is <c>ValueSome</c> and its value is equal to <paramref name="value"/>.</summary>
///
Expand Down Expand Up @@ -696,7 +696,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("Iterate")>]
val iter: action: ('T -> unit) -> voption: 'T voption -> unit
val inline iter: action: ('T -> unit) -> voption: 'T voption -> unit

/// <summary><c>map f inp</c> evaluates to <c>match inp with ValueNone -> ValueNone | ValueSome x -> ValueSome (f x)</c>.</summary>
///
Expand All @@ -712,7 +712,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("Map")>]
val map: mapping: ('T -> 'U) -> voption: 'T voption -> 'U voption
val inline map: mapping: ('T -> 'U) -> voption: 'T voption -> 'U voption

/// <summary><c>map f voption1 voption2</c> evaluates to <c>match voption1, voption2 with ValueSome x, ValueSome y -> ValueSome (f x y) | _ -> ValueNone</c>.</summary>
///
Expand All @@ -731,7 +731,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("Map2")>]
val map2: mapping: ('T1 -> 'T2 -> 'U) -> voption1: 'T1 voption -> voption2: 'T2 voption -> 'U voption
val inline map2: mapping: ('T1 -> 'T2 -> 'U) -> voption1: 'T1 voption -> voption2: 'T2 voption -> 'U voption

/// <summary><c>map f voption1 voption2 voption3</c> evaluates to <c>match voption1, voption2, voption3 with ValueSome x, ValueSome y, ValueSome z -> ValueSome (f x y z) | _ -> ValueNone</c>.</summary>
///
Expand All @@ -752,7 +752,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("Map3")>]
val map3:
val inline map3:
mapping: ('T1 -> 'T2 -> 'T3 -> 'U) ->
voption1: 'T1 voption ->
voption2: 'T2 voption ->
Expand All @@ -779,7 +779,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("Bind")>]
val bind: binder: ('T -> 'U voption) -> voption: 'T voption -> 'U voption
val inline bind: binder: ('T -> 'U voption) -> voption: 'T voption -> 'U voption

/// <summary><c>flatten inp</c> evaluates to <c>match inp with ValueNone -> ValueNone | ValueSome x -> x</c></summary>
///
Expand All @@ -796,7 +796,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("Flatten")>]
val flatten: voption: 'T voption voption -> 'T voption
val inline flatten: voption: 'T voption voption -> 'T voption

/// <summary><c>filter f inp</c> evaluates to <c>match inp with ValueNone -> ValueNone | ValueSome x -> if f x then ValueSome x else ValueNone</c>.</summary>
///
Expand All @@ -813,7 +813,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("Filter")>]
val filter: predicate: ('T -> bool) -> voption: 'T voption -> 'T voption
val inline filter: predicate: ('T -> bool) -> voption: 'T voption -> 'T voption

/// <summary>Convert the value option to an array of length 0 or 1.</summary>
///
Expand All @@ -828,7 +828,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("ToArray")>]
val toArray: voption: 'T voption -> 'T[]
val inline toArray: voption: 'T voption -> 'T[]

/// <summary>Convert the value option to a list of length 0 or 1.</summary>
///
Expand All @@ -843,7 +843,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("ToList")>]
val toList: voption: 'T voption -> 'T list
val inline toList: voption: 'T voption -> 'T list

/// <summary>Convert the value option to a Nullable value.</summary>
///
Expand All @@ -858,7 +858,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("ToNullable")>]
val toNullable: voption: 'T voption -> Nullable<'T>
val inline toNullable: voption: 'T voption -> Nullable<'T>

/// <summary>Convert a Nullable value to a value option.</summary>
///
Expand All @@ -873,7 +873,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("OfNullable")>]
val ofNullable: value: Nullable<'T> -> 'T voption
val inline ofNullable: value: Nullable<'T> -> 'T voption

/// <summary>Convert a potentially null value to a value option.</summary>
///
Expand All @@ -888,7 +888,7 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("OfObj")>]
val ofObj: value: 'T -> 'T voption when 'T: null
val inline ofObj: value: 'T -> 'T voption when 'T: null

/// <summary>Convert an option to a potentially null value.</summary>
///
Expand All @@ -903,4 +903,4 @@ module ValueOption =
/// </code>
/// </example>
[<CompiledName("ToObj")>]
val toObj: value: 'T voption -> 'T when 'T: null
val inline toObj: value: 'T voption -> 'T when 'T: null