Index (Lucene 10.5.1 misc API)

# Index

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## A

add(Object, Object) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
add(Object, Object) - Method in class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs
asList(Object) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs

## B

baselineTf(float) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Implemented as: `(x <= min) ? base : sqrt(x+(base**2)-min)` ...but with a special case check for 0.
BinaryDocValueSelector - Class in org.apache.lucene.misc.index
  Use this selector to rearrange an index where documents can be uniquely identified based on `BinaryDocValues`
BinaryDocValueSelector(String, Set<BytesRef>) - Constructor for class org.apache.lucene.misc.index.BinaryDocValueSelector
binaryValue() - Method in class org.apache.lucene.misc.document.LazyDocument.LazyField
bitSet() - Method in record class org.apache.lucene.misc.search.MemoryAccountingBitsetCollectorManager.Result
  Returns the value of the `bitSet` record component.
BPIndexReorderer - Class in org.apache.lucene.misc.index
  Implementation of "recursive graph bisection", also called "bipartite graph partitioning" and often abbreviated BP, an approach to doc ID assignment that aims at reducing the sum of the log gap between consecutive postings.
BPIndexReorderer() - Constructor for class org.apache.lucene.misc.index.BPIndexReorderer
  Constructor.
BPIndexReorderer.NotEnoughRAMException - Exception Class in org.apache.lucene.misc.index
  Exception that is thrown when not enough RAM is available.
BPReorderingMergePolicy - Class in org.apache.lucene.misc.index
  A merge policy that reorders merged segments according to a `BPIndexReorderer`.
BPReorderingMergePolicy(MergePolicy, BPIndexReorderer) - Constructor for class org.apache.lucene.misc.index.BPReorderingMergePolicy
  Sole constructor.
ByteTrackingIndexOutput - Class in org.apache.lucene.misc.store
  An `IndexOutput` that wraps another instance and tracks the number of bytes written
ByteTrackingIndexOutput(IndexOutput, AtomicLong) - Constructor for class org.apache.lucene.misc.store.ByteTrackingIndexOutput
ByteWritesTrackingDirectoryWrapper - Class in org.apache.lucene.misc.store
  `FilterDirectory` that tracks write amplification factor
ByteWritesTrackingDirectoryWrapper(Directory) - Constructor for class org.apache.lucene.misc.store.ByteWritesTrackingDirectoryWrapper
ByteWritesTrackingDirectoryWrapper(Directory, boolean) - Constructor for class org.apache.lucene.misc.store.ByteWritesTrackingDirectoryWrapper
  Constructor with option to track tempOutput

## C

close() - Method in class org.apache.lucene.misc.store.ByteTrackingIndexOutput
close() - Method in class org.apache.lucene.misc.store.DirectIODirectory
collect(int) - Method in class org.apache.lucene.misc.search.MemoryAccountingBitsetCollector
CollectorMemoryTracker - Class in org.apache.lucene.misc
  Default implementation of `MemoryTracker` that tracks allocations and allows setting a memory limit per collector
CollectorMemoryTracker(String, long) - Constructor for class org.apache.lucene.misc.CollectorMemoryTracker
common(Object, Object) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
common(Object, Object) - Method in class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs
compare(TermStats, TermStats) - Method in class org.apache.lucene.misc.HighFreqTerms.DocFreqComparator
compare(TermStats, TermStats) - Method in class org.apache.lucene.misc.HighFreqTerms.TotalTermFreqComparator
computeDocMap(CodecReader, Directory, Executor) - Method in class org.apache.lucene.misc.index.BPIndexReorderer
  Expert: Compute the `Sorter.DocMap` that holds the new doc ID numbering.
config - Variable in class org.apache.lucene.misc.index.IndexRearranger
copyFrom(Directory, String, String, IOContext) - Method in class org.apache.lucene.misc.store.HardlinkCopyDirectoryWrapper
count - Variable in class org.apache.lucene.misc.search.DocValuesStats
count() - Method in class org.apache.lucene.misc.search.DocValuesStats
  The number of documents which have a value of the field.
createDeleteSelectorFromIndex(String, Directory) - Static method in class org.apache.lucene.misc.index.BinaryDocValueSelector
  Create a selector for the deletes in an index, which can then be applied to a rearranged index
createLiveSelectorsFromIndex(String, Directory) - Static method in class org.apache.lucene.misc.index.BinaryDocValueSelector
  Create a list of selectors that will reproduce the index geometry when used with `IndexRearranger`
