# Uses of Class
org.apache.lucene.queries.function.FunctionValues

Packages that use FunctionValues
Package
Description
org.apache.lucene.queries.function
Queries that compute score based upon a function.
org.apache.lucene.queries.function.docvalues
FunctionValues for different data types.
org.apache.lucene.queries.function.valuesource
A variety of functions to use with FunctionQuery.

- ## Uses of FunctionValues in org.apache.lucene.queries.function

  Fields in org.apache.lucene.queries.function declared as FunctionValues
  Modifier and Type
  Field
  Description
  `protected final FunctionValues`
  ValueSourceScorer.`values`
  Methods in org.apache.lucene.queries.function that return FunctionValues
  Modifier and Type
  Method
  Description
  `abstract FunctionValues`
  ValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  Gets the values for this reader and the context that was previously passed to createWeight().
  Constructors in org.apache.lucene.queries.function with parameters of type FunctionValues
  Modifier
  Constructor
  Description
  `protected`
  `ValueSourceScorer(LeafReaderContext readerContext, FunctionValues values)`

- ## Uses of FunctionValues in org.apache.lucene.queries.function.docvalues

  Subclasses of FunctionValues in org.apache.lucene.queries.function.docvalues
  Modifier and Type
  Class
  Description
  `class`
  `BoolDocValues`
  Abstract `FunctionValues` implementation which supports retrieving boolean values.
  `class`
  `DocTermsIndexDocValues`
  Serves as base class for FunctionValues based on DocTermsIndex.
  `class`
  `DoubleDocValues`
  Abstract `FunctionValues` implementation which supports retrieving double values.
  `class`
  `FloatDocValues`
  Abstract `FunctionValues` implementation which supports retrieving float values.
  `class`
  `IntDocValues`
  Abstract `FunctionValues` implementation which supports retrieving int values.
  `class`
  `LongDocValues`
  Abstract `FunctionValues` implementation which supports retrieving long values.
  `class`
  `StrDocValues`
  Abstract `FunctionValues` implementation which supports retrieving String values.

- ## Uses of FunctionValues in org.apache.lucene.queries.function.valuesource

  Subclasses of FunctionValues in org.apache.lucene.queries.function.valuesource
  Modifier and Type
  Class
  Description
  `class`
  `MultiFunction.Values`
  Base implementation that wraps multiple sources
  `class`
  `VectorFieldFunction`
  An implementation for retrieving `FunctionValues` instances for knn vectors fields.
  Methods in org.apache.lucene.queries.function.valuesource that return FunctionValues
  Modifier and Type
  Method
  Description
  `FunctionValues`
  ByteKnnVectorFieldSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  BytesRefFieldSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  ComparisonBoolFunction.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  ConstKnnByteVectorValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  ConstKnnFloatValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  ConstValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  DefFunction.`getValues(Map<Object,Object> fcontext, LeafReaderContext readerContext)`
  `FunctionValues`
  DocFreqValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  DoubleConstValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  DoubleFieldSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  DualFloatFunction.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  EnumFieldSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  FloatFieldSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  FloatKnnVectorFieldSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  IDFValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  IfFunction.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  IntFieldSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  JoinDocFreqValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  LinearFloatFunction.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  LiteralValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  LongFieldSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  MaxDocValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  MultiFloatFunction.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  NormValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  NumDocsValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  QueryValueSource.`getValues(Map<Object,Object> fcontext, LeafReaderContext readerContext)`
  `FunctionValues`
  RangeMapFloatFunction.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  ReciprocalFloatFunction.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  ScaleFloatFunction.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  SimpleFloatFunction.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  SortedSetFieldSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  SumTotalTermFreqValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  TermFreqValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  TFValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  TotalTermFreqValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  VectorSimilarityFunction.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `FunctionValues`
  VectorValueSource.`getValues(Map<Object,Object> context, LeafReaderContext readerContext)`
  `static FunctionValues[]`
  MultiFunction.`valsArr(List<ValueSource> sources, Map<Object,Object> fcontext, LeafReaderContext readerContext)`
  Methods in org.apache.lucene.queries.function.valuesource with parameters of type FunctionValues
  Modifier and Type
  Method
  Description
  `static boolean`
  MultiFunction.`allExists(int doc, FunctionValues[] values)`
  Helper utility for `FunctionValues`
  `static boolean`
  MultiFunction.`allExists(int doc, FunctionValues values1, FunctionValues values2)`
  Equivalent to the `FunctionValues[]` method with the same name, but optimized for dealing with exactly 2 arguments.
  `static boolean`
  MultiFunction.`anyExists(int doc, FunctionValues[] values)`
  Helper utility for `FunctionValues`
  `static boolean`
  MultiFunction.`anyExists(int doc, FunctionValues values1, FunctionValues values2)`
  Equivalent to the `FunctionValues[]` method with the same name, but optimized for dealing with exactly 2 arguments.
  `abstract boolean`
  ComparisonBoolFunction.`compare(int doc, FunctionValues lhs, FunctionValues rhs)`
  Perform the comparison, returning true or false
  `protected boolean`
  MaxFloatFunction.`exists(int doc, FunctionValues[] valsArr)`
  True if any of the specified `values` `exists(int)` for the specified doc, else false.
  `protected boolean`
  MinFloatFunction.`exists(int doc, FunctionValues[] valsArr)`
  True if any of the specified `values` `exists(int)` for the specified doc, else false.
  `protected boolean`
  MultiFloatFunction.`exists(int doc, FunctionValues[] valsArr)`
  Called by `exists(int)` for each document.
  `protected float`
  ByteVectorSimilarityFunction.`func(int doc, FunctionValues f1, FunctionValues f2)`
  `protected float`
  DivFloatFunction.`func(int doc, FunctionValues aVals, FunctionValues bVals)`
  `protected abstract float`
  DualFloatFunction.`func(int doc, FunctionValues aVals, FunctionValues bVals)`
  `protected float`
  FloatVectorSimilarityFunction.`func(int doc, FunctionValues f1, FunctionValues f2)`
  `protected float`
  MaxFloatFunction.`func(int doc, FunctionValues[] valsArr)`
  `protected float`
  MinFloatFunction.`func(int doc, FunctionValues[] valsArr)`
  `protected abstract boolean`
  MultiBoolFunction.`func(int doc, FunctionValues[] vals)`
  `protected abstract float`
  MultiFloatFunction.`func(int doc, FunctionValues[] valsArr)`
  `protected float`
  PowFloatFunction.`func(int doc, FunctionValues aVals, FunctionValues bVals)`
  `protected float`
  ProductFloatFunction.`func(int doc, FunctionValues[] valsArr)`
  `protected abstract boolean`
  SimpleBoolFunction.`func(int doc, FunctionValues vals)`
  `protected abstract float`
  SimpleFloatFunction.`func(int doc, FunctionValues vals)`
  `protected float`
  SumFloatFunction.`func(int doc, FunctionValues[] valsArr)`
  `protected abstract float`
  VectorSimilarityFunction.`func(int doc, FunctionValues f1, FunctionValues f2)`
  `static String`
  MultiFunction.`toString(String name, FunctionValues[] valsArr, int doc)`
  Constructors in org.apache.lucene.queries.function.valuesource with parameters of type FunctionValues
  Modifier
  Constructor
  Description
  ``
  `Values(FunctionValues[] valsArr)`