Add Option.contains

Per RFC-FS-1007 and the discussion in fsharp/fslang-design#60
neoeinstein · Nov 18, 2016 · d3fbb94 · d3fbb94
1 parent 551a7a0
commit d3fbb94
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 1 deletion.
diff --git a/src/fsharp/FSharp.Core.Unittests/FSharp.Core/Microsoft.FSharp.Core/OptionModule.fs b/src/fsharp/FSharp.Core.Unittests/FSharp.Core/Microsoft.FSharp.Core/OptionModule.fs
@@ -98,7 +98,17 @@ type OptionModule() =
             let expected = None
             Assert.AreEqual(expected, actual)
         [""; "     "; "Baz Quux"; "Corge grault"] |> List.iter test
-
+
+    [<Test>]
+    member this.Contains() =
+        Assert.IsFalse( Option.contains 1 None)
+        Assert.IsTrue( Option.contains 1 (Some 1))
+
+        Assert.IsFalse( Option.contains "" None)
+        Assert.IsTrue( Option.contains "" (Some ""))
+
+        Assert.IsFalse( Option.contains None None)
+        Assert.IsTrue( Option.contains None (Some None))
     [<Test>]
     member this.OfToNullable() =
         Assert.IsTrue( Option.ofNullable (System.Nullable<int>()) = None)

diff --git a/src/fsharp/FSharp.Core.Unittests/SurfaceArea.coreclr.fs b/src/fsharp/FSharp.Core.Unittests/SurfaceArea.coreclr.fs
@@ -2713,6 +2713,7 @@ Microsoft.FSharp.Core.OptimizedClosures: Microsoft.FSharp.Core.OptimizedClosures
 Microsoft.FSharp.Core.OptimizedClosures: Microsoft.FSharp.Core.OptimizedClosures+FSharpFunc`6[T1,T2,T3,T4,T5,TResult]
 Microsoft.FSharp.Core.OptimizedClosures: System.String ToString()
 Microsoft.FSharp.Core.OptimizedClosures: System.Type GetType()
+Microsoft.FSharp.Core.OptionModule: Boolean Contains[T](T, Microsoft.FSharp.Core.FSharpOption`1[T])
 Microsoft.FSharp.Core.OptionModule: Boolean Equals(System.Object)
 Microsoft.FSharp.Core.OptionModule: Boolean Exists[T](Microsoft.FSharp.Core.FSharpFunc`2[T,System.Boolean], Microsoft.FSharp.Core.FSharpOption`1[T])
 Microsoft.FSharp.Core.OptionModule: Boolean ForAll[T](Microsoft.FSharp.Core.FSharpFunc`2[T,System.Boolean], Microsoft.FSharp.Core.FSharpOption`1[T])

diff --git a/src/fsharp/FSharp.Core.Unittests/SurfaceArea.net40.fs b/src/fsharp/FSharp.Core.Unittests/SurfaceArea.net40.fs
@@ -2747,6 +2747,7 @@ Microsoft.FSharp.Core.OptimizedClosures: Microsoft.FSharp.Core.OptimizedClosures
 Microsoft.FSharp.Core.OptimizedClosures: Microsoft.FSharp.Core.OptimizedClosures+FSharpFunc`6[T1,T2,T3,T4,T5,TResult]
 Microsoft.FSharp.Core.OptimizedClosures: System.String ToString()
 Microsoft.FSharp.Core.OptimizedClosures: System.Type GetType()
+Microsoft.FSharp.Core.OptionModule: Boolean Contains[T](T, Microsoft.FSharp.Core.FSharpOption`1[T])
 Microsoft.FSharp.Core.OptionModule: Boolean Equals(System.Object)
 Microsoft.FSharp.Core.OptionModule: Boolean Exists[T](Microsoft.FSharp.Core.FSharpFunc`2[T,System.Boolean], Microsoft.FSharp.Core.FSharpOption`1[T])
 Microsoft.FSharp.Core.OptionModule: Boolean ForAll[T](Microsoft.FSharp.Core.FSharpFunc`2[T,System.Boolean], Microsoft.FSharp.Core.FSharpOption`1[T])

diff --git a/src/fsharp/FSharp.Core.Unittests/SurfaceArea.portable259.fs b/src/fsharp/FSharp.Core.Unittests/SurfaceArea.portable259.fs
@@ -2718,6 +2718,7 @@ Microsoft.FSharp.Core.OptimizedClosures: Microsoft.FSharp.Core.OptimizedClosures
 Microsoft.FSharp.Core.OptimizedClosures: Microsoft.FSharp.Core.OptimizedClosures+FSharpFunc`6[T1,T2,T3,T4,T5,TResult]
 Microsoft.FSharp.Core.OptimizedClosures: System.String ToString()
 Microsoft.FSharp.Core.OptimizedClosures: System.Type GetType()
+Microsoft.FSharp.Core.OptionModule: Boolean Contains[T](T, Microsoft.FSharp.Core.FSharpOption`1[T])
 Microsoft.FSharp.Core.OptionModule: Boolean Equals(System.Object)
 Microsoft.FSharp.Core.OptionModule: Boolean Exists[T](Microsoft.FSharp.Core.FSharpFunc`2[T,System.Boolean], Microsoft.FSharp.Core.FSharpOption`1[T])
 Microsoft.FSharp.Core.OptionModule: Boolean ForAll[T](Microsoft.FSharp.Core.FSharpFunc`2[T,System.Boolean], Microsoft.FSharp.Core.FSharpOption`1[T])