createOutput(String, IOContext) - Method in class org.apache.lucene.misc.store.ByteWritesTrackingDirectoryWrapper
createOutput(String, IOContext) - Method in class org.apache.lucene.misc.store.DirectIODirectory
createTempOutput(String, String, IOContext) - Method in class org.apache.lucene.misc.store.ByteWritesTrackingDirectoryWrapper
createWeight(IndexSearcher, ScoreMode, float) - Method in class org.apache.lucene.misc.search.HumanReadableQuery

## D

DEFAULT_MAX_ITERS - Static variable in class org.apache.lucene.misc.index.BPIndexReorderer
  Default maximum number of iterations per recursion level: 20.
DEFAULT_MERGE_BUFFER_SIZE - Static variable in class org.apache.lucene.misc.store.DirectIODirectory
  Default buffer size before writing to disk (256 KB); larger means less IO load but more RAM and direct buffer storage space consumed during merging.
DEFAULT_MIN_BYTES_DIRECT - Static variable in class org.apache.lucene.misc.store.DirectIODirectory
  Default min expected merge size before direct IO is used (10 MB):
DEFAULT_MIN_DOC_FREQ - Static variable in class org.apache.lucene.misc.index.BPIndexReorderer
  Minimum required document frequency for terms to be considered: 4,096.
DEFAULT_MIN_PARTITION_SIZE - Static variable in class org.apache.lucene.misc.index.BPIndexReorderer
  Minimum size of partitions.
DEFAULT_NUMTERMS - Static variable in class org.apache.lucene.misc.HighFreqTerms
deletedDocsSelector - Variable in class org.apache.lucene.misc.index.IndexRearranger
DirectIODirectory - Search tag in Overview
  Section
DirectIODirectory - Class in org.apache.lucene.misc.store
  A `Directory` implementation for all Unixes and Windows that uses DIRECT I/O to bypass OS level IO caching during merging.
DirectIODirectory(FSDirectory) - Constructor for class org.apache.lucene.misc.store.DirectIODirectory
  Create a new DirectIODirectory for the named location.
DirectIODirectory(FSDirectory, int, long) - Constructor for class org.apache.lucene.misc.store.DirectIODirectory
  Create a new DirectIODirectory for the named location.
DiversifiedTopDocsCollector - Class in org.apache.lucene.misc.search
  A `TopDocsCollector` that controls diversity in results by ensuring no more than maxHitsPerKey results from a common source are collected in the final results.
DiversifiedTopDocsCollector(int, int) - Constructor for class org.apache.lucene.misc.search.DiversifiedTopDocsCollector
DiversifiedTopDocsCollector.ScoreDocKey - Class in org.apache.lucene.misc.search
  An extension to ScoreDoc that includes a key used for grouping purposes
DiversifiedTopDocsCollectorManager<C> - Class in org.apache.lucene.misc.search
  A `CollectorManager` for `DiversifiedTopDocsCollector`.
DiversifiedTopDocsCollectorManager(int, int) - Constructor for class org.apache.lucene.misc.search.DiversifiedTopDocsCollectorManager
doAccumulate(int) - Method in class org.apache.lucene.misc.search.DocValuesStats
  Called after `DocValuesStats.accumulate(int)` was processed and verified that the document has a value for the field.
doAccumulate(int) - Method in class org.apache.lucene.misc.search.DocValuesStats.DoubleDocValuesStats
doAccumulate(int) - Method in class org.apache.lucene.misc.search.DocValuesStats.LongDocValuesStats
doAccumulate(int) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedDocValuesStats
doAccumulate(int) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedDoubleDocValuesStats
doAccumulate(int) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedLongDocValuesStats
doAccumulate(int) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedSetDocValuesStats
docFreq - Variable in class org.apache.lucene.misc.TermStats
DocFreqComparator() - Constructor for class org.apache.lucene.misc.HighFreqTerms.DocFreqComparator
DocValuesStats<T> - Class in org.apache.lucene.misc.search
  Holds statistics for a DocValues field.
DocValuesStats(String, T, T) - Constructor for class org.apache.lucene.misc.search.DocValuesStats
DocValuesStats.DoubleDocValuesStats - Class in org.apache.lucene.misc.search
  Holds DocValues statistics for a numeric field storing `double` values.
DocValuesStats.LongDocValuesStats - Class in org.apache.lucene.misc.search
  Holds DocValues statistics for a numeric field storing `long` values.
DocValuesStats.NumericDocValuesStats<T> - Class in org.apache.lucene.misc.search
  Holds statistics for a numeric DocValues field.
DocValuesStats.SortedDocValuesStats - Class in org.apache.lucene.misc.search
  Holds statistics for a sorted DocValues field.
