How Distint Method is Used by the Framework

Problem Statement

Please go through my previous article first, as in:

http://www.c-sharpcorner.com/UploadFile/tirthacs/remove-an-item-form-observable-collection-using-remove/

Again, the problem is with the understanding of how the equals method is used by the framework. After speaking to my teammates and beginners, I understood that they learned all the extension methods using Strings and all worked fine. But when it comes to objects they didn't get the expected results. The solution is again to correctly implement the Equals method. I will extend this article to be more specific to business requirements.

Note: This example also works fine with the Contains() method. Both are similar.

Problem

We want that all redundant ID values are be removed from the collection as in the following:

class Person
{
public string Name { get; set; }
public int ID { get; set; }
public override string ToString()
{
return "Name:" + Name + " & ID: " + ID;
}
}

Let's do the distinct operation:

var collection = new ObservableCollection<Person>(){new Person{Name="Arunava",ID=1},new Person{Name="Arunava",ID=2},new Person{Name="Arun",ID=1}};
var res = collection.Distinct();
res.ToList().ForEach(c =>Console.WriteLine(" " + c));
Console.ReadLine();

The output is not what we desired:

redundant ID value removed from the collection

Solution

Let's include the Equals() and GetHashCode() in our model class as in the following:

class Person
{
public string Name { get; set; }
public int ID { get; set; }
public override string ToString()
{
return "Name:" + Name + " & ID: " + ID;
}
public override bool Equals(object obj)
{
// Check for null
if (ReferenceEquals(obj, null))
return false;
// Check for same reference
if (ReferenceEquals(this, obj))
return true;
var person = (Person)obj;
return this.ID == person.ID;
}
public override int GetHashCode()
{
return ID ^ 7;
}
}

Let's run the same program and see that the output is as we desired:

output of model class

Extension

What if the requirements shift to properties that are now the distinct row, in other words two rows that have the same Name? For this, the default Distinct will not work. Fortunately, Microsoft provide an overload of Distinct that takes an EqualityComparer. To use it, we need to define our own custom equality comparer. I am making it generic enough so that any property or property combination will work fine. Let's define the Comparer first:

class PersonEqualityComparer : IEqualityComparer<Person>
{
public Func<Person, object> KeySelector { get; set; }
public PersonEqualityComparer(Func<Person, object> selector)
{
KeySelector = selector;
}
public bool Equals(Person x, Person y)
{
return KeySelector(x).Equals(KeySelector(y));
}
public int GetHashCode(Person obj)
{
return KeySelector(obj).GetHashCode();
}
}

I used the Function delegate for the comparison that abstracted the general Equal() method. Now let's modify the client to be as in the following:

var collection = new ObservableCollection<Person>(){new Person{Name="Arunava",ID=1},new Person{Name="Arunava",ID=2},new Person{Name="Arun",ID=1}};
var res=collection.Distinct(new PersonEqualityComparer(c=>c.Name));
res.ToList().ForEach(c =>Console.WriteLine(" " + c));
Console.ReadLine();

Now the Distinct works on the Person Name and the output is as follows:

output after modify the client

We can also use the property combination as follows:

var res = collection.Distinct(new PersonEqualityComparer(c => new { c.Name, c.ID }));

I hope this helps.