FSharp examples for SortedList (#6862)

snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/fs.fsproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net7.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Compile Include="remarks.fs" />
+    <Compile Include="source.fs" />
+  </ItemGroup>
+</Project>

snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.fs

@@ -0,0 +1,25 @@
+module remarks
+open System
+open System.Collections.Generic
+
+// Create a new sorted list of strings, with string
+// keys.
+let mySortedList = SortedList<int, string>()
+
+// Add some elements to the list. There are no
+// duplicate keys, but some of the values are duplicates.
+mySortedList.Add(0, "notepad.exe")
+mySortedList.Add(1, "paint.exe")
+mySortedList.Add(2, "paint.exe")
+mySortedList.Add(3, "wordpad.exe")
+
+//<Snippet11>
+let v = mySortedList.Values[3]
+//</Snippet11>
+
+printfn $"Value at index 3: {v}"
+
+//<Snippet12>
+for kvp in mySortedList do
+    printfn $"Key = {kvp.Key}, Value = {kvp.Value}"
+//</Snippet12>

snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs

@@ -0,0 +1,157 @@
+module source
+//<Snippet1>
+open System
+open System.Collections.Generic
+
+//<Snippet2>
+// Create a new sorted list of strings, with string
+// keys.
+let openWith = SortedList<string, string>()
+
+// Add some elements to the list. There are no
+// duplicate keys, but some of the values are duplicates.
+openWith.Add("txt", "notepad.exe")
+openWith.Add("bmp", "paint.exe")
+openWith.Add("dib", "paint.exe")
+openWith.Add("rtf", "wordpad.exe")
+
+// The Add method throws an exception if the new key is
+// already in the list.
+try
+    openWith.Add("txt", "winword.exe");
+with
+    | :? ArgumentException ->
+        printfn "An element with Key = \"txt\" already exists."
+//</Snippet2>
+
+//<Snippet3>
+// The Item property is another name for the indexer, so you
+// can omit its name when accessing elements.
+printfn $"""For key = "rtf", value = {openWith["rtf"]}."""
+
+// The indexer can be used to change the value associated
+// with a key.
+openWith["rtf"] <- "winword.exe"
+printfn $"""For key = "rtf", value = {openWith["rtf"]}."""
+
+// If a key does not exist, setting the indexer for that key
+// adds a new key/value pair.
+openWith["doc"] <- "winword.exe";
+//</Snippet3>
+
+//<Snippet4>
+// The indexer throws an exception if the requested key is
+// not in the list.
+try
+    printfn $"""For key = "tif", value = {openWith["tif"]}."""
+with 
+    | :? KeyNotFoundException ->
+        printfn "Key = \"tif\" is not found."
+//</Snippet4>
+
+//<Snippet5>
+// When a program often has to try keys that turn out not to
+// be in the list, TryGetValue can be a more efficient
+// way to retrieve values.
+match openWith.TryGetValue("tif") with
+| true, value ->
+    printfn "For key = \"tif\", value = {value}."
+| false, _ ->
+    printfn "Key = \"tif\" is not found."
+//</Snippet5>
+
+//<Snippet6>
+// ContainsKey can be used to test keys before inserting
+// them.
+if not (openWith.ContainsKey("ht")) then
+    openWith.Add("ht", "hypertrm.exe");
+    printfn """Value added for key = "ht": {openWith["ht"]}"""
+//</Snippet6>
+
+//<Snippet7>
+// When you use foreach to enumerate list elements,
+// the elements are retrieved as KeyValuePair objects.
+Console.WriteLine()
+for kvp in openWith do
+    printfn $"Key = {kvp.Key}, Value = {kvp.Value}"
+//</Snippet7>
+
+//<Snippet8>
+// To get the values alone, use the Values property.
+let ilistValues = openWith.Values;
+
+// The elements of the list are strongly typed with the
+// type that was specified for the SortedList values.
+Console.WriteLine()
+for s in ilistValues do
+    printfn $"Value = {s}"
+
+// The Values property is an efficient way to retrieve
+// values by index.
+printf "\nIndexed retrieval using the Values "
+printfn $"property: Values[2] = {openWith.Values[2]}"
+//</Snippet8>
+
+//<Snippet9>
+// To get the keys alone, use the Keys property.
+let ilistKeys = openWith.Keys;
+
+// The elements of the list are strongly typed with the
+// type that was specified for the SortedList keys.
+Console.WriteLine()
+for s in ilistKeys do
+    printfn $"Key = {s}"
+
+// The Keys property is an efficient way to retrieve
+// keys by index.
+printf "\nIndexed retrieval using the Keys "
+printfn $"property: Keys[2] = {openWith.Keys[2]}"
+//</Snippet9>
+
+//<Snippet10>
+// Use the Remove method to remove a key/value pair.
+printfn "\nRemove(\"doc\")"
+openWith.Remove("doc") |> ignore
+
+if not (openWith.ContainsKey("doc")) then
+    printfn "Key \"doc\" is not found."
+//</Snippet10>
+
+(* This code example produces the following output:
+
+An element with Key = "txt" already exists.
+For key = "rtf", value = wordpad.exe.
+For key = "rtf", value = winword.exe.
+Key = "tif" is not found.
+Key = "tif" is not found.
+Value added for key = "ht": hypertrm.exe
+
+Key = bmp, Value = paint.exe
+Key = dib, Value = paint.exe
+Key = doc, Value = winword.exe
+Key = ht, Value = hypertrm.exe
+Key = rtf, Value = winword.exe
+Key = txt, Value = notepad.exe
+
+Value = paint.exe
+Value = paint.exe
+Value = winword.exe
+Value = hypertrm.exe
+Value = winword.exe
+Value = notepad.exe
+
+Indexed retrieval using the Values property: Values[2] = winword.exe
+
+Key = bmp
+Key = dib
+Key = doc
+Key = ht
+Key = rtf
+Key = txt
+
+Indexed retrieval using the Keys property: Keys[2] = doc
+
+Remove("doc")
+Key "doc" is not found.
+ *)
+//</Snippet1>

xml/System.Collections.Generic/SortedList`2.xml

@@ -132,6 +132,7 @@
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/remarks.cpp" id="Snippet11":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.cs" id="Snippet11":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/remarks.vb" id="Snippet11":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.fs" id="Snippet11"::: 
 
  <xref:System.Collections.Generic.SortedList%602> is implemented as an array of key/value pairs, sorted by the key.  Each element can be retrieved as a <xref:System.Collections.Generic.KeyValuePair%602> object.  
 
@@ -148,6 +149,7 @@
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/remarks.cpp" id="Snippet12":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.cs"  id="Snippet12":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/remarks.vb" id="Snippet12":::  
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.fs"  id="Snippet12":::
 
  The `foreach` statement is a wrapper around the enumerator, which only allows reading from, not writing to, the collection.  
 
@@ -167,6 +169,7 @@
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet1":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet1":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet1":::  
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet1":::
 
  ]]></format>
     </remarks>
@@ -245,6 +248,7 @@
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet2":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" interactive="try-dotnet-method" id="Snippet2":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet2":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet2":::
 
  ]]></format>
         </remarks>
@@ -707,6 +711,7 @@
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet2":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" interactive="try-dotnet-method" id="Snippet2":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet2":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet2":::
 
  ]]></format>
         </remarks>
@@ -949,12 +954,15 @@
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet6":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet6":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet6":::  
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet6":::  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet5":::
 :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet5":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet5":::  
+:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet5":::  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet4":::
 :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet4":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet4":::  
+:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet4":::
 
  ]]></format>
         </remarks>
@@ -1397,12 +1405,15 @@
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet3":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet3":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet3":::  
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet3":::  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet4":::
 :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet4":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet4":::  
+:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet4":::  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet5":::
 :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet5":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet5":::  
+:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet5":::
 
  ]]></format>
         </remarks>
@@ -1468,6 +1479,7 @@
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/remarks.cpp" id="Snippet11":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.cs" id="Snippet11":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/remarks.vb" id="Snippet11":::  
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.fs" id="Snippet11":::
 
  Retrieving the value of this property is an O(1) operation.  
 
@@ -1483,9 +1495,11 @@
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet9":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet9":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet9":::  
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet9":::  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet7":::
 :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet7":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet7":::  
+:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet7":::
 
  ]]></format>
         </remarks>
@@ -1554,6 +1568,7 @@
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet10":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet10":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet10":::  
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet10":::
 
  ]]></format>
         </remarks>
@@ -3218,9 +3233,11 @@ finally {
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet5":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet5":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet5":::  
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet5":::  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet4":::
 :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet4":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet4":::  
+:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet4":::  
 
  ]]></format>
         </remarks>
@@ -3288,6 +3305,7 @@ finally {
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/remarks.cpp" id="Snippet11":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.cs" id="Snippet11":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/remarks.vb" id="Snippet11":::  
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/remarks.fs" id="Snippet11":::
 
  Retrieving the value of this property is an O(1) operation.  
 
@@ -3303,9 +3321,11 @@ finally {
  :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet8":::
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet8":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet8":::  
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet8":::  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Generic.SortedList/cpp/source.cpp" id="Snippet7":::
 :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.cs" id="Snippet7":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.SortedList/VB/source.vb" id="Snippet7":::  
+:::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/SortedListTKey,TValue/Overview/source.fs" id="Snippet7":::  
 
  ]]></format>
         </remarks>