DocValuesStats.SortedDoubleDocValuesStats - Class in org.apache.lucene.misc.search
  Holds DocValues statistics for a sorted-numeric field storing `double` values.
DocValuesStats.SortedLongDocValuesStats - Class in org.apache.lucene.misc.search
  Holds DocValues statistics for a sorted-numeric field storing `long` values.
DocValuesStats.SortedNumericDocValuesStats<T> - Class in org.apache.lucene.misc.search
  Holds statistics for a sorted-numeric DocValues field.
DocValuesStats.SortedSetDocValuesStats - Class in org.apache.lucene.misc.search
  Holds statistics for a sorted-set DocValues field.
DocValuesStatsCollector - Class in org.apache.lucene.misc.search
  A `Collector` which computes statistics for a DocValues field.
DocValuesStatsCollector(DocValuesStats<?>) - Constructor for class org.apache.lucene.misc.search.DocValuesStatsCollector
  Creates a collector to compute statistics for a DocValues field using the given `stats`.
DocValuesStatsCollectorManager<T,S> - Class in org.apache.lucene.misc.search
  A `CollectorManager` implementation for `DocValuesStatsCollector`.
DocValuesStatsCollectorManager(Supplier<S>) - Constructor for class org.apache.lucene.misc.search.DocValuesStatsCollectorManager
  Creates a new DocValuesStatsCollectorManager.
doSetNextReader(LeafReaderContext) - Method in class org.apache.lucene.misc.search.MemoryAccountingBitsetCollector
DoubleDocValuesStats(String) - Constructor for class org.apache.lucene.misc.search.DocValuesStats.DoubleDocValuesStats

## E

ensureOpen() - Method in class org.apache.lucene.misc.store.DirectIODirectory
equals(Object) - Method in class org.apache.lucene.misc.search.HumanReadableQuery
equals(Object) - Method in record class org.apache.lucene.misc.search.MemoryAccountingBitsetCollectorManager.Result
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs.TwoLongs
  Indicates whether some other object is "equal to" this one.
execute() - Method in class org.apache.lucene.misc.index.IndexRearranger

## F

field - Variable in class org.apache.lucene.misc.search.DocValuesStats
field - Variable in class org.apache.lucene.misc.TermStats
field() - Method in class org.apache.lucene.misc.search.DocValuesStats
  The field for which these stats were computed.
fieldType() - Method in class org.apache.lucene.misc.document.LazyDocument.LazyField
findForcedDeletesMerges(SegmentInfos, MergePolicy.MergeContext) - Method in class org.apache.lucene.misc.index.BPReorderingMergePolicy
findForcedMerges(SegmentInfos, int, Map<SegmentCommitInfo, Boolean>, MergePolicy.MergeContext) - Method in class org.apache.lucene.misc.index.BPReorderingMergePolicy
findFullFlushMerges(MergeTrigger, SegmentInfos, MergePolicy.MergeContext) - Method in class org.apache.lucene.misc.index.BPReorderingMergePolicy
findMerges(CodecReader...) - Method in class org.apache.lucene.misc.index.BPReorderingMergePolicy
findMerges(MergeTrigger, SegmentInfos, MergePolicy.MergeContext) - Method in class org.apache.lucene.misc.index.BPReorderingMergePolicy
first() - Method in record class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs.TwoLongs
  Returns the value of the `first` record component.

## G

get(long) - Method in class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs
get(long, long) - Method in class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs
getBytes() - Method in class org.apache.lucene.misc.CollectorMemoryTracker
getBytes() - Method in interface org.apache.lucene.misc.util.MemoryTracker
getDescription() - Method in class org.apache.lucene.misc.search.HumanReadableQuery
getDirectory() - Method in class org.apache.lucene.misc.store.DirectIODirectory
getField(FieldInfo) - Method in class org.apache.lucene.misc.document.LazyDocument
  Creates a StorableField whose value will be lazy loaded if and when it is used.
getFilteredDocs(CodecReader) - Method in class org.apache.lucene.misc.index.BinaryDocValueSelector
getFilteredDocs(CodecReader) - Method in interface org.apache.lucene.misc.index.IndexRearranger.DocumentSelector
getFlushedBytes() - Method in class org.apache.lucene.misc.store.ByteWritesTrackingDirectoryWrapper
getHighFreqTerms(IndexReader, int, String, Comparator<TermStats>) - Static method in class org.apache.lucene.misc.HighFreqTerms
  Returns TermStats[] ordered by the specified comparator