diff --git a/src/fsharp/FSharp.Core.Unittests/SurfaceArea.portable47.fs b/src/fsharp/FSharp.Core.Unittests/SurfaceArea.portable47.fs
@@ -2719,6 +2719,7 @@ Microsoft.FSharp.Core.OptimizedClosures: Microsoft.FSharp.Core.OptimizedClosures
 Microsoft.FSharp.Core.OptimizedClosures: Microsoft.FSharp.Core.OptimizedClosures+FSharpFunc`6[T1,T2,T3,T4,T5,TResult]
 Microsoft.FSharp.Core.OptimizedClosures: System.String ToString()
 Microsoft.FSharp.Core.OptimizedClosures: System.Type GetType()
+Microsoft.FSharp.Core.OptionModule: Boolean Contains[T](T, Microsoft.FSharp.Core.FSharpOption`1[T])
 Microsoft.FSharp.Core.OptionModule: Boolean Equals(System.Object)
 Microsoft.FSharp.Core.OptionModule: Boolean Exists[T](Microsoft.FSharp.Core.FSharpFunc`2[T,System.Boolean], Microsoft.FSharp.Core.FSharpOption`1[T])
 Microsoft.FSharp.Core.OptionModule: Boolean ForAll[T](Microsoft.FSharp.Core.FSharpFunc`2[T,System.Boolean], Microsoft.FSharp.Core.FSharpOption`1[T])

diff --git a/src/fsharp/FSharp.Core.Unittests/SurfaceArea.portable7.fs b/src/fsharp/FSharp.Core.Unittests/SurfaceArea.portable7.fs
@@ -2731,6 +2731,7 @@ Microsoft.FSharp.Core.OptimizedClosures: Microsoft.FSharp.Core.OptimizedClosures
 Microsoft.FSharp.Core.OptimizedClosures: Microsoft.FSharp.Core.OptimizedClosures+FSharpFunc`6[T1,T2,T3,T4,T5,TResult]
 Microsoft.FSharp.Core.OptimizedClosures: System.String ToString()
 Microsoft.FSharp.Core.OptimizedClosures: System.Type GetType()
+Microsoft.FSharp.Core.OptionModule: Boolean Contains[T](T, Microsoft.FSharp.Core.FSharpOption`1[T])
 Microsoft.FSharp.Core.OptionModule: Boolean Equals(System.Object)
 Microsoft.FSharp.Core.OptionModule: Boolean Exists[T](Microsoft.FSharp.Core.FSharpFunc`2[T,System.Boolean], Microsoft.FSharp.Core.FSharpOption`1[T])
 Microsoft.FSharp.Core.OptionModule: Boolean ForAll[T](Microsoft.FSharp.Core.FSharpFunc`2[T,System.Boolean], Microsoft.FSharp.Core.FSharpOption`1[T])

diff --git a/src/fsharp/FSharp.Core.Unittests/SurfaceArea.portable78.fs b/src/fsharp/FSharp.Core.Unittests/SurfaceArea.portable78.fs
@@ -2718,6 +2718,7 @@ Microsoft.FSharp.Core.OptimizedClosures: Microsoft.FSharp.Core.OptimizedClosures
 Microsoft.FSharp.Core.OptimizedClosures: Microsoft.FSharp.Core.OptimizedClosures+FSharpFunc`6[T1,T2,T3,T4,T5,TResult]
 Microsoft.FSharp.Core.OptimizedClosures: System.String ToString()
 Microsoft.FSharp.Core.OptimizedClosures: System.Type GetType()
+Microsoft.FSharp.Core.OptionModule: Boolean Contains[T](T, Microsoft.FSharp.Core.FSharpOption`1[T])
 Microsoft.FSharp.Core.OptionModule: Boolean Equals(System.Object)
 Microsoft.FSharp.Core.OptionModule: Boolean Exists[T](Microsoft.FSharp.Core.FSharpFunc`2[T,System.Boolean], Microsoft.FSharp.Core.FSharpOption`1[T])
 Microsoft.FSharp.Core.OptionModule: Boolean ForAll[T](Microsoft.FSharp.Core.FSharpFunc`2[T,System.Boolean], Microsoft.FSharp.Core.FSharpOption`1[T])

diff --git a/src/fsharp/FSharp.Core/option.fs b/src/fsharp/FSharp.Core/option.fs
@@ -31,6 +31,9 @@ namespace Microsoft.FSharp.Core
         [<CompiledName("ForAll")>]
         let forall p inp = match inp with None -> true | Some x -> p x
 
+        [<CompiledName("Contains")>]
+        let contains x inp = match inp with None -> false | Some v -> x = v
+
         [<CompiledName("Iterate")>]
         let iter f inp = match inp with None -> () | Some x -> f x
 

diff --git a/src/fsharp/FSharp.Core/option.fsi b/src/fsharp/FSharp.Core/option.fsi
@@ -70,6 +70,13 @@ namespace Microsoft.FSharp.Core
         [<CompiledName("ForAll")>]
         val forall: predicate:('T -> bool) -> option:'T option -> bool
 
+        /// <summary>Evaluates to true if <paramref name="option"/> is <c>Some</c> and its value is equal to <paramref name="value"/>.</summary>
+        /// <param name="value">The value to test for equality.</param>
+        /// <param name="option">The input option.</param>
+        /// <returns>True if the option is <c>Some</c> and contains a value equal to <paramref name="value"/>, otherwise false.</returns>
+        [<CompiledName("Contains")>]
+        val contains: value:'T -> option:'T option -> bool when 'T : equality
+
         /// <summary><c>iter f inp</c> executes <c>match inp with None -> () | Some x -> f x</c>.</summary>
         /// <param name="action">A function to apply to the option value.</param>
         /// <param name="option">The input option.</param>