SortedSet<T>
Class
Definition
Represents a collection of objects that is maintained in sorted order.
public class SortedSet<T> : System.Collections.Generic.ICollection<T>, System.Collections.Generic.IEnumerable<T>, System.Collections.Generic.IReadOnlyCollection<T>, System.Collections.Generic.ISet<T>, System.Collections.ICollection, System.Runtime.Serialization.IDeserializationCallback, System.Runtime.Serialization.ISerializable
- T
The type of elements in the set.
- Inheritance
-
SortedSet<T>
- Implements
Inherited Members
System.Object
Examples
The following example demonstrates a SortedSet<T> class that is created with the constructor that takes an IComparer<T> as a parameter. This comparer (ByFileExtension) is used to sort a list of file names by their extensions.
This example demonstrates how to create a sorted set of media file names, remove unwanted elements, view a range of elements, and compare the set with another sorted set.
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
class Program
{
static void Main(string[] args)
{
try
{
// Get a list of the files to use for the sorted set.
IEnumerable<string> files1 =
Directory.EnumerateFiles(@"\\archives\2007\media",
"*", SearchOption.AllDirectories);
// Create a sorted set using the ByFileExtension comparer.
SortedSet<string> mediaFiles1 =
new SortedSet<string>(new ByFileExtension());
// Note that there is a SortedSet constructor that takes an IEnumerable,
// but to remove the path information they must be added individually.
foreach (string f in files1)
{
mediaFiles1.Add(f.Substring(f.LastIndexOf(@"\") + 1));
}
// Remove elements that have non-media extensions.
// See the 'isDoc' method.
Console.WriteLine("Remove docs from the set...");
Console.WriteLine("\tCount before: {0}", mediaFiles1.Count.ToString());
mediaFiles1.RemoveWhere(isDoc);
Console.WriteLine("\tCount after: {0}", mediaFiles1.Count.ToString());
Console.WriteLine();
// List all the avi files.
SortedSet<string> aviFiles = mediaFiles1.GetViewBetween("avi", "avj");
Console.WriteLine("AVI files:");
foreach (string avi in aviFiles)
{
Console.WriteLine("\t{0}", avi);
}
Console.WriteLine();
// Create another sorted set.
IEnumerable<string> files2 =
Directory.EnumerateFiles(@"\\archives\2008\media",
"*", SearchOption.AllDirectories);
SortedSet<string> mediaFiles2 = new SortedSet<string>(new ByFileExtension());
foreach (string f in files2)
{
mediaFiles2.Add(f.Substring(f.LastIndexOf(@"\") + 1));
}
// Remove elements in mediaFiles1 that are also in mediaFiles2.
Console.WriteLine("Remove duplicates (of mediaFiles2) from the set...");
Console.WriteLine("\tCount before: {0}", mediaFiles1.Count.ToString());
mediaFiles1.ExceptWith(mediaFiles2);
Console.WriteLine("\tCount after: {0}", mediaFiles1.Count.ToString());
Console.WriteLine();
Console.WriteLine("List of mediaFiles1:");
foreach (string f in mediaFiles1)
{
Console.WriteLine("\t{0}",f);
}
// Create a set of the sets.
IEqualityComparer<SortedSet<string>> comparer =
SortedSet<string>.CreateSetComparer();
HashSet<SortedSet<string>> allMedia =
new HashSet<SortedSet<string>>(comparer);
allMedia.Add(mediaFiles1);
allMedia.Add(mediaFiles2);
}
catch(IOException ioEx)
{
Console.WriteLine(ioEx.Message);
}
catch (UnauthorizedAccessException AuthEx)
{
Console.WriteLine(AuthEx.Message);
}
}
// Defines a predicate delegate to use
// for the SortedSet.RemoveWhere method.
private static bool isDoc(string s)
{
if (s.ToLower().EndsWith(".txt") ||
s.ToLower().EndsWith(".doc") ||
s.ToLower().EndsWith(".xls") ||
s.ToLower().EndsWith(".xlsx") ||
s.ToLower().EndsWith(".pdf") ||
s.ToLower().EndsWith(".doc") ||
s.ToLower().EndsWith(".docx"))
{
return true;
}
else
{
return false;
}
}
}
// Defines a comparer to create a sorted set
// that is sorted by the file extensions.
public class ByFileExtension : IComparer<string>
{
string xExt, yExt;
CaseInsensitiveComparer caseiComp = new CaseInsensitiveComparer();
public int Compare(string x, string y)
{
// Parse the extension from the file name.
xExt = x.Substring(x.LastIndexOf(".") + 1);
yExt = y.Substring(y.LastIndexOf(".") + 1);
// Compare the file extensions.
int vExt = caseiComp.Compare(xExt, yExt);
if (vExt != 0)
{
return vExt;
}
else
{
// The extension is the same,
// so compare the filenames.
return caseiComp.Compare(x, y);
}
}
}
Imports System.Collections
Imports System.Collections.Generic
Imports System.IO
Module Module1
Sub Main()
Try
' Get a list of the files to use for the sorted set.
Dim files1 As IEnumerable = _
Directory.EnumerateFiles("\\archives\2007\media", "*", _
SearchOption.AllDirectories)
' Create a sorted set using the ByFileExtension comparer.
Dim mediaFiles1 As SortedSet(Of String) = _
New SortedSet(Of String)(New ByFileExtension)
' Note that there is a SortedSet constructor that takes an IEnumerable,
' but to remove the path information they must be added individually.
For Each f As String In files1
mediaFiles1.Add(f.Substring((f.LastIndexOf("\") + 1)))
Next
' Remove elements that have non-media extensions. See the 'isDoc' method.
Console.WriteLine("Remove docs from the set...")
Console.WriteLine(vbTab & "Count before: {0}", mediaFiles1.Count.ToString)
mediaFiles1.RemoveWhere(AddressOf isDoc)
Console.WriteLine(vbTab & "Count after: {0}", mediaFiles1.Count.ToString)
Console.WriteLine()
' List all the avi files.
Dim aviFiles As SortedSet(Of String) = mediaFiles1.GetViewBetween("avi", "avj")
Console.WriteLine("AVI files:")
For Each avi As String In aviFiles
Console.WriteLine(vbTab & "{0}", avi)
Next
Console.WriteLine()
' Create another sorted set.
Dim files2 As IEnumerable = _
Directory.EnumerateFiles("\\archives\2008\media", "*", _
SearchOption.AllDirectories)
Dim mediaFiles2 As SortedSet(Of String) = _
New SortedSet(Of String)(New ByFileExtension)
For Each f As String In files2
mediaFiles2.Add(f.Substring((f.LastIndexOf("\") + 1)))
Next
' Remove elements in mediaFiles1 that are also in mediaFiles2.
Console.WriteLine("Remove duplicates (of mediaFiles2) from the set...")
Console.WriteLine(vbTab & "Count before: {0}", _
mediaFiles1.Count.ToString)
mediaFiles1.ExceptWith(mediaFiles2)
Console.WriteLine(vbTab & "Count after: {0}", _
mediaFiles1.Count.ToString)
Console.WriteLine()
Console.WriteLine("List of mediaFiles1:")
For Each f As String In mediaFiles1
Console.WriteLine(vbTab & "{0}", f)
Next
' Create a set of the sets.
Dim comparer As IEqualityComparer(Of SortedSet(Of String)) = _
SortedSet(Of String).CreateSetComparer()
Dim allMedia As HashSet(Of SortedSet(Of String)) = _
New HashSet(Of SortedSet(Of String))(comparer)
allMedia.Add(mediaFiles1)
allMedia.Add(mediaFiles2)
Catch ioEx As IOException
Console.WriteLine(ioEx.Message)
Catch AuthEx As UnauthorizedAccessException
Console.WriteLine(AuthEx.Message)
End Try
End Sub
' Defines a predicate deligate to use
' for the SortedSet.RemoveWhere method.
Private Function isDoc(ByVal s As String) As Boolean
If (s.ToLower.EndsWith(".txt") _
OrElse (s.ToLower.EndsWith(".doc") _
OrElse (s.ToLower.EndsWith(".xls") _
OrElse (s.ToLower.EndsWith(".xlsx") _
OrElse (s.ToLower.EndsWith(".pdf") _
OrElse (s.ToLower.EndsWith(".doc") _
OrElse s.ToLower.EndsWith(".docx"))))))) Then
Return True
Else
Return False
End If
End Function
' Defines a comparer to create a sorted set
' that is sorted by the file extensions.
Public Class ByFileExtension
Implements IComparer(Of String)
Dim xExt, yExt As String
Dim caseiComp As CaseInsensitiveComparer = _
New CaseInsensitiveComparer
Public Function Compare(x As String, y As String) _
As Integer Implements IComparer(Of String).Compare
' Parse the extension from the file name.
xExt = x.Substring(x.LastIndexOf(".") + 1)
yExt = y.Substring(y.LastIndexOf(".") + 1)
' Compare the file extensions.
Dim vExt As Integer = caseiComp.Compare(xExt, yExt)
If vExt <> 0 Then
Return vExt
Else
' The extension is the same,
' so compare the filenames.
Return caseiComp.Compare(x, y)
End If
End Function
End Class
End Module
Remarks
A SortedSet<T> object maintains a sorted order without affecting performance as elements are inserted and deleted. Duplicate elements are not allowed. Changing the sort values of existing items is not supported and may lead to unexpected behavior.
For a thread safe alternative to SortedSet<T>, see ImmutableSortedSet<T>
Constructors
| SortedSet<T>() |
Initializes a new instance of the SortedSet<T> class. |
| SortedSet<T>(IComparer<T>) |
Initializes a new instance of the SortedSet<T> class that uses a specified comparer. |
| SortedSet<T>(IEnumerable<T>) |
Initializes a new instance of the SortedSet<T> class that contains elements copied from a specified enumerable collection. |
| SortedSet<T>(IEnumerable<T>, IComparer<T>) |
Initializes a new instance of the SortedSet<T> class that contains elements copied from a specified enumerable collection and that uses a specified comparer. |
| SortedSet<T>(SerializationInfo, StreamingContext) |
Initializes a new instance of the SortedSet<T> class that contains serialized data. |
Properties
| Comparer |
Gets the IComparer<T> object that is used to order the values in the SortedSet<T>. |
| Count |
Gets the number of elements in the SortedSet<T>. |
| Max |
Gets the maximum value in the SortedSet<T>, as defined by the comparer. |
| Min |
Gets the minimum value in the SortedSet<T>, as defined by the comparer. |
Methods
| Add(T) |
Adds an element to the set and returns a value that indicates if it was successfully added. |
| Clear() |
Removes all elements from the set. |
| Contains(T) |
Determines whether the set contains a specific element. |
| CopyTo(T[], Int32, Int32) |
Copies a specified number of elements from SortedSet<T> to a compatible one-dimensional array, starting at the specified array index. |
| CopyTo(T[], Int32) |
Copies the complete SortedSet<T> to a compatible one-dimensional array, starting at the specified array index. |
| CopyTo(T[]) |
Copies the complete SortedSet<T> to a compatible one-dimensional array, starting at the beginning of the target array. |
| CreateSetComparer() |
Returns an IEqualityComparer object that can be used to create a collection that contains individual sets. |
| CreateSetComparer(IEqualityComparer<T>) |
Returns an IEqualityComparer object, according to a specified comparer, that can be used to create a collection that contains individual sets. |
| ExceptWith(IEnumerable<T>) |
Removes all elements that are in a specified collection from the current SortedSet<T> object. |
| GetEnumerator() |
Returns an enumerator that iterates through the SortedSet<T>. |
| GetObjectData(SerializationInfo, StreamingContext) |
Implements the ISerializable interface and returns the data that you must have to serialize a SortedSet<T> object. |
| GetViewBetween(T, T) |
Returns a view of a subset in a SortedSet<T>. |
| IntersectWith(IEnumerable<T>) |
Modifies the current SortedSet<T> object so that it contains only elements that are also in a specified collection. |
| IsProperSubsetOf(IEnumerable<T>) |
Determines whether a SortedSet<T> object is a proper subset of the specified collection. |
| IsProperSupersetOf(IEnumerable<T>) |
Determines whether a SortedSet<T> object is a proper superset of the specified collection. |
| IsSubsetOf(IEnumerable<T>) |
Determines whether a SortedSet<T> object is a subset of the specified collection. |
| IsSupersetOf(IEnumerable<T>) |
Determines whether a SortedSet<T> object is a superset of the specified collection. |
| OnDeserialization(Object) |
Implements the ISerializable interface, and raises the deserialization event when the deserialization is completed. |
| Overlaps(IEnumerable<T>) |
Determines whether the current SortedSet<T> object and a specified collection share common elements. |
| Remove(T) |
Removes a specified item from the SortedSet<T>. |
| RemoveWhere(Predicate<T>) |
Removes all elements that match the conditions defined by the specified predicate from a SortedSet<T>. |
| Reverse() |
Returns an IEnumerable<T> that iterates over the SortedSet<T> in reverse order. |
| SetEquals(IEnumerable<T>) |
Determines whether the current SortedSet<T> object and the specified collection contain the same elements. |
| SymmetricExceptWith(IEnumerable<T>) |
Modifies the current SortedSet<T> object so that it contains only elements that are present either in the current object or in the specified collection, but not both. |
| TryGetValue(T, T) | |
| UnionWith(IEnumerable<T>) |
Modifies the current SortedSet<T> object so that it contains all elements that are present in either the current object or the specified collection. |
Explicit Interface Implementations
| ICollection<T>.Add(T) |
Adds an item to an ICollection<T> object. |
| ICollection<T>.IsReadOnly |
Gets a value that indicates whether a ICollection is read-only. |
| IEnumerable<T>.GetEnumerator() |
Returns an enumerator that iterates through a collection. |
| ICollection.CopyTo(Array, Int32) |
Copies the complete SortedSet<T> to a compatible one-dimensional array, starting at the specified array index. |
| ICollection.IsSynchronized |
Gets a value that indicates whether access to the ICollection is synchronized (thread safe). |
| ICollection.SyncRoot |
Gets an object that can be used to synchronize access to the ICollection. |
| IEnumerable.GetEnumerator() |
Returns an enumerator that iterates through a collection. |
| IDeserializationCallback.OnDeserialization(Object) |
Implements the IDeserializationCallback interface, and raises the deserialization event when the deserialization is completed. |
| ISerializable.GetObjectData(SerializationInfo, StreamingContext) |
Implements the ISerializable interface, and returns the data that you need to serialize the SortedSet<T> instance. |