squidpony.squidmath

Class HushPointHash

java.lang.Object

squidpony.squidmath.IPointHash.LongImpl

squidpony.squidmath.HushPointHash

All Implemented Interfaces:

IPointHash

public class HushPointHash
extends IPointHash.LongImpl

A group of similar methods for getting hashes of points based on long coordinates in 2, 3, 4, 5, or 6 dimensions and a long for state; this is mostly meant as an optimization of HastyPointHash. This implementation has high enough quality to be useful as a source of random numbers based on positions. You can also consider IntPointHash if your input and output types are usually int, since it's often faster.
This implements IPointHash and has a long it uses internally for state, exposed by getState().

Nested Class Summary

Nested classes/interfaces inherited from interface squidpony.squidmath.IPointHash

IPointHash.IntImpl, IPointHash.LongImpl

Field Summary

Fields

Modifier and Type	Field and Description
static HushPointHash	INSTANCE

Fields inherited from class squidpony.squidmath.IPointHash.LongImpl

state

Constructor Summary

Constructors

Constructor and Description
HushPointHash()
HushPointHash(int state)
HushPointHash(long state)

Method Summary

Modifier and Type	Method and Description
long	getState()
static int	hash256(long x, long y, long s) Gets an 8-bit point hash of a 2D point (x and y are both longs) and a state/seed as a long.
static int	hash256(long x, long y, long z, long s) Gets an 8-bit point hash of a 3D point (x, y, and z are all longs) and a state/seed as a long.
static int	hash256(long x, long y, long z, long w, long s) Gets an 8-bit point hash of a 4D point (x, y, z, and w are all longs) and a state/seed as a long.
static int	hash256(long x, long y, long z, long w, long u, long s) Gets an 8-bit point hash of a 5D point (x, y, z, w, and u are all longs) and a state/seed as a long.
static int	hash256(long x, long y, long z, long w, long u, long v, long s) Gets an 8-bit point hash of a 6D point (x, y, z, w, u, and v are all longs) and a state/seed as a long.
static int	hash32(long x, long y, long s) Gets a 5-bit point hash of a 2D point (x and y are both longs) and a state/seed as a long.
static int	hash32(long x, long y, long z, long s) Gets a 5-bit point hash of a 3D point (x, y, and z are all longs) and a state/seed as a long.
static int	hash32(long x, long y, long z, long w, long s) Gets a 5-bit point hash of a 4D point (x, y, z, and w are all longs) and a state/seed as a long.
static int	hash32(long x, long y, long z, long w, long u, long s) Gets an 5-bit point hash of a 5D point (x, y, z, w, and u are all longs) and a state/seed as a long.
static int	hash32(long x, long y, long z, long w, long u, long v, long s) Gets a 5-bit point hash of a 6D point (x, y, z, w, u, and v are all longs) and a state/seed as a long.
static int	hash64(long x, long y, long s) Gets a 6-bit point hash of a 2D point (x and y are both longs) and a state/seed as a long.
static int	hash64(long x, long y, long z, long s) Gets a 6-bit point hash of a 3D point (x, y, and z are all longs) and a state/seed as a long.
static int	hash64(long x, long y, long z, long w, long s) Gets a 6-bit point hash of a 4D point (x, y, z, and w are all longs) and a state/seed as a long.
static int	hash64(long x, long y, long z, long w, long u, long s) Gets an 5-bit point hash of a 5D point (x, y, z, w, and u are all longs) and a state/seed as a long.
static int	hash64(long x, long y, long z, long w, long u, long v, long s) Gets a 6-bit point hash of a 6D point (x, y, z, w, u, and v are all longs) and a state/seed as a long.
static long	hashAll(long x, long y, long s) Gets a 64-bit point hash of a 2D point (x and y are both longs) and a state/seed as a long.
static long	hashAll(long x, long y, long z, long s) Gets a 64-bit point hash of a 3D point (x, y, and z are all longs) and a state/seed as a long.
static long	hashAll(long x, long y, long z, long w, long s) Gets a 64-bit point hash of a 4D point (x, y, z, and w are all longs) and a state/seed as a long.
static long	hashAll(long x, long y, long z, long w, long u, long s) Gets a 64-bit point hash of a 5D point (x, y, z, w, and u are all longs) and a state/seed as a long.
static long	hashAll(long x, long y, long z, long w, long u, long v, long s) Gets a 64-bit point hash of a 6D point (x, y, z, w, u, and v are all longs) and a state/seed as a long.
int	hashWithState(int x, int y, int state)
int	hashWithState(int x, int y, int z, int state)
int	hashWithState(int x, int y, int z, int w, int state)
int	hashWithState(int x, int y, int z, int w, int u, int state)
int	hashWithState(int x, int y, int z, int w, int u, int v, int state)

Methods inherited from class squidpony.squidmath.IPointHash.LongImpl

hash, hash, hash, hash, hash, setState, setState

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final HushPointHash INSTANCE

Constructor Detail

HushPointHash

public HushPointHash()

HushPointHash

public HushPointHash(int state)

HushPointHash

public HushPointHash(long state)

Method Detail

hashWithState

public int hashWithState(int x,
                         int y,
                         int state)

hashWithState

public int hashWithState(int x,
                         int y,
                         int z,
                         int state)

hashWithState

public int hashWithState(int x,
                         int y,
                         int z,
                         int w,
                         int state)

hashWithState

public int hashWithState(int x,
                         int y,
                         int z,
                         int w,
                         int u,
                         int state)

hashWithState

public int hashWithState(int x,
                         int y,
                         int z,
                         int w,
                         int u,
                         int v,
                         int state)

getState

public long getState()

hashAll

public static long hashAll(long x,
                           long y,
                           long s)

