Class FloatPoint
- All Implemented Interfaces:
IndexableField
float field for fast range filters. If you also need to store the value, you
should add a separate StoredField instance.
Finding all documents within an N-dimensional at search time is efficient. Multiple values for the same field in one document is allowed.
This field defines static factory methods for creating common queries:
newExactQuery(String, float)for matching an exact 1D point.newSetQuery(String, float...)for matching a set of 1D values.newRangeQuery(String, float, float)for matching a 1D range.newRangeQuery(String, float[], float[])for matching points/ranges in n-dimensional space.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.document.Field
Field.Store -
Field Summary
Fields inherited from class org.apache.lucene.document.Field
fieldsData, name, type -
Constructor Summary
ConstructorsConstructorDescriptionFloatPoint(String name, float... point) Creates a new FloatPoint, indexing the provided N-dimensional float point. -
Method Summary
Modifier and TypeMethodDescriptionstatic floatdecodeDimension(byte[] value, int offset) Decode single float dimensionstatic voidencodeDimension(float value, byte[] dest, int offset) Encode single float dimensionstatic QuerynewExactQuery(String field, float value) Create a query for matching an exact float value.static QuerynewRangeQuery(String field, float[] lowerValue, float[] upperValue) Create a range query for n-dimensional float values.static QuerynewRangeQuery(String field, float lowerValue, float upperValue) Create a range query for float values.static QuerynewSetQuery(String field, float... values) Create a query matching any of the specified 1D values.static QuerynewSetQuery(String field, Collection<Float> values) Create a query matching any of the specified 1D values.static floatnextDown(float f) Return the greatest float that compares less thanfconsistently withFloat.compare(float, float).static floatnextUp(float f) Return the least float that compares greater thanfconsistently withFloat.compare(float, float).Non-null if this field has a numeric valuestatic BytesRefpack(float... point) Pack a float point into a BytesRefvoidsetBytesValue(BytesRef bytes) Expert: change the value of this field.voidsetFloatValue(float value) Expert: change the value of this field.voidsetFloatValues(float... point) Change the values of this fieldtoString()Prints a Field for human consumption.Methods inherited from class org.apache.lucene.document.Field
binaryValue, fieldType, getCharSequenceValue, invertableType, name, readerValue, setBytesValue, setByteValue, setDoubleValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, storedValue, stringValue, tokenStream, tokenStreamValue
-
Constructor Details
-
FloatPoint
Creates a new FloatPoint, indexing the provided N-dimensional float point.- Parameters:
name- field namepoint- float[] value- Throws:
IllegalArgumentException- if the field name or value is null.
-
-
Method Details
-
nextUp
public static float nextUp(float f) Return the least float that compares greater thanfconsistently withFloat.compare(float, float). The only difference withMath.nextUp(float)is that this method returns+0fwhen the argument is-0f. -
nextDown
public static float nextDown(float f) Return the greatest float that compares less thanfconsistently withFloat.compare(float, float). The only difference withMath.nextDown(float)is that this method returns-0fwhen the argument is+0f. -
setFloatValue
public void setFloatValue(float value) Description copied from class:FieldExpert: change the value of this field. SeeField.setStringValue(String).- Overrides:
setFloatValuein classField
-
setFloatValues
public void setFloatValues(float... point) Change the values of this field -
setBytesValue
Description copied from class:FieldExpert: change the value of this field. SeeField.setStringValue(String).NOTE: the provided BytesRef is not copied so be sure not to change it until you're done with this field.
- Overrides:
setBytesValuein classField
-
numericValue
Description copied from interface:IndexableFieldNon-null if this field has a numeric value- Specified by:
numericValuein interfaceIndexableField- Overrides:
numericValuein classField
-
pack
Pack a float point into a BytesRef- Parameters:
point- float[] value- Throws:
IllegalArgumentException- is the value is null or of zero length
-
toString
Description copied from class:FieldPrints a Field for human consumption. -
encodeDimension
public static void encodeDimension(float value, byte[] dest, int offset) Encode single float dimension -
decodeDimension
public static float decodeDimension(byte[] value, int offset) Decode single float dimension -
newExactQuery
Create a query for matching an exact float value.This is for simple one-dimension points, for multidimensional points use
newRangeQuery(String, float[], float[])instead.- Parameters:
field- field name. must not benull.value- float value- Returns:
- a query matching documents with this exact value
- Throws:
IllegalArgumentException- iffieldis null.
-
newRangeQuery
Create a range query for float values.This is for simple one-dimension ranges, for multidimensional ranges use
newRangeQuery(String, float[], float[])instead.You can have half-open ranges (which are in fact </≤ or >/≥ queries) by setting
lowerValue = Float.NEGATIVE_INFINITYorupperValue = Float.POSITIVE_INFINITY.Ranges are inclusive. For exclusive ranges, pass
nextUp(lowerValue)ornextDown(upperValue).Range comparisons are consistent with
Float.compareTo(Float).- Parameters:
field- field name. must not benull.lowerValue- lower portion of the range (inclusive).upperValue- upper portion of the range (inclusive).- Returns:
- a query matching documents within this range.
- Throws:
IllegalArgumentException- iffieldis null.
-
newRangeQuery
Create a range query for n-dimensional float values.You can have half-open ranges (which are in fact </≤ or >/≥ queries) by setting
lowerValue[i] = Float.NEGATIVE_INFINITYorupperValue[i] = Float.POSITIVE_INFINITY.Ranges are inclusive. For exclusive ranges, pass
Math#nextUp(lowerValue[i])orMath.nextDown(upperValue[i]).Range comparisons are consistent with
Float.compareTo(Float).- Parameters:
field- field name. must not benull.lowerValue- lower portion of the range (inclusive). must not benull.upperValue- upper portion of the range (inclusive). must not benull.- Returns:
- a query matching documents within this range.
- Throws:
IllegalArgumentException- iffieldis null, iflowerValueis null, ifupperValueis null, or iflowerValue.length != upperValue.length
-
newSetQuery
Create a query matching any of the specified 1D values. This is the points equivalent ofTermsQuery.- Parameters:
field- field name. must not benull.values- all values to match
-
newSetQuery
Create a query matching any of the specified 1D values. This is the points equivalent ofTermsQuery.- Parameters:
field- field name. must not benull.values- all values to match
-