getKey() - Method in class org.apache.lucene.misc.search.DiversifiedTopDocsCollector.ScoreDocKey
getKeys(LeafReaderContext) - Method in class org.apache.lucene.misc.search.DiversifiedTopDocsCollector
  Get a source of values used for grouping keys
getLeafCollector(LeafReaderContext) - Method in class org.apache.lucene.misc.search.DiversifiedTopDocsCollector
getLeafCollector(LeafReaderContext) - Method in class org.apache.lucene.misc.search.DocValuesStatsCollector
getMergedBytes() - Method in class org.apache.lucene.misc.store.ByteWritesTrackingDirectoryWrapper
getNoOutput() - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
getNoOutput() - Method in class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs
getSingleton(boolean) - Static method in class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs
getTermInfo(Directory, Term) - Static method in class org.apache.lucene.misc.GetTermInfo
GetTermInfo - Class in org.apache.lucene.misc
  Utility to get document frequency and total number of occurrences (sum of the tf for each doc) of a term.
GetTermInfo() - Constructor for class org.apache.lucene.misc.GetTermInfo
getWrappedQuery() - Method in class org.apache.lucene.misc.search.HumanReadableQuery

## H

HardlinkCopyDirectoryWrapper - Class in org.apache.lucene.misc.store
  This directory wrapper overrides `Directory.copyFrom(Directory, String, String, IOContext)` in order to optionally use a hard-link instead of a full byte by byte file copy if applicable.
HardlinkCopyDirectoryWrapper(Directory) - Constructor for class org.apache.lucene.misc.store.HardlinkCopyDirectoryWrapper
  Creates a new HardlinkCopyDirectoryWrapper delegating to the given directory
hasBeenLoaded() - Method in class org.apache.lucene.misc.document.LazyDocument.LazyField
  non-private for test only access
hashCode() - Method in class org.apache.lucene.misc.search.HumanReadableQuery
hashCode() - Method in record class org.apache.lucene.misc.search.MemoryAccountingBitsetCollectorManager.Result
  Returns a hash code value for this object.
hashCode() - Method in record class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs.TwoLongs
  Returns a hash code value for this object.
hasValue(int) - Method in class org.apache.lucene.misc.search.DocValuesStats
  Returns whether the given document has a value for the requested DocValues field.
hasValue(int) - Method in class org.apache.lucene.misc.search.DocValuesStats.NumericDocValuesStats
hasValue(int) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedDocValuesStats
hasValue(int) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
hasValue(int) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedSetDocValuesStats
HighFreqTerms - Class in org.apache.lucene.misc
  `HighFreqTerms` class extracts the top n most frequent terms (by document frequency) from an existing Lucene index and reports their document frequency.
HighFreqTerms() - Constructor for class org.apache.lucene.misc.HighFreqTerms
HighFreqTerms.DocFreqComparator - Class in org.apache.lucene.misc
  Compares terms by docTermFreq
HighFreqTerms.TotalTermFreqComparator - Class in org.apache.lucene.misc
  Compares terms by totalTermFreq
HumanReadableQuery - Class in org.apache.lucene.misc.search
  A simple query wrapper for debug purposes.
HumanReadableQuery(Query, String) - Constructor for class org.apache.lucene.misc.search.HumanReadableQuery
  Create a new HumanReadableQuery
hyperbolicTf(float) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Uses a hyperbolic tangent function that allows for a hard max...

## I

IndexMergeTool - Class in org.apache.lucene.misc
  Merges indices specified on the command line into the index specified as the first command line argument.
IndexMergeTool() - Constructor for class org.apache.lucene.misc.IndexMergeTool
IndexRearranger - Class in org.apache.lucene.misc.index
  Copy and rearrange index according to document selectors, from input dir to output dir.
IndexRearranger(Directory, Directory, IndexWriterConfig, List<IndexRearranger.DocumentSelector>) - Constructor for class org.apache.lucene.misc.index.IndexRearranger
  Constructor with no deletes to apply
IndexRearranger(Directory, Directory, IndexWriterConfig, List<IndexRearranger.DocumentSelector>, IndexRearranger.DocumentSelector) - Constructor for class org.apache.lucene.misc.index.IndexRearranger
  All args constructor
IndexRearranger.DocumentSelector - Interface in org.apache.lucene.misc.index
  Select document within a CodecReader
IndexSplitter - Class in org.apache.lucene.misc.index
  Command-line tool that enables listing segments in an index, copying specific segments to another index, and deleting segments from an index.
IndexSplitter(Path) - Constructor for class org.apache.lucene.misc.index.IndexSplitter
infos - Variable in class org.apache.lucene.misc.index.IndexSplitter
init(LeafReaderContext) - Method in class org.apache.lucene.misc.search.DocValuesStats
  Initializes this object with the given reader context.
