org.apache.lucene.search

## Class DocValuesStats.SortedDoubleDocValuesStats

- java.lang.Object
- - org.apache.lucene.search.DocValuesStats<T>
  - - org.apache.lucene.search.DocValuesStats.SortedNumericDocValuesStats<Double>
    - - org.apache.lucene.search.DocValuesStats.SortedDoubleDocValuesStats

- Enclosing class:
    DocValuesStats<T>

      public static final class DocValuesStats.SortedDoubleDocValuesStats
      extends DocValuesStats.SortedNumericDocValuesStats<Double>

  Holds DocValues statistics for a sorted-numeric field storing `double` values.

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class org.apache.lucene.search.DocValuesStats

      `DocValuesStats.DoubleDocValuesStats, DocValuesStats.LongDocValuesStats, DocValuesStats.NumericDocValuesStats<T extends Number>, DocValuesStats.SortedDocValuesStats, DocValuesStats.SortedDoubleDocValuesStats, DocValuesStats.SortedLongDocValuesStats, DocValuesStats.SortedNumericDocValuesStats<T extends Number>, DocValuesStats.SortedSetDocValuesStats`

  - ### Field Summary

    - ### Fields inherited from class org.apache.lucene.search.DocValuesStats.SortedNumericDocValuesStats

      `mean, sndv, valuesCount, variance`

    - ### Fields inherited from class org.apache.lucene.search.DocValuesStats

      `field, max, min`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SortedDoubleDocValuesStats(String field)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `doAccumulate(int count)` Called after `DocValuesStats.accumulate(int)` was processed and verified that the document has a value for the field.
    `Double` | `sum()` Returns the sum of values of the field.

    - ### Methods inherited from class org.apache.lucene.search.DocValuesStats.SortedNumericDocValuesStats

      `hasValue, init, mean, stdev, valuesCount, variance`

    - ### Methods inherited from class org.apache.lucene.search.DocValuesStats

      `count, field, max, min, missing`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### SortedDoubleDocValuesStats

          public SortedDoubleDocValuesStats(String field)

  - ### Method Detail

    - #### doAccumulate

          protected void doAccumulate(int count)
                               throws IOException

      Description copied from class: `DocValuesStats`
      Called after `DocValuesStats.accumulate(int)` was processed and verified that the document has a value for the field. Implementations should update the statistics based on the value of the current document.
      Specified by:
        `doAccumulate` in class `DocValuesStats<Double>`
      Parameters:
        `count` - the updated number of documents with value for this field.
      Throws:
        `IOException`

    - #### sum

          public Double sum()

      Description copied from class: `DocValuesStats.SortedNumericDocValuesStats`
      Returns the sum of values of the field. Note that if the values are large, the `sum` might overflow.
      Specified by:
        `sum` in class `DocValuesStats.SortedNumericDocValuesStats<Double>`

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