Enumerable.Contains Метод

Определение

Пространство имен:

System.Linq

Сборка:

System.Linq.dll

Определяет, содержит ли последовательность указанный элемент.

Перегрузки

Contains<TSource>(IEnumerable<TSource>, TSource)	Определяет, содержится ли указанный элемент в последовательности, используя компаратор проверки на равенство по умолчанию.
Contains<TSource>(IEnumerable<TSource>, TSource, IEqualityComparer<TSource>)	Определяет, содержит ли последовательность заданный элемент, используя указанный компаратор IEqualityComparer<T>.

Contains<TSource>(IEnumerable<TSource>, TSource)

Исходный код:

Contains.cs

Определяет, содержится ли указанный элемент в последовательности, используя компаратор проверки на равенство по умолчанию.

C#

public static bool Contains<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, TSource value);

Параметры типа

TSource

Тип элементов source.

Параметры

source

IEnumerable<TSource>

Последовательность, в которой требуется найти данное значение.

value

TSource

Значение, которое требуется найти в последовательности.

Возвращаемое значение

Boolean

true, если исходная последовательность содержит элемент с указанным значением, в противном случае — false.

Исключения

ArgumentNullException

source имеет значение null.

Примеры

В следующем примере кода показано, как с помощью Contains<TSource>(IEnumerable<TSource>, TSource) определить, содержит ли массив определенный элемент.

C#

string[] fruits = { "apple", "banana", "mango", "orange", "passionfruit", "grape" };

string fruit = "mango";

bool hasMango = fruits.Contains(fruit);

Console.WriteLine(
    "The array {0} contain '{1}'.",
    hasMango ? "does" : "does not",
    fruit);

// This code produces the following output:
//
// The array does contain 'mango'.

Комментарии

Если тип source реализует ICollection<T>, Contains метод в этой реализации вызывается для получения результата. В противном случае этот метод определяет, содержит ли source указанный элемент.

Перечисление завершается сразу после обнаружения соответствующего элемента.

Элементы сравниваются с указанным значением с помощью компаратора на равенство по умолчанию , Default.

Contains<TSource>(IEnumerable<TSource>, TSource, IEqualityComparer<TSource>)

Исходный код:

Contains.cs

Определяет, содержит ли последовательность заданный элемент, используя указанный компаратор IEqualityComparer<T>.

C#

public static bool Contains<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, TSource value, System.Collections.Generic.IEqualityComparer<TSource>? comparer);

Параметры типа

TSource

Тип элементов source.

Параметры

source

IEnumerable<TSource>

Последовательность, в которой требуется найти данное значение.

value

TSource

Значение, которое требуется найти в последовательности.

comparer

IEqualityComparer<TSource>

Компаратор проверки на равенство, используемый для сравнения значений.

Возвращаемое значение

Boolean

true, если исходная последовательность содержит элемент с указанным значением, в противном случае — false.

Исключения

ArgumentNullException

source имеет значение null.

Примеры

В следующем примере показано, как реализовать компаратор на равенство, который можно использовать в методе Contains .

C#

public class Product
{
    public string Name { get; set; }
    public int Code { get; set; }
}

// Custom comparer for the Product class
class ProductComparer : IEqualityComparer<Product>
{
    // Products are equal if their names and product numbers are equal.
    public bool Equals(Product x, Product y)
    {

        //Check whether the compared objects reference the same data.
        if (Object.ReferenceEquals(x, y)) return true;

        //Check whether any of the compared objects is null.
        if (Object.ReferenceEquals(x, null) || Object.ReferenceEquals(y, null))
            return false;

        //Check whether the products' properties are equal.
        return x.Code == y.Code && x.Name == y.Name;
    }

    // If Equals() returns true for a pair of objects
    // then GetHashCode() must return the same value for these objects.

    public int GetHashCode(Product product)
    {
        //Check whether the object is null
        if (Object.ReferenceEquals(product, null)) return 0;

        //Get hash code for the Name field if it is not null.
        int hashProductName = product.Name == null ? 0 : product.Name.GetHashCode();

        //Get hash code for the Code field.
        int hashProductCode = product.Code.GetHashCode();

        //Calculate the hash code for the product.
        return hashProductName ^ hashProductCode;
    }
}

После реализации этого средства сравнения можно использовать последовательность Product объектов в методе Contains , как показано в следующем примере:

C#

Product[] fruits = { new Product { Name = "apple", Code = 9 },
                       new Product { Name = "orange", Code = 4 },
                       new Product { Name = "lemon", Code = 12 } };

Product apple = new Product { Name = "apple", Code = 9 };
Product kiwi = new Product { Name = "kiwi", Code = 8 };

ProductComparer prodc = new ProductComparer();

bool hasApple = fruits.Contains(apple, prodc);
bool hasKiwi = fruits.Contains(kiwi, prodc);

Console.WriteLine("Apple? " + hasApple);
Console.WriteLine("Kiwi? " + hasKiwi);

/*
    This code produces the following output:

    Apple? True
    Kiwi? False
*/

Комментарии

Перечисление завершается сразу после обнаружения соответствующего элемента.

Если comparer имеет значение null, функция сравнения Defaultна равенство по умолчанию используется для сравнения элементов с указанным значением.