init(LeafReaderContext) - Method in class org.apache.lucene.misc.search.DocValuesStats.NumericDocValuesStats
init(LeafReaderContext) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedDocValuesStats
init(LeafReaderContext) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
init(LeafReaderContext) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedSetDocValuesStats
input - Variable in class org.apache.lucene.misc.index.IndexRearranger
insert(DiversifiedTopDocsCollector.ScoreDocKey, int, NumericDocValues) - Method in class org.apache.lucene.misc.search.DiversifiedTopDocsCollector
invertableType() - Method in class org.apache.lucene.misc.document.LazyDocument.LazyField

## L

LazyDocument - Class in org.apache.lucene.misc.document
  Defers actually loading a field's value until you ask for it.
LazyDocument(IndexReader, int) - Constructor for class org.apache.lucene.misc.document.LazyDocument
LazyDocument.LazyField - Class in org.apache.lucene.misc.document
  Lazy-loaded field
lengthNorm(int) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Implemented as: `1/sqrt( steepness * (abs(x-min) + abs(x-max) - (max-min)) + 1 )` .
ListOfOutputs<T> - Class in org.apache.lucene.misc.util.fst
  Wraps another Outputs implementation and encodes one or more of its output values.
ListOfOutputs(Outputs<T>) - Constructor for class org.apache.lucene.misc.util.fst.ListOfOutputs
listSegments() - Method in class org.apache.lucene.misc.index.IndexSplitter
LongDocValuesStats(String) - Constructor for class org.apache.lucene.misc.search.DocValuesStats.LongDocValuesStats

## M

main(String[]) - Static method in class org.apache.lucene.misc.GetTermInfo
main(String[]) - Static method in class org.apache.lucene.misc.HighFreqTerms
main(String[]) - Static method in class org.apache.lucene.misc.index.IndexSplitter
main(String[]) - Static method in class org.apache.lucene.misc.index.MultiPassIndexSplitter
main(String[]) - Static method in class org.apache.lucene.misc.IndexMergeTool
max - Variable in class org.apache.lucene.misc.search.DocValuesStats
max() - Method in class org.apache.lucene.misc.search.DocValuesStats
  The maximum value of the field.
maxNumPerKey - Variable in class org.apache.lucene.misc.search.DiversifiedTopDocsCollector
mean - Variable in class org.apache.lucene.misc.search.DocValuesStats.NumericDocValuesStats
mean - Variable in class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
mean() - Method in class org.apache.lucene.misc.search.DocValuesStats.NumericDocValuesStats
  The mean of all values of the field.
mean() - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
  The mean of all values of the field.
MemoryAccountingBitsetCollector - Class in org.apache.lucene.misc.search
  Bitset collector which supports memory tracking.
MemoryAccountingBitsetCollector(CollectorMemoryTracker) - Constructor for class org.apache.lucene.misc.search.MemoryAccountingBitsetCollector
MemoryAccountingBitsetCollectorManager - Class in org.apache.lucene.misc.search
  CollectorManager for MemoryAccountingBitsetCollector that supports concurrent search.
MemoryAccountingBitsetCollectorManager(CollectorMemoryTracker) - Constructor for class org.apache.lucene.misc.search.MemoryAccountingBitsetCollectorManager
MemoryAccountingBitsetCollectorManager.Result - Record Class in org.apache.lucene.misc.search
  The result of a search, containing the matched document IDs and total memory used.
MemoryTracker - Interface in org.apache.lucene.misc.util
  Tracks dynamic allocations/deallocations of memory for transient objects
merge(Object, Object) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
merge(Object, Object) - Method in class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs
merge(DocValuesStats<Double>) - Method in class org.apache.lucene.misc.search.DocValuesStats.DoubleDocValuesStats
merge(DocValuesStats<Double>) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedDoubleDocValuesStats
merge(DocValuesStats<Long>) - Method in class org.apache.lucene.misc.search.DocValuesStats.LongDocValuesStats
merge(DocValuesStats<Long>) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedLongDocValuesStats
merge(DocValuesStats<T>) - Method in class org.apache.lucene.misc.search.DocValuesStats
  Merges the statistics from `other` into this instance.
merge(DocValuesStats<T>) - Method in class org.apache.lucene.misc.search.DocValuesStats.NumericDocValuesStats
merge(DocValuesStats<T>) - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
min - Variable in class org.apache.lucene.misc.search.DocValuesStats
min() - Method in class org.apache.lucene.misc.search.DocValuesStats
  The minimum value of the field.
Misc Tools - Search tag in Overview
  Section
missing - Variable in class org.apache.lucene.misc.search.DocValuesStats
missing() - Method in class org.apache.lucene.misc.search.DocValuesStats
  The number of documents which do not have a value of the field.
MultiPassIndexSplitter - Class in org.apache.lucene.misc.index
  This tool splits input index into multiple equal parts.
MultiPassIndexSplitter() - Constructor for class org.apache.lucene.misc.index.MultiPassIndexSplitter

## N

name() - Method in class org.apache.lucene.misc.document.LazyDocument.LazyField
ndv - Variable in class org.apache.lucene.misc.search.DocValuesStats.NumericDocValuesStats
newCollector() - Method in class org.apache.lucene.misc.search.DocValuesStatsCollectorManager
newCollector() - Method in class org.apache.lucene.misc.search.MemoryAccountingBitsetCollectorManager
newTopDocs(ScoreDoc[], int) - Method in class org.apache.lucene.misc.search.DiversifiedTopDocsCollector
NumericDocValuesStats(String, T, T) - Constructor for class org.apache.lucene.misc.search.DocValuesStats.NumericDocValuesStats
numericValue() - Method in class org.apache.lucene.misc.document.LazyDocument.LazyField

## O

openInput(String, IOContext) - Method in class org.apache.lucene.misc.store.DirectIODirectory
openInput(String, IOContext) - Method in class org.apache.lucene.misc.store.RAFDirectory
  Creates an IndexInput for the file with the given name.
org.apache.lucene.misc - package org.apache.lucene.misc
  Miscellaneous Lucene utilities that don't really fit anywhere else.
org.apache.lucene.misc.document - package org.apache.lucene.misc.document
  Misc extensions of the Document/Field API.
org.apache.lucene.misc.index - package org.apache.lucene.misc.index
  Misc index tools and index support.
org.apache.lucene.misc.search - package org.apache.lucene.misc.search
  Misc search implementations.
org.apache.lucene.misc.store - package org.apache.lucene.misc.store
  Misc Directory implementations.
org.apache.lucene.misc.util - package org.apache.lucene.misc.util
  Memory Tracker interface which allows defining custom collector level memory trackers
org.apache.lucene.misc.util.fst - package org.apache.lucene.misc.util.fst
  Misc FST classes.
output - Variable in class org.apache.lucene.misc.index.IndexRearranger
outputToString(Object) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
outputToString(Object) - Method in class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs

## P

PKIndexSplitter - Class in org.apache.lucene.misc.index
  Split an index based on a `Query`.
PKIndexSplitter(Directory, Directory, Directory, Term) - Constructor for class org.apache.lucene.misc.index.PKIndexSplitter
  Split an index based on a given primary key term and a 'middle' term.
PKIndexSplitter(Directory, Directory, Directory, Term, IndexWriterConfig, IndexWriterConfig) - Constructor for class org.apache.lucene.misc.index.PKIndexSplitter
PKIndexSplitter(Directory, Directory, Directory, Query) - Constructor for class org.apache.lucene.misc.index.PKIndexSplitter
  Split an index based on a `Query`.
PKIndexSplitter(Directory, Directory, Directory, Query, IndexWriterConfig, IndexWriterConfig) - Constructor for class org.apache.lucene.misc.index.PKIndexSplitter

## R

RAFDirectory - Class in org.apache.lucene.misc.store
  A straightforward implementation of `FSDirectory` using java.io.RandomAccessFile.
RAFDirectory(Path) - Constructor for class org.apache.lucene.misc.store.RAFDirectory
  Create a new RAFDirectory for the named location and `FSLockFactory.getDefault()`.
RAFDirectory(Path, LockFactory) - Constructor for class org.apache.lucene.misc.store.RAFDirectory
  Create a new RAFDirectory for the named location.
ramBytesUsed(Object) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
ramBytesUsed(Object) - Method in class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs
read(DataInput) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
read(DataInput) - Method in class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs
readerValue() - Method in class org.apache.lucene.misc.document.LazyDocument.LazyField
readFinalOutput(DataInput) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
reduce(Collection<C>) - Method in class org.apache.lucene.misc.search.DiversifiedTopDocsCollectorManager
  Merges per-slice results into a single `TopDocs` while re-applying the diversity constraint globally.
reduce(Collection<DocValuesStatsCollector>) - Method in class org.apache.lucene.misc.search.DocValuesStatsCollectorManager
reduce(Collection<MemoryAccountingBitsetCollector>) - Method in class org.apache.lucene.misc.search.MemoryAccountingBitsetCollectorManager
remove(String[]) - Method in class org.apache.lucene.misc.index.IndexSplitter
reorder(CodecReader, Directory, Executor) - Method in class org.apache.lucene.misc.index.BPIndexReorderer
  Reorder the given `CodecReader` into a reader that tries to minimize the log gap between consecutive documents in postings, which usually helps improve space efficiency and query evaluation efficiency.
Result(FixedBitSet, long) - Constructor for record class org.apache.lucene.misc.search.MemoryAccountingBitsetCollectorManager.Result
  Creates an instance of a `Result` record class.
rewrite(IndexSearcher) - Method in class org.apache.lucene.misc.search.HumanReadableQuery

## S

ScoreDocKey(int, float) - Constructor for class org.apache.lucene.misc.search.DiversifiedTopDocsCollector.ScoreDocKey
scoreMode() - Method in class org.apache.lucene.misc.search.DiversifiedTopDocsCollector
scoreMode() - Method in class org.apache.lucene.misc.search.DocValuesStatsCollector
scoreMode() - Method in class org.apache.lucene.misc.search.MemoryAccountingBitsetCollector
sdv - Variable in class org.apache.lucene.misc.search.DocValuesStats.SortedDocValuesStats
second() - Method in record class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs.TwoLongs
  Returns the value of the `second` record component.
segmentSelectors - Variable in class org.apache.lucene.misc.index.IndexRearranger
setBaselineTfFactors(float, float) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Sets the baseline and minimum function variables for baselineTf
setFields(Set<String>) - Method in class org.apache.lucene.misc.index.BPIndexReorderer
  Sets the fields to use to perform partitioning.
setHyperbolicTfFactors(float, float, double, float) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Sets the function variables for the hyperbolicTf functions
setLengthNormFactors(int, int, float) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Sets the default function variables used by lengthNorm when no field specific variables have been set.
setMaxDocFreq(float) - Method in class org.apache.lucene.misc.index.BPIndexReorderer
  Set the maximum document frequency for terms to be considered, as a ratio of `maxDoc`.
setMaxIters(int) - Method in class org.apache.lucene.misc.index.BPIndexReorderer
  Set the maximum number of iterations on each recursion level, 20 by default.
setMinDocFreq(int) - Method in class org.apache.lucene.misc.index.BPIndexReorderer
  Set the minimum document frequency for terms to be considered, 4096 by default.
setMinNaturalMergeNumDocs(int) - Method in class org.apache.lucene.misc.index.BPReorderingMergePolicy
  Set the minimum number of docs that a merge must have for the resulting segment to be reordered.
setMinNaturalMergeRatioFromBiggestSegment(float) - Method in class org.apache.lucene.misc.index.BPReorderingMergePolicy
  Set the minimum number of docs that a merge must have for the resulting segment to be reordered, as a ratio of the total number of documents of the current biggest segment in the index.
setMinPartitionSize(int) - Method in class org.apache.lucene.misc.index.BPIndexReorderer
  Set the minimum partition size, when the algorithm stops recursing, 32 by default.
setRAMBudgetMB(double) - Method in class org.apache.lucene.misc.index.BPIndexReorderer
  Set the amount of RAM that graph partitioning is allowed to use.
skipFinalOutput(DataInput) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
skipOutput(DataInput) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
sndv - Variable in class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
SortedDocValuesStats(String) - Constructor for class org.apache.lucene.misc.search.DocValuesStats.SortedDocValuesStats
SortedDoubleDocValuesStats(String) - Constructor for class org.apache.lucene.misc.search.DocValuesStats.SortedDoubleDocValuesStats
SortedLongDocValuesStats(String) - Constructor for class org.apache.lucene.misc.search.DocValuesStats.SortedLongDocValuesStats
SortedNumericDocValuesStats(String, T, T) - Constructor for class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
SortedSetDocValuesStats(String) - Constructor for class org.apache.lucene.misc.search.DocValuesStats.SortedSetDocValuesStats
split() - Method in class org.apache.lucene.misc.index.PKIndexSplitter
split(Path, String[]) - Method in class org.apache.lucene.misc.index.IndexSplitter
split(IndexReader, Directory[], boolean) - Method in class org.apache.lucene.misc.index.MultiPassIndexSplitter
  Split source index into multiple parts.
ssdv - Variable in class org.apache.lucene.misc.search.DocValuesStats.SortedSetDocValuesStats
stdev() - Method in class org.apache.lucene.misc.search.DocValuesStats.NumericDocValuesStats
  Returns the stdev of all values of the field.
stdev() - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
  Returns the stdev of all values of the field.
storedValue() - Method in class org.apache.lucene.misc.document.LazyDocument.LazyField
stringValue() - Method in class org.apache.lucene.misc.document.LazyDocument.LazyField
subtract(Object, Object) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
subtract(Object, Object) - Method in class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs
sum() - Method in class org.apache.lucene.misc.search.DocValuesStats.DoubleDocValuesStats
sum() - Method in class org.apache.lucene.misc.search.DocValuesStats.LongDocValuesStats
sum() - Method in class org.apache.lucene.misc.search.DocValuesStats.NumericDocValuesStats
  Returns the sum of values of the field.
sum() - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedDoubleDocValuesStats
sum() - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedLongDocValuesStats
sum() - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
  Returns the sum of values of the field.
SweetSpotSimilarity - Class in org.apache.lucene.misc
  A similarity with a lengthNorm that provides for a "plateau" of equally good lengths, and tf helper functions.
SweetSpotSimilarity() - Constructor for class org.apache.lucene.misc.SweetSpotSimilarity
  Default constructor: parameter-free
SweetSpotSimilarity(boolean) - Constructor for class org.apache.lucene.misc.SweetSpotSimilarity
  Primary constructor.

## T

TermStats - Class in org.apache.lucene.misc
  Holder for a term along with its statistics (`TermStats.docFreq` and `TermStats.totalTermFreq`).
termtext - Variable in class org.apache.lucene.misc.TermStats
tf(float) - Method in class org.apache.lucene.misc.SweetSpotSimilarity
  Delegates to baselineTf
tokenStream(Analyzer, TokenStream) - Method in class org.apache.lucene.misc.document.LazyDocument.LazyField
toString() - Method in class org.apache.lucene.misc.search.DiversifiedTopDocsCollector.ScoreDocKey
toString() - Method in record class org.apache.lucene.misc.search.MemoryAccountingBitsetCollectorManager.Result
  Returns a string representation of this record class.
toString() - Method in class org.apache.lucene.misc.SweetSpotSimilarity
toString() - Method in class org.apache.lucene.misc.TermStats
toString() - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
toString() - Method in record class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs.TwoLongs
  Returns a string representation of this record class.
toString(String) - Method in class org.apache.lucene.misc.search.HumanReadableQuery
totalBytesUsed() - Method in record class org.apache.lucene.misc.search.MemoryAccountingBitsetCollectorManager.Result
  Returns the value of the `totalBytesUsed` record component.
totalTermFreq - Variable in class org.apache.lucene.misc.TermStats
TotalTermFreqComparator() - Constructor for class org.apache.lucene.misc.HighFreqTerms.TotalTermFreqComparator
trackTempOutput - Variable in class org.apache.lucene.misc.store.ByteWritesTrackingDirectoryWrapper
TwoLongs(long, long) - Constructor for record class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs.TwoLongs
  Creates an instance of a `TwoLongs` record class.

## U

updateBytes(long) - Method in class org.apache.lucene.misc.CollectorMemoryTracker
updateBytes(long) - Method in interface org.apache.lucene.misc.util.MemoryTracker
UpToTwoPositiveIntOutputs - Class in org.apache.lucene.misc.util.fst
  An FST `Outputs` implementation where each output is one or two non-negative long values.
UpToTwoPositiveIntOutputs.TwoLongs - Record Class in org.apache.lucene.misc.util.fst
  Holds two long outputs.
useDirectIO(String, IOContext, OptionalLong) - Method in class org.apache.lucene.misc.store.DirectIODirectory
  Determines if direct IO should be used for a file.

## V

valuesCount - Variable in class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
valuesCount() - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
  Returns the total number of values for this field.
variance - Variable in class org.apache.lucene.misc.search.DocValuesStats.NumericDocValuesStats
variance - Variable in class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
variance() - Method in class org.apache.lucene.misc.search.DocValuesStats.NumericDocValuesStats
  Returns the variance of all values of the field.
variance() - Method in class org.apache.lucene.misc.search.DocValuesStats.SortedNumericDocValuesStats
  Returns the variance of all values of the field.
visit(QueryVisitor) - Method in class org.apache.lucene.misc.search.HumanReadableQuery

## W

write(Object, DataOutput) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs
write(Object, DataOutput) - Method in class org.apache.lucene.misc.util.fst.UpToTwoPositiveIntOutputs
writeFinalOutput(Object, DataOutput) - Method in class org.apache.lucene.misc.util.fst.ListOfOutputs

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form