Couchbase C++ SDK
1.5.0 (rev. 380784c)
Toggle main menu visibility
Loading...
Searching...
No Matches
search_scoring_reciprocal_rank_fusion.hxx
Go to the documentation of this file.
1
/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2
/*
3
* Copyright 2020-Present Couchbase, Inc.
4
*
5
* Licensed under the Apache License, Version 2.0 (the "License");
6
* you may not use this file except in compliance with the License.
7
* You may obtain a copy of the License at
8
*
9
* http://www.apache.org/licenses/LICENSE-2.0
10
*
11
* Unless required by applicable law or agreed to in writing, software
12
* distributed under the License is distributed on an "AS IS" BASIS,
13
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
* See the License for the specific language governing permissions and
15
* limitations under the License.
16
*/
17
18
#pragma once
19
20
#include <
couchbase/search_scoring.hxx
>
21
22
namespace
couchbase
23
{
36
class
search_scoring_reciprocal_rank_fusion
:
public
search_scoring
37
{
38
public
:
39
search_scoring_reciprocal_rank_fusion
() =
default
;
40
50
auto
rank_constant
(std::uint32_t
rank_constant
) ->
search_scoring_reciprocal_rank_fusion
&
51
{
52
rank_constant_ =
rank_constant
;
53
return
*
this
;
54
}
55
65
auto
window_size
(std::uint32_t
window_size
) ->
search_scoring_reciprocal_rank_fusion
&
66
{
67
window_size_ =
window_size
;
68
return
*
this
;
69
}
70
79
[[nodiscard]]
auto
build
() const ->
search_scoring
::
built
override
80
{
81
return
{
search_scoring::built::reciprocal_rank_fusion
{ rank_constant_, window_size_ } };
82
}
83
84
private
:
85
std::optional<std::uint32_t> rank_constant_{};
86
std::optional<std::uint32_t> window_size_{};
87
};
88
}
// namespace couchbase
couchbase::search_scoring_reciprocal_rank_fusion::search_scoring_reciprocal_rank_fusion
search_scoring_reciprocal_rank_fusion()=default
couchbase::search_scoring_reciprocal_rank_fusion::build
auto build() const -> search_scoring::built override
Returns the scoring mode as an immutable value.
Definition
search_scoring_reciprocal_rank_fusion.hxx:79
couchbase::search_scoring_reciprocal_rank_fusion::rank_constant
auto rank_constant(std::uint32_t rank_constant) -> search_scoring_reciprocal_rank_fusion &
The rank constant of the Reciprocal Rank Fusion formula.
Definition
search_scoring_reciprocal_rank_fusion.hxx:50
couchbase::search_scoring_reciprocal_rank_fusion::window_size
auto window_size(std::uint32_t window_size) -> search_scoring_reciprocal_rank_fusion &
How many results per list are considered for fusion.
Definition
search_scoring_reciprocal_rank_fusion.hxx:65
couchbase::search_scoring::search_scoring
search_scoring()=default
couchbase
Represents a single item from the result of scan().
Definition
allow_querying_search_index_options.hxx:28
search_scoring.hxx
couchbase::search_scoring::built::reciprocal_rank_fusion
Reciprocal Rank Fusion: merges the result sets by rank.
Definition
search_scoring.hxx:64
couchbase::search_scoring::built
Immutable value object representing a scoring mode.
Definition
search_scoring.hxx:54
couchbase
search_scoring_reciprocal_rank_fusion.hxx
Generated by
1.17.0