Contains 拡張メソッドで指定した要素が含まれているかどうかを確認する
Contains 拡張メソッドを使うと、指定した値がシーケンス内に含まれているかどうかを確認できます。
namespace Tips_Linq{using System;using System.Linq;
class Program
{static void Main(string[] args)
{var numbers = new int[] { 1, 2, 3 };
Console.WriteLine("コレクションの要素は {{ {0} }} です。", string.Join(", ", numbers));
var value = 2;
var isContains = numbers.Contains(value);
Console.WriteLine(value.ToString() + " はシーケンス内に" + (isContains ? "あります。" : "ありません。"));
Console.ReadKey();
}
}
}
それでは次のような Person クラスを定義し、このクラスのコレクションに対して同じことをしてみましょう。
namespace Tips_Linq{using System;///
/// 人物データを表します。
///
public class Person
{///
/// 氏名を取得または設定します。
///
public string Name { get; set; }
///
/// 年齢を取得または設定します。
///
public int Age { get; set; }
}
}
namespace Tips_Linq{using System;using System.Collections.Generic;
using System.Linq;
class Program
{static void Main(string[] args)
{var people = GetPeople();
foreach (var p in people)
{Console.WriteLine(p.Name);
}
var person = new Person() { Name = "鈴木 ほのか", Age = 26 };
var isContains = people.Contains(person);
Console.WriteLine(person.Name + " はシーケンス内に" + (isContains ? "います。" : "いません。"));
Console.ReadKey();
}
///
/// 人物コレクションの列挙子を取得します。
///
///
static IEnumerable<Person> GetPeople()
{yield return new Person() { Name = "田中 淳平", Age = 37 };
yield return new Person() { Name = "鈴木 ほのか", Age = 26 };
yield return new Person() { Name = "小池 哲司", Age = 22 };
yield return new Person() { Name = "恩田 進", Age = 42 };
yield return new Person() { Name = "中津山 亜希子", Age = 20 };
}
}
}
上記のコードでは「鈴木ほのか」という人物がシーケンス内に存在しないかのような結果になっています。
Contains 拡張メソッドでは、特に指定しない場合は既定の等値比較子を使って値を比較しています。そのため、参照型を比較する場合、そのインスタンス自身が等しいかどうかを比較されるようになります。上記の例では、「鈴木ほのか」という同じ名前であってもまったく別のインスタンスを 17 行目で生成し、これとシーケンス内の要素を比較しているため、インスタンスが異なる、という意味でシーケンス内には含まれず、結果は false となっています。
それでは、Person クラスのコレクションに対して「鈴木ほのか」という名前の人がいるかどうかを確認するときはどうすればいいでしょうか。Select 拡張メソッドを併用する方法もありますが、ここではあえて Contains 拡張メソッドのみで対応できるようにしてみましょう。
Contains 拡張メソッドには次のようなオーバーロードが用意されています。
public static bool Contains<TSource>(this IEnumerable<TSource> source, TSource value, IEqualityComparer<TSource> comparer)
{if (comparer == null)
{comparer = EqualityComparer<TSource>.Default;
}
if (source == null)
{throw Error.ArgumentNull("source");
}
foreach (TSource current in source)
{if (comparer.Equals(current, value))
{return true;
}
}
return false;
}
14 行目で、第 2 引数に指定される IEqualityComparer<T> インターフェースに実装される Equals メソッドを使って等値かどうかを判定しています。Person クラスを比較するための IEqualityComparer<Person> インターフェースを実装した比較用クラスを実装すれば、その比較子にしたがった等値比較をおこなうことができるようになるということになります。
それでは実際に IEqualityComparer<Person> を実装した PersonComarer クラスを作りましょう。
namespace Tips_Linq{using System.Collections.Generic;
///
/// Person クラスに対する等値比較子を表します。
///
public class PersonComparer : IEqualityComparer<Person>
{public static readonly PersonComparer NameComparer = new PersonComparer();
///
/// 指定された Person クラスのオブジェクトが等しいかどうかを確認します。
///
/// "x">比較基準を指定します。
/// "y">比較対象を指定します。
///
Name プロパティが等しい場合に true を返します。 public bool Equals(Person x, Person y)
{return x.Name == y.Name;
}
///
/// ハッシュ値を取得します。
///
/// "obj">ハッシュ値を算出するオブジェクトを指定します。
///
算出したハッシュ値を返します。 public int GetHashCode(Person obj)
{return obj == null ? 1 : 0;
}
}
}
使いやすくするために 10 行目にあえて静的メンバとしてインスタンスを保持しています。このクラスを Contains 拡張メソッドに指定することで、先ほどとは違った結果が得られます。
namespace Tips_Linq{using System;using System.Collections.Generic;
using System.Linq;
class Program
{static void Main(string[] args)
{var people = GetPeople();
foreach (var p in people)
{Console.WriteLine(p.Name);
}
var person = new Person() { Name = "鈴木 ほのか", Age = 26 };
var isContains = people.Contains(person, PersonComparer.NameComparer);
Console.WriteLine(person.Name + " はシーケンス内に" + (isContains ? "います。" : "いません。"));
Console.ReadKey();
}
///
/// 人物コレクションの列挙子を取得します。
///
///
static IEnumerable<Person> GetPeople()
{yield return new Person() { Name = "田中 淳平", Age = 37 };
yield return new Person() { Name = "鈴木 ほのか", Age = 26 };
yield return new Person() { Name = "小池 哲司", Age = 22 };
yield return new Person() { Name = "恩田 進", Age = 42 };
yield return new Person() { Name = "中津山 亜希子", Age = 20 };
}
}
}
このように、参照型の場合は等値比較子を指定しないと意図しない結果となることがあるため注意が必要です。数値型の場合は数値そのものを評価するため、同じインスタンスかどうかを区別することが目的でない限りは問題ありません。また、string 型は参照型でありながら、その既定の等値比較子は数値型と同じように振る舞います。コード例と実行結果を次に示します。これは string 型が Immutable であることが起因していますが詳細は割愛します。
namespace Tips_Linq{using System;using System.Linq;
class Program
{static void Main(string[] args)
{var names = new string[] { "田中 淳平", "鈴木 ほのか", "小池 哲司", "恩田 進", "中津山 亜希子" };
var name = "鈴木 ほのか";
var isContains = names.Contains(name);
Console.WriteLine(name + " はシーケンス内に" + (isContains ? "います。" : "いません。"));
Console.ReadKey();
}
}
}
Tweet