Gets a 64-bit point hash of a 2D point (x and y are both longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

s - the state/seed; any long

Returns:

64-bit hash of the x,y point with the given state

hashAll

public static long hashAll(long x,
                           long y,
                           long z,
                           long s)

Gets a 64-bit point hash of a 3D point (x, y, and z are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

s - the state/seed; any long

Returns:

64-bit hash of the x,y,z point with the given state

hashAll

public static long hashAll(long x,
                           long y,
                           long z,
                           long w,
                           long s)

Gets a 64-bit point hash of a 4D point (x, y, z, and w are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

w - w position; any long

s - the state; any long

Returns:

64-bit hash of the x,y,z,w point with the given state

hashAll

public static long hashAll(long x,
                           long y,
                           long z,
                           long w,
                           long u,
                           long s)

Gets a 64-bit point hash of a 5D point (x, y, z, w, and u are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

w - w position; any long

u - u position; any long

s - the state; any long

Returns:

64-bit hash of the x,y,z,w,u point with the given state

hashAll

public static long hashAll(long x,
                           long y,
                           long z,
                           long w,
                           long u,
                           long v,
                           long s)

Gets a 64-bit point hash of a 6D point (x, y, z, w, u, and v are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

w - w position; any long

u - u position; any long

v - v position; any long

s - the state; any long

Returns:

64-bit hash of the x,y,z,w,u,v point with the given state

hash256

public static int hash256(long x,
                          long y,
                          long s)

Gets an 8-bit point hash of a 2D point (x and y are both longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

s - the state/seed; any long

Returns:

8-bit hash of the x,y point with the given state

hash256

public static int hash256(long x,
                          long y,
                          long z,
                          long s)

Gets an 8-bit point hash of a 3D point (x, y, and z are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

s - the state/seed; any long

Returns:

8-bit hash of the x,y,z point with the given state

hash256

public static int hash256(long x,
                          long y,
                          long z,
                          long w,
                          long s)

Gets an 8-bit point hash of a 4D point (x, y, z, and w are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

w - w position; any long

s - the state; any long

Returns:

8-bit hash of the x,y,z,w point with the given state

hash256

public static int hash256(long x,
                          long y,
                          long z,
                          long w,
                          long u,
                          long s)

Gets an 8-bit point hash of a 5D point (x, y, z, w, and u are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

w - w position; any long

u - u position; any long

s - the state; any long

Returns:

8-bit hash of the x,y,z,w,u point with the given state

hash256

public static int hash256(long x,
                          long y,
                          long z,
                          long w,
                          long u,
                          long v,
                          long s)

Gets an 8-bit point hash of a 6D point (x, y, z, w, u, and v are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

w - w position; any long

u - u position; any long

v - v position; any long

s - the state; any long

Returns:

8-bit hash of the x,y,z,w,u,v point with the given state

hash32

public static int hash32(long x,
                         long y,
                         long s)

Gets a 5-bit point hash of a 2D point (x and y are both longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

s - the state/seed; any long

Returns:

5-bit hash of the x,y point with the given state

hash32

public static int hash32(long x,
                         long y,
                         long z,
                         long s)

Gets a 5-bit point hash of a 3D point (x, y, and z are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

s - the state/seed; any long

Returns:

5-bit hash of the x,y,z point with the given state

hash32

public static int hash32(long x,
                         long y,
                         long z,
                         long w,
                         long s)

Gets a 5-bit point hash of a 4D point (x, y, z, and w are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

w - w position; any long

s - the state; any long

Returns:

5-bit hash of the x,y,z,w point with the given state

hash32

public static int hash32(long x,
                         long y,
                         long z,
                         long w,
                         long u,
                         long s)

Gets an 5-bit point hash of a 5D point (x, y, z, w, and u are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

w - w position; any long

u - u position; any long

s - the state; any long

Returns:

5-bit hash of the x,y,z,w,u point with the given state

hash32

public static int hash32(long x,
                         long y,
                         long z,
                         long w,
                         long u,
                         long v,
                         long s)

Gets a 5-bit point hash of a 6D point (x, y, z, w, u, and v are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

w - w position; any long

u - u position; any long

v - v position; any long

s - the state; any long

Returns:

5-bit hash of the x,y,z,w,u,v point with the given state

hash64

public static int hash64(long x,
                         long y,
                         long s)

Gets a 6-bit point hash of a 2D point (x and y are both longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

s - the state/seed; any long

Returns:

6-bit hash of the x,y point with the given state

hash64

public static int hash64(long x,
                         long y,
                         long z,
                         long s)

Gets a 6-bit point hash of a 3D point (x, y, and z are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

s - the state/seed; any long

Returns:

6-bit hash of the x,y,z point with the given state

hash64

public static int hash64(long x,
                         long y,
                         long z,
                         long w,
                         long s)

Gets a 6-bit point hash of a 4D point (x, y, z, and w are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

w - w position; any long

s - the state; any long

Returns:

6-bit hash of the x,y,z,w point with the given state

hash64

public static int hash64(long x,
                         long y,
                         long z,
                         long w,
                         long u,
                         long s)

Gets an 5-bit point hash of a 5D point (x, y, z, w, and u are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

w - w position; any long

u - u position; any long

s - the state; any long

Returns:

5-bit hash of the x,y,z,w,u point with the given state

hash64

public static int hash64(long x,
                         long y,
                         long z,
                         long w,
                         long u,
                         long v,
                         long s)

Gets a 6-bit point hash of a 6D point (x, y, z, w, u, and v are all longs) and a state/seed as a long.

Parameters:

x - x position; any long

y - y position; any long

z - z position; any long

w - w position; any long

u - u position; any long

v - v position; any long

s - the state; any long

Returns:

6-bit hash of the x,y,z,w,u,v point with the given state