## 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 and Description
    --- | ---
    `protected FunctionValues` | ValueSourceScorer.`values`

    Methods in org.apache.lucene.queries.function that return FunctionValues
    Modifier and Type | Method and Description
    --- | ---
    `abstract FunctionValues` | ValueSource.`getValues(Map 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
    Constructor and Description
    `ValueSourceScorer(Weight weight, 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 and 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 and Description
    --- | ---
    `class` | `MultiFunction.Values`

    Methods in org.apache.lucene.queries.function.valuesource that return FunctionValues
    Modifier and Type | Method and Description
    --- | ---
    `FunctionValues` | SumTotalTermFreqValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | ReciprocalFloatFunction.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | MaxDocValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | RangeMapFloatFunction.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | SortedSetFieldSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | IfFunction.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | TotalTermFreqValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | LiteralValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | SimpleFloatFunction.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | LinearFloatFunction.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | NormValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | DefFunction.`getValues(Map fcontext, LeafReaderContext readerContext)`
    `FunctionValues` | IDFValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | ScaleFloatFunction.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | DoubleFieldSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | QueryValueSource.`getValues(Map fcontext, LeafReaderContext readerContext)`
    `FunctionValues` | ConstValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | JoinDocFreqValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | FloatFieldSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | MultiFloatFunction.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | BytesRefFieldSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | IntFieldSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | EnumFieldSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | NumDocsValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | LongFieldSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | ComparisonBoolFunction.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | DualFloatFunction.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | TFValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | DoubleConstValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | VectorValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | DocFreqValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `FunctionValues` | TermFreqValueSource.`getValues(Map context, LeafReaderContext readerContext)`
    `static FunctionValues[]` | MultiFunction.`valsArr(List<ValueSource> sources, Map fcontext, LeafReaderContext readerContext)`

    Methods in org.apache.lucene.queries.function.valuesource with parameters of type FunctionValues
    Modifier and Type | Method and 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` | 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 boolean` | MaxFloatFunction.`exists(int doc, FunctionValues[] valsArr)` True if any of the specified `values` `exists(int)` for the specified doc, else false.
    `protected abstract float` | SimpleFloatFunction.`func(int doc, FunctionValues vals)`
    `protected abstract boolean` | SimpleBoolFunction.`func(int doc, FunctionValues vals)`
    `protected float` | MinFloatFunction.`func(int doc, FunctionValues[] valsArr)`
    `protected abstract boolean` | MultiBoolFunction.`func(int doc, FunctionValues[] vals)`
    `protected float` | ProductFloatFunction.`func(int doc, FunctionValues[] valsArr)`
    `protected float` | SumFloatFunction.`func(int doc, FunctionValues[] valsArr)`
    `protected abstract float` | MultiFloatFunction.`func(int doc, FunctionValues[] valsArr)`
    `protected float` | MaxFloatFunction.`func(int doc, FunctionValues[] valsArr)`
    `protected float` | PowFloatFunction.`func(int doc, FunctionValues aVals, FunctionValues bVals)`
    `protected float` | DivFloatFunction.`func(int doc, FunctionValues aVals, FunctionValues bVals)`
    `protected abstract float` | DualFloatFunction.`func(int doc, FunctionValues aVals, FunctionValues bVals)`
    `static String` | MultiFunction.`toString(String name, FunctionValues[] valsArr, int doc)`

    Constructors in org.apache.lucene.queries.function.valuesource with parameters of type FunctionValues
    Constructor and Description
    `Values(FunctionValues[] valsArr)`

Copyright © 2000-2019 Apache Software Foundation. All Rights Reserved.