net.openhft.hashing.package-info Maven / Gradle / Ivy
/*
* Copyright 2014 Higher Frequency Trading http://www.higherfrequencytrading.com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* API for hashing sequential data and zero-allocation, pretty fast implementations
* of non-cryptographic hash functions.
*
* Currently implemented:
*
* - {@code long}-valued functions: see {@link net.openhft.hashing.LongHashFunction}
*
* -
* {@linkplain net.openhft.hashing.LongHashFunction#metro() metroHash without seed} and
* {@linkplain net.openhft.hashing.LongHashFunction#metro(long) with a seed}.
*
* -
* {@linkplain net.openhft.hashing.LongHashFunction#xx() xxHash without seed} and
* {@linkplain net.openhft.hashing.LongHashFunction#xx(long) with a seed}.
*
* -
* {@linkplain net.openhft.hashing.LongHashFunction#farmUo() FarmHash 1.1 (farmhashuo)
* without seed}, {@linkplain net.openhft.hashing.LongHashFunction#farmUo(long) with one
* seed} and {@linkplain net.openhft.hashing.LongHashFunction#farmUo(long, long) with
* two seeds}.
*
* -
* {@linkplain net.openhft.hashing.LongHashFunction#farmNa() FarmHash 1.0 (farmhashna)
* without seed}, {@linkplain net.openhft.hashing.LongHashFunction#farmNa(long) with one
* seed} and {@linkplain net.openhft.hashing.LongHashFunction#farmNa(long, long) with
* two seeds}.
*
* -
* {@linkplain net.openhft.hashing.LongHashFunction#city_1_1() CityHash 1.1 without seeds},
* {@linkplain net.openhft.hashing.LongHashFunction#city_1_1(long) with one seed} and
* {@linkplain net.openhft.hashing.LongHashFunction#city_1_1(long, long) with two seeds}.
*
* -
* {@linkplain net.openhft.hashing.LongHashFunction#murmur_3() MurmurHash3 without seed} and
* {@linkplain net.openhft.hashing.LongHashFunction#murmur_3(long) with a seed}.
*
* -
* {@linkplain net.openhft.hashing.LongHashFunction#metro() MetroHash without seed} and
* {@linkplain net.openhft.hashing.LongHashFunction#metro(long) with a seed}.
*
*
*
*
*/
package net.openhft.hashing;