JASSv2
Public Member Functions | List of all members
JASS::ranking_function_none Class Reference

Ranking function that returns the TF score - used for term frequency scaling into the quantized range. More...

#include <ranking_function_none.h>

Public Member Functions

 ranking_function_none ()
 Constructor.
 
 ~ranking_function_none ()
 Destructor.
 
forceinline void compute_idf_component (compress_integer::integer document_frequency, compress_integer::integer documents_in_collection)
 Called once per term (per query). Computes the IDF component of the ranking function and stores it internally. More...
 
forceinline void compute_tf_component (index_postings_impact::impact_type term_frequency)
 Compute and store internally the term-frequency based component of the ranking function (useful when postings lists are impact ordered) More...
 
forceinline double compute_score (compress_integer::integer document_id, index_postings_impact::impact_type term_frequency)
 Return the term frequency. More...
 

Detailed Description

Ranking function that returns the TF score - used for term frequency scaling into the quantized range.

Member Function Documentation

◆ compute_idf_component()

forceinline void JASS::ranking_function_none::compute_idf_component ( compress_integer::integer  document_frequency,
compress_integer::integer  documents_in_collection 
)
inline

Called once per term (per query). Computes the IDF component of the ranking function and stores it internally.

Parameters
document_frequency[in] the number of documents that contain this term.
documents_in_collection[in] the number of documents in the collection.

◆ compute_score()

forceinline double JASS::ranking_function_none::compute_score ( compress_integer::integer  document_id,
index_postings_impact::impact_type  term_frequency 
)
inline

Return the term frequency.

Parameters
document_id[in] The ID of the document
term_frequency[in] The number of times the term occurs in the document.
Returns
The term frequency score

◆ compute_tf_component()

forceinline void JASS::ranking_function_none::compute_tf_component ( index_postings_impact::impact_type  term_frequency)
inline

Compute and store internally the term-frequency based component of the ranking function (useful when postings lists are impact ordered)

Parameters
term_frequency[in] The number of times the term occurs in the document.

The documentation for this class was generated from the following file: