| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="The `ScoreCombiner` trait defines how to compute an overall score given a list of scores."><meta name="keywords" content="rust, rustlang, rust-lang, ScoreCombiner"><title>ScoreCombiner in tantivy::query - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../tantivy/index.html"><div class="logo-container"><img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../tantivy/index.html"><div class="logo-container"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a><h2 class="location"><a href="#">ScoreCombiner</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.clear">clear</a></li><li><a href="#tymethod.score">score</a></li><li><a href="#tymethod.update">update</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tantivy::query</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="../index.html">tantivy</a>::<wbr><a href="index.html">query</a>::<wbr><a class="trait" href="#">ScoreCombiner</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tantivy/query/score_combiner.rs.html#6-18">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait ScoreCombiner: Default + Clone + Send + Copy + 'static { |
| fn <a href="#tymethod.update" class="fnname">update</a><TScorer: <a class="trait" href="trait.Scorer.html" title="trait tantivy::query::Scorer">Scorer</a>>(&mut self, scorer: &mut TScorer); |
| <span class="item-spacer"></span> fn <a href="#tymethod.clear" class="fnname">clear</a>(&mut self); |
| <span class="item-spacer"></span> fn <a href="#tymethod.score" class="fnname">score</a>(&self) -> <a class="type" href="../type.Score.html" title="type tantivy::Score">Score</a>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The <code>ScoreCombiner</code> trait defines how to compute |
| an overall score given a list of scores.</p> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.update" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/score_combiner.rs.html#11">source</a><h4 class="code-header">fn <a href="#tymethod.update" class="fnname">update</a><TScorer: <a class="trait" href="trait.Scorer.html" title="trait tantivy::query::Scorer">Scorer</a>>(&mut self, scorer: &mut TScorer)</h4></section></summary><div class="docblock"><p>Aggregates the score combiner with the given scorer.</p> |
| <p>The <code>ScoreCombiner</code> may decide to call <code>.scorer.score()</code> |
| or not.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.clear" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/score_combiner.rs.html#14">source</a><h4 class="code-header">fn <a href="#tymethod.clear" class="fnname">clear</a>(&mut self)</h4></section></summary><div class="docblock"><p>Clears the score combiner state back to its initial state.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.score" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/score_combiner.rs.html#17">source</a><h4 class="code-header">fn <a href="#tymethod.score" class="fnname">score</a>(&self) -> <a class="type" href="../type.Score.html" title="type tantivy::Score">Score</a></h4></section></summary><div class="docblock"><p>Returns the aggregate score.</p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-ScoreCombiner-for-DisjunctionMaxCombiner" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/score_combiner.rs.html#101-116">source</a><a href="#impl-ScoreCombiner-for-DisjunctionMaxCombiner" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ScoreCombiner.html" title="trait tantivy::query::ScoreCombiner">ScoreCombiner</a> for <a class="struct" href="struct.DisjunctionMaxCombiner.html" title="struct tantivy::query::DisjunctionMaxCombiner">DisjunctionMaxCombiner</a></h3></section><section id="impl-ScoreCombiner-for-SumCombiner" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/score_combiner.rs.html#43-55">source</a><a href="#impl-ScoreCombiner-for-SumCombiner" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ScoreCombiner.html" title="trait tantivy::query::ScoreCombiner">ScoreCombiner</a> for <a class="struct" href="struct.SumCombiner.html" title="struct tantivy::query::SumCombiner">SumCombiner</a></h3></section><section id="impl-ScoreCombiner-for-SumWithCoordsCombiner" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/query/score_combiner.rs.html#65-79">source</a><a href="#impl-ScoreCombiner-for-SumWithCoordsCombiner" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ScoreCombiner.html" title="trait tantivy::query::ScoreCombiner">ScoreCombiner</a> for <a class="struct" href="struct.SumWithCoordsCombiner.html" title="struct tantivy::query::SumWithCoordsCombiner">SumWithCoordsCombiner</a></h3></section></div><script src="../../implementors/tantivy/query/score_combiner/trait.ScoreCombiner.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
