org.apache.lucene.geo

Class XYEncodingUtils

java.lang.Object

org.apache.lucene.geo.XYEncodingUtils

public final class XYEncodingUtils
extends Object

reusable cartesian geometry encoding methods

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
static double	MAX_VAL_INCL
static double	MIN_VAL_INCL

Method Summary

Modifier and Type	Method and Description
static void	checkVal(double x) validates value is within +/-Float.MAX_VALUE coordinate bounds
static double	decode(byte[] src, int offset) Turns quantized value from byte array back into a double.
static double	decode(int encoded) Turns quantized value from encode(double) back into a double.
static int	encode(double x) Quantizes double (64 bit) values into 32 bits

Methods inherited from class java.lang.Object

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

Field Detail

MIN_VAL_INCL

public static final double MIN_VAL_INCL

See Also:

Constant Field Values

MAX_VAL_INCL

public static final double MAX_VAL_INCL

See Also:

Constant Field Values

Method Detail

checkVal

public static void checkVal(double x)

validates value is within +/-Float.MAX_VALUE coordinate bounds

encode

public static int encode(double x)

Quantizes double (64 bit) values into 32 bits

Parameters:

x - cartesian value

Returns:

encoded value as a 32-bit int

Throws:

IllegalArgumentException - if value is out of bounds

decode

public static double decode(int encoded)

Turns quantized value from encode(double) back into a double.

Parameters:

encoded - encoded value: 32-bit quantized value.

Returns:

decoded value value.

decode

public static double decode(byte[] src,
                            int offset)

Turns quantized value from byte array back into a double.

Parameters:

src - byte array containing 4 bytes to decode at offset

offset - offset into src to decode from.

Returns:

decoded value.