Package com.yahoo.prelude.query
Record Class DocumentFrequency
java.lang.Object
java.lang.Record
com.yahoo.prelude.query.DocumentFrequency
- Record Components:
frequency
- The number of documents in which an item occurscount
- The total number of documents in the corpus
The expected number of documents matching an item given a corpus of
multiple documents. This is the raw data used to calculate variants
of idf, used as significance.
-
Constructor Summary
ConstructorDescriptionDocumentFrequency
(long frequency, long count) Creates an instance of aDocumentFrequency
record class. -
Method Summary
Modifier and TypeMethodDescriptionlong
count()
Returns the value of thecount
record component.final boolean
Indicates whether some other object is "equal to" this one.long
Returns the value of thefrequency
record component.final int
hashCode()
Returns a hash code value for this object.final String
toString()
Returns a string representation of this record class.
-
Constructor Details
-
Method Details
-
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='. -
frequency
public long frequency()Returns the value of thefrequency
record component.- Returns:
- the value of the
frequency
record component
-
count
public long count()Returns the value of thecount
record component.- Returns:
- the value of the
count
record component
-