agi.foundation.infrastructure

(agi.foundation.core-2024r3.jar)

Class CollectionAlgorithms

java.lang.Object

agi.foundation.infrastructure.CollectionAlgorithms

public final class CollectionAlgorithms
extends Object

Contains algorithms that operate on collections.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectionAlgorithms.ComparisonOfDifferentTypes<T1,T2> Represents a method that compares two objects of different types.

Method Summary

Modifier and Type	Method and Description
static <T> int	binarySearch(List<T> collection, T item) Uses a binary search algorithm to locate a specific element in the sorted List.
static <T> int	binarySearch(List<T> collection, T item, Comparator<T> comparer) Uses a binary search algorithm to locate a specific element in the sorted List.
static <T> int	binarySearch(List<T> collection, T item, Comparator<T> comparer, int startIndex, int length) Uses a binary search algorithm to locate a specific element in the sorted List.
static <TListItem,TMatchItem> int	binarySearch(List<TListItem> collection, TMatchItem item, CollectionAlgorithms.ComparisonOfDifferentTypes<TListItem,TMatchItem> comparer) Uses a binary search algorithm to locate a specific element in the sorted List.
static <TListItem,TMatchItem> int	binarySearch(List<TListItem> collection, TMatchItem item, CollectionAlgorithms.ComparisonOfDifferentTypes<TListItem,TMatchItem> comparer, int startIndex, int length) Uses a binary search algorithm to locate a specific element in the sorted List.
static double[][]	createJaggedDoubleArray(int n, int m) Creates a two-dimensional, jagged double array of the specified dimensions.
static <T> void	reverse(List<T> collection) Reverses the sequences of elements in a collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

binarySearch

public static <T> int binarySearch(@Nonnull
                                   List<T> collection,
                                   T item)

Uses a binary search algorithm to locate a specific element in the sorted List.

Type Parameters:

T - The type of item in the collection.

Parameters:

collection - The collection to search.

item - The item to find.

Returns:

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 (get).

binarySearch

public static <T> int binarySearch(@Nonnull
                                   List<T> collection,
                                   T item,
                                   Comparator<T> comparer)

Uses a binary search algorithm to locate a specific element in the sorted List.

Type Parameters:

T - The type of item in the collection.

Parameters:

collection - The collection to search.

item - The item to find.

comparer - The Comparator implementation to use when comparing elements.

Returns:

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 (get).

binarySearch

public static <T> int binarySearch(@Nonnull
                                   List<T> collection,
                                   T item,
                                   @Nonnull
                                   Comparator<T> comparer,
                                   int startIndex,
                                   int length)

Uses a binary search algorithm to locate a specific element in the sorted List.

Type Parameters:

T - The type of item in the collection.

Parameters:

collection - The collection to search.

item - The item to find.

comparer - The Comparator implementation to use when comparing elements.

startIndex - The index of the first item to consider in the search.

length - The number of items to consider in the search, starting with startIndex.

Returns:

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 (get).

binarySearch

public static <TListItem,TMatchItem> int binarySearch(@Nonnull
                                                      List<TListItem> collection,
                                                      TMatchItem item,
                                                      CollectionAlgorithms.ComparisonOfDifferentTypes<TListItem,TMatchItem> comparer)

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

Type Parameters:

TListItem - The type of item in the collection.

TMatchItem - The type of item to search for.

Parameters:

collection - The collection to search.

item - The item to find.

comparer - The comparison to use to compare items in the collection to the item to search for.

Returns:

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 (get).

binarySearch

public static <TListItem,TMatchItem> int binarySearch(@Nonnull
                                                      List<TListItem> collection,
                                                      TMatchItem item,
                                                      @Nonnull
                                                      CollectionAlgorithms.ComparisonOfDifferentTypes<TListItem,TMatchItem> comparer,
                                                      int startIndex,
                                                      int length)

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

Type Parameters:

TListItem - The type of item in the collection.

TMatchItem - The type of item to search for.

Parameters:

collection - The collection to search.

item - The item to find.

comparer - The comparison to use to compare items in the collection to the item to search for.

startIndex - The index of the first item to consider in the search.

length - The number of items to consider in the search, starting with startIndex.

Returns:

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 (get).

reverse

public static <T> void reverse(@Nonnull
                               List<T> collection)

Reverses the sequences of elements in a collection.

Type Parameters:

T - The type of the element in the collection to reverse.

Parameters:

collection - The collection to reverse.

createJaggedDoubleArray

@Nonnull
public static double[][] createJaggedDoubleArray(int n,
                                                           int m)

Creates a two-dimensional, jagged double array of the specified dimensions.

Parameters:

n - The dimension of the outer array.

m - The dimension of the inner array.

Returns:

The new jagged array.