search_scoring.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *   Copyright 2020-Present Couchbase, Inc.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
 
#pragma once
 
#include <cstdint>
#include <optional>
#include <variant>
 
namespace couchbase
{
class search_scoring
{
public:
  struct built {
    struct none {
    };

    struct reciprocal_rank_fusion {
      std::optional<std::uint32_t> rank_constant{};
      std::optional<std::uint32_t> window_size{};
    };

    struct relative_score_fusion {
      std::optional<std::uint32_t> window_size{};
    };
 
    std::variant<none, reciprocal_rank_fusion, relative_score_fusion> mode{ none{} };
  };
 
  virtual ~search_scoring() = default;

  [[nodiscard]] virtual auto build() const -> built = 0;
 
protected:
  search_scoring() = default;
};
} // namespace couchbase