// Licensed to the Apache Software Foundation (ASF) under one

// or more contributor license agreements.  See the NOTICE file

// distributed with this work for additional information

// regarding copyright ownership.  The ASF licenses this file

// to you 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 <memory>

#include "storage/index/index_query_context.h"

namespace doris::segment_v2 {

#include "common/compile_check_begin.h"

class Similarity {

public:

    Similarity() = default;

    virtual ~Similarity() = default;

    virtual void for_one_term(const IndexQueryContextPtr& context, const std::wstring& field_name,

                              const std::wstring& term) = 0;

    virtual void for_terms(const IndexQueryContextPtr& context, const std::wstring& field_name,

                           const std::vector<std::wstring>& terms) = 0;

    virtual float score(float freq, int64_t encoded_norm) = 0;

};

using SimilarityPtr = std::shared_ptr<Similarity>;

#include "common/compile_check_end.h"

} // namespace doris::segment_v2