net.openhft.chronicle.bytes.algo

Interface BytesStoreHash<B extends BytesStore>

Type Parameters:

B - the type of BytesStore that this function can compute hash values for.

All Superinterfaces:

ToLongFunction<B>

All Known Implementing Classes:

OptimisedBytesStoreHash, VanillaBytesStoreHash, XxHash

public interface BytesStoreHash<B extends BytesStore>
extends ToLongFunction<B>

Represents a function that computes a 64-bit hash value from a BytesStore. Implementations provide fast, deterministic hashing based on little-endian variants of the Murmur3 algorithm. This interface also exposes static helpers for computing 32-bit and 64-bit hashes using the bundled implementations.

Implementations should avoid allocating memory and may assume that length bytes can be read without extra bounds checks. See algo-overview.adoc for usage examples.

Method Summary

Modifier and Type	Method and Description
long	applyAsLong(BytesStore<?,?> bytes, long length) Computes a 64-bit hash value of the given BytesStore with a specified length.
static long	hash(@NotNull BytesStore<?,?> b) Computes a 64-bit hash value of the given BytesStore.
static long	hash(@NotNull BytesStore<?,?> b, long length) Computes a 64-bit hash value of the given BytesStore with a specified length.
static int	hash32(BytesStore<?,?> b) Computes a 32-bit hash value of the given BytesStore.
static int	hash32(@NotNull BytesStore<?,?> b, int length) Computes a 32-bit hash value of the given BytesStore with a specified length.

Methods inherited from interface java.util.function.ToLongFunction

applyAsLong

Method Detail

hash

static long hash(@NotNull
                 @NotNull BytesStore<?,?> b)

Computes a 64-bit hash value of the given BytesStore.

Parameters:

b - the BytesStore to compute the hash for.

Returns:

the 64-bit hash value.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - if the resource has been released or closed

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if this resource was accessed by multiple threads in an unsafe way

hash

static long hash(@NotNull
                 @NotNull BytesStore<?,?> b,
                 long length)
          throws IllegalStateException,
                 BufferUnderflowException

Computes a 64-bit hash value of the given BytesStore with a specified length.

Parameters:

b - the BytesStore to compute the hash for.

length - the number of bytes to include in the hash computation.

Returns:

the 64-bit hash value.

Throws:

BufferUnderflowException - if the length specified is greater than the available bytes

net.openhft.chronicle.core.io.ClosedIllegalStateException - if the resource has been released or closed

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if this resource was accessed by multiple threads in an unsafe way

IllegalStateException

hash32

static int hash32(BytesStore<?,?> b)

Computes a 32-bit hash value of the given BytesStore.

Parameters:

b - the BytesStore to compute the hash for.

Returns:

the 32-bit hash value.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - if the resource has been released or closed

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if this resource was accessed by multiple threads in an unsafe way

hash32

static int hash32(@NotNull
                  @NotNull BytesStore<?,?> b,
                  int length)
           throws IllegalStateException,
                  BufferUnderflowException

Computes a 32-bit hash value of the given BytesStore with a specified length.

Parameters:

b - the BytesStore to compute the hash for.

length - the number of bytes to include in the hash computation.

Returns:

the 32-bit hash value.

Throws:

BufferUnderflowException - if the length specified is greater than the available bytes

net.openhft.chronicle.core.io.ClosedIllegalStateException - if the resource has been released or closed

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if this resource was accessed by multiple threads in an unsafe way

IllegalStateException

applyAsLong

long applyAsLong(BytesStore<?,?> bytes,
                 long length)
          throws IllegalStateException,
                 BufferUnderflowException

Computes a 64-bit hash value of the given BytesStore with a specified length.

Parameters:

bytes - the BytesStore to compute the hash for.

length - the number of bytes to include in the hash computation.

Returns:

the 64-bit hash value.

Throws:

BufferUnderflowException - if the length specified is greater than the available bytes

net.openhft.chronicle.core.io.ClosedIllegalStateException - if the resource has been released or closed

net.openhft.chronicle.core.io.ThreadingIllegalStateException - if this resource was accessed by multiple threads in an unsafe way

Implementations are typically branch-free and perform no allocations.

IllegalStateException