XYEncodingUtils

java.lang.Object
- org.apache.lucene.geo.XYEncodingUtils

public final class XYEncodingUtils
extends java.lang.Object

reusable cartesian geometry encoding methods

Field Summary

Fields
Modifier and Type Field Description

static double MAX_VAL_INCL

static double MIN_VAL_INCL

Constructor Summary

Constructors
Modifier Constructor Description

private XYEncodingUtils()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) static float`	`checkVal(float x)`	validates value is a number and finite
`static float`	`decode(byte[] src, int offset)`	Turns quantized value from byte array back into a double.
`static float`	`decode(int encoded)`	Turns quantized value from `encode(float)` back into a double.
`static int`	`encode(float x)`	Quantizes double (64 bit) values into 32 bits
`(package private) static double[]`	`floatArrayToDoubleArray(float[] f)`

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
- Constructor Detail
  - XYEncodingUtils
```
private XYEncodingUtils()
```
- Method Detail
  - checkVal
```
static float checkVal(float x)
```
    validates value is a number and finite
  - encode
```
public static int encode(float x)
```
    Quantizes double (64 bit) values into 32 bits
    
    Parameters:
    
    x - cartesian value
    
    Returns:
    
    encoded value as a 32-bit int
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is out of bounds
  - decode
```
public static float decode(int encoded)
```
    Turns quantized value from encode(float) back into a double.
    
    Parameters:
    
    encoded - encoded value: 32-bit quantized value.
    
    Returns:
    
    decoded value value.
  - decode
```
public static float 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.
  - floatArrayToDoubleArray
```
static double[] floatArrayToDoubleArray(float[] f)
```