01: /*
02: * Primitive Collections for Java.
03: * Copyright (C) 2002 Søren Bak
04: *
05: * This library is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU Lesser General Public
07: * License as published by the Free Software Foundation; either
08: * version 2.1 of the License, or (at your option) any later version.
09: *
10: * This library is distributed in the hope that it will be useful,
11: * but WITHOUT ANY WARRANTY; without even the implied warranty of
12: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: * Lesser General Public License for more details.
14: *
15: * You should have received a copy of the GNU Lesser General Public
16: * License along with this library; if not, write to the Free Software
17: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18: */
19: package bak.pcj.hash;
20:
21: /**
22: * This interface represents hash functions from short values
23: * to int values. The int value result is chosen to achieve
24: * consistence with the common
25: * {@link Object#hashCode() hashCode()}
26: * method. The interface is provided to alter the hash functions used
27: * by hashing data structures, like
28: * {@link bak.pcj.map.ShortKeyIntChainedHashMap ShortKeyIntChainedHashMap}
29: * or
30: * {@link bak.pcj.set.ShortChainedHashSet ShortChainedHashSet}.
31: *
32: * @see DefaultShortHashFunction
33: *
34: * @author Søren Bak
35: * @version 1.0 2002/29/12
36: * @since 1.0
37: */
38: public interface ShortHashFunction {
39:
40: /**
41: * Returns a hash code for a specified short value.
42: *
43: * @param v
44: * the value for which to return a hash code.
45: *
46: * @return a hash code for the specified value.
47: */
48: int hash(short v);
49:
50: }
|