What is a best practice of writing hash function in java?
I'm wondering what is the best practice for writing #hashCode() method in java. Good description can be found here. Is it that good?
I'm wondering what is the best practice for writing #hashCode() method in java. Good description can be found here. Is it that good?
Here's a quote from Effective Java 2nd Edition, Item 9: "Always override when you override ":hashCode
equals
While the recipe in this item yields reasonably good hash functions, it does not yield state-of-the-art hash functions, nor do Java platform libraries provide such hash functions as of release 1.6. Writing such hash functions is a research topic, best left to mathematicians and computer scientists. [... Nonetheless,] the techniques described in this item should be adequate for most applications.
int
result
int
c
f
equals
boolean
(f ? 1 : 0)
byte, char, short, int
(int) f
long
(int) (f ^ (f >>> 32))
float
Float.floatToIntBits(f)
double
Double.doubleToLongBits(f)
long
equals
equals
hashCode
null
Arrays.hashCode
c
result
result = 31 * result + c;
Now, of course that recipe is rather complicated, but luckily, you don't have to reimplement it every time, thanks to java.util.Arrays.hashCode(Object[])
.
@Override public int hashCode() {
return Arrays.hashCode(new Object[] {
myInt, //auto-boxed
myDouble, //auto-boxed
myString,
});
}
As of Java 7 there is a convenient varargs variant in java.util.Objects.hash(Object...)
.
A great reference for an implementation of is described in the book Effective Java. After you understand the theory behind generating a good hash function, you may check HashCodeBuilder from Apache commons lang, which implements what's described in the book. From the docs:hashCode()
This class enables a good hashCode method to be built for any class. It follows the rules laid out in the book Effective Java by Joshua Bloch. Writing a good hashCode method is actually quite difficult. This class aims to simplify the process.