agi.foundation.infrastructure

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

Class HashCode

java.lang.Object

agi.foundation.infrastructure.HashCode

public final class HashCode
extends Object

Contains static methods for working with hash codes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HashCode.GetHashCodeFunction<T> A delegate that obtains a hash code for a given item.

Method Summary

Modifier and Type	Method and Description
static int	combine(int... hashes) Combines an arbitrary number of hash codes.
static int	combine(int hash1, int hash2) Combines two hash codes.
static int	combine(int hash1, int hash2, int hash3) Combines three hash codes.
static int	combine(int hash1, int hash2, int hash3, int hash4) Combines four hash codes.
static int	combine(int hash1, int hash2, int hash3, int hash4, int hash5) Combines five hash codes.
static int	getHashCode(boolean b) Gets a hash code for a specified boolean.
static int	getHashCode(double d) Gets a hash code for a specified double.
static int	getHashCode(double[] array) Gets a hash code for the items in the specified array.
static int	getHashCode(double[][] array) Gets a hash code for the items in the specified two dimensional array.
static int	getHashCode(int i) Gets a hash code for a specified int.
static <T> int	getHashCode(Iterable<T> items) Gets a hash code for the items in the specified sequence.
static <T> int	getHashCode(Iterable<T> items, HashCode.GetHashCodeFunction<T> hashCodeFunction) Gets a hash code for the items in the specified sequence.
static int	getHashCode(Object o) Gets a hash code for a specified object, or zero if the object is null.
static int	getHashCode(String s) Gets a hash code for a specified string, or zero if the string is null.
static <T> int	getHashCode(T[] array) Gets a hash code for the items in the specified array.
static <T> int	getHashCode(T[][] array) Gets a hash code for the items in the specified two dimensional array.
static <T> int	getHashCode(T[][] array, HashCode.GetHashCodeFunction<T> hashCodeFunction) Gets a hash code for the items in the specified two dimensional array.
static <T> int	getHashCode(T[] array, HashCode.GetHashCodeFunction<T> hashCodeFunction) Gets a hash code for the items in the specified array.

Methods inherited from class java.lang.Object

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

Method Detail

combine

public static int combine(int hash1,
                          int hash2)

Combines two hash codes.

This method is based on the MurmurHash3 algorithm.

Parameters:

hash1 - The first hash code.

hash2 - The second hash code.

Returns:

The combined hash code.

combine

public static int combine(int hash1,
                          int hash2,
                          int hash3)

Combines three hash codes.

This method is based on the MurmurHash3 algorithm.

Parameters:

hash1 - The first hash code.

hash2 - The second hash code.

hash3 - The third hash code.

Returns:

The combined hash code.

combine

public static int combine(int hash1,
                          int hash2,
                          int hash3,
                          int hash4)

Combines four hash codes.

This method is based on the MurmurHash3 algorithm.

Parameters:

hash1 - The first hash code.

hash2 - The second hash code.

hash3 - The third hash code.

hash4 - The fourth hash code.

Returns:

The combined hash code.

combine

public static int combine(int hash1,
                          int hash2,
                          int hash3,
                          int hash4,
                          int hash5)

Combines five hash codes.

This method is based on the MurmurHash3 algorithm.

Parameters:

hash1 - The first hash code.

hash2 - The second hash code.

hash3 - The third hash code.

hash4 - The fourth hash code.

hash5 - The fifth hash code.

Returns:

The combined hash code.

combine

public static int combine(@Nonnull
                          int... hashes)

Combines an arbitrary number of hash codes.

This method is based on the MurmurHash3 algorithm.

Parameters:

hashes - The hash codes.

Returns:

The combined hash code.

getHashCode

public static int getHashCode(@Nullable
                              Object o)

Gets a hash code for a specified object, or zero if the object is null.

Parameters:

o - The object for which to get the hash code.

Returns:

The hash code of the object, or zero if the object is null.

getHashCode

public static int getHashCode(@Nullable
                              String s)

Gets a hash code for a specified string, or zero if the string is null.

Parameters:

s - The string for which to get the hash code.

Returns:

The hash code of the string, or zero if the string is null.

getHashCode

public static int getHashCode(double d)

Gets a hash code for a specified double. This overload simply calls Double.hashCode() and is provided for convenience.

Parameters:

d - The double for which to get the hash code.

Returns:

The hash code of the double.

getHashCode

public static int getHashCode(int i)

Gets a hash code for a specified int. This overload simply calls Integer.hashCode() and is provided for convenience.

Parameters:

i - The int for which to get the hash code.

Returns:

The hash code of the int.

getHashCode

public static int getHashCode(boolean b)

Gets a hash code for a specified boolean. This overload simply calls Boolean.hashCode() and is provided for convenience.

Parameters:

b - The boolean for which to get the hash code.

Returns:

The hash code of the boolean.

getHashCode

public static <T> int getHashCode(@Nullable
                                  Iterable<T> items)

Gets a hash code for the items in the specified sequence. The hash code is computed by using HashCode.combine(int[]) to combine the hash codes of the items in the sequence. If items is null, the returned hash code is zero.

Type Parameters:

T - The type of item in the sequence.

Parameters:

items - The sequence of items for which to get the hash code.

Returns:

The hash code.

getHashCode

public static <T> int getHashCode(@Nullable
                                  Iterable<T> items,
                                  @Nonnull
                                  HashCode.GetHashCodeFunction<T> hashCodeFunction)

Gets a hash code for the items in the specified sequence. The hash code is computed by using HashCode.combine(int[]) to combine the hash codes of the items in the sequence. If items is null, the returned hash code is zero.

Type Parameters:

T - The type of item in the sequence.

Parameters:

items - The sequence of items for which to get the hash code.

hashCodeFunction - A function for computing the hash code for a given item in the collection.

Returns:

The hash code.

getHashCode

public static <T> int getHashCode(@Nullable
                                  T[] array)

Gets a hash code for the items in the specified array. The hash code is computed by using HashCode.combine(int[]) to combine the hash codes of the items in the array. If the array is null, the returned hash code is zero.

Type Parameters:

T - The type of item in the array.

Parameters:

array - The array for which to get the hash code.

Returns:

The hash code.

getHashCode

public static int getHashCode(@Nullable
                              double[] array)

Gets a hash code for the items in the specified array. The hash code is computed by using HashCode.combine(int[]) to combine the hash codes of the items in the array. If the array is null, the returned hash code is zero.

Parameters:

array - The array for which to get the hash code.

Returns:

The hash code.

getHashCode

public static <T> int getHashCode(@Nullable
                                  T[] array,
                                  @Nonnull
                                  HashCode.GetHashCodeFunction<T> hashCodeFunction)

Gets a hash code for the items in the specified array. The hash code is computed by using HashCode.combine(int[]) to combine the hash codes of the items in the array. If the array is null, the returned hash code is zero.

Type Parameters:

T - The type of item in the array.

Parameters:

array - The array for which to get the hash code.

hashCodeFunction - A function for computing the hash code for a given item in the collection.

Returns:

The hash code.

getHashCode

public static <T> int getHashCode(@Nullable
                                  T[][] array)

Gets a hash code for the items in the specified two dimensional array. The hash code is computed by using HashCode.combine(int[]) to combine the hash codes of the items in the array. If the array is null, the returned hash code is zero.

Type Parameters:

T - The type of item in the array.

Parameters:

array - The two dimensional array for which to get the hash code.

Returns:

The hash code.

getHashCode

public static int getHashCode(@Nullable
                              double[][] array)

Gets a hash code for the items in the specified two dimensional array. The hash code is computed by using HashCode.combine(int[]) to combine the hash codes of the items in the array. If the array is null, the returned hash code is zero.

Parameters:

array - The two dimensional array for which to get the hash code.

Returns:

The hash code.

getHashCode

public static <T> int getHashCode(@Nullable
                                  T[][] array,
                                  @Nonnull
                                  HashCode.GetHashCodeFunction<T> hashCodeFunction)

Gets a hash code for the items in the specified two dimensional array. The hash code is computed by using HashCode.combine(int[]) to combine the hash codes of the items in the array. If the array is null, the returned hash code is zero.

Type Parameters:

T - The type of item in the array.

Parameters:

array - The two dimensional array for which to get the hash code.

hashCodeFunction - A function for computing the hash code for a given item in the collection.

Returns:

The hash code.