BinarySearch(TListItem, TMatchItem) Method (IList(TListItem), TMatchItem, CollectionAlgorithms.ComparisonOfDifferentTypes(TListItem, TMatchItem), Int32, Int32)

CollectionAlgorithmsBinarySearchTListItem, TMatchItem Method (IListTListItem, TMatchItem, CollectionAlgorithmsComparisonOfDifferentTypesTListItem, TMatchItem)

Uses a binary search algorithm to locate a specific element in the sorted IListT. The element to search for can be a different type from the items in the collection.

Namespace: AGI.Foundation.Infrastructure
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

C++

Copy

public static int BinarySearch<TListItem, TMatchItem>(
	IList<TListItem> collection,
	TMatchItem item,
	CollectionAlgorithmsComparisonOfDifferentTypes<TListItem, TMatchItem> comparer
)

Public Shared Function BinarySearch(Of TListItem, TMatchItem) ( 
	collection As IList(Of TListItem),
	item As TMatchItem,
	comparer As CollectionAlgorithmsComparisonOfDifferentTypes(Of TListItem, TMatchItem)
) As Integer

public:
generic<typename TListItem, typename TMatchItem>
static int BinarySearch(
	IList<TListItem>^ collection, 
	TMatchItem item, 
	CollectionAlgorithmsComparisonOfDifferentTypes<TListItem, TMatchItem>^ comparer
)

static member BinarySearch : 
        collection : IList<'TListItem> * 
        item : 'TMatchItem * 
        comparer : CollectionAlgorithmsComparisonOfDifferentTypes<'TListItem, 'TMatchItem> -> int

Parameters

collection: Type: System.Collections.GenericIListTListItem
The collection to search.
item: Type: TMatchItem
The item to find.
comparer: Type: AGI.Foundation.InfrastructureCollectionAlgorithmsComparisonOfDifferentTypesTListItem, TMatchItem
The comparison to use to compare items in the collection to the item to search for.

Type Parameters

TListItem: The type of item in the collection.
TMatchItem: The type of item to search for.

Return Value

Type: Int32
The zero-based index of item in the sorted IList, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of Count.

Remarks

This method is similar to BinarySearch(T) or BinarySearchT(T, T) except that it operates on any type that implements IListT, and it allows for the item to find to be a different type from the items in the collection.

Reference

CollectionAlgorithms Class

BinarySearch Overload

AGI.Foundation.Infrastructure Namespace