hgraph_parameter.h

// Copyright 2024-present the vsag project
//
// 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 <limits>

#include "../index_search_parameter.h"
#include "../inner_index_parameter.h"
#include "data_type.h"
#include "utils/pointer_define.h"
#include "vsag/constants.h"

namespace vsag {
DEFINE_POINTER2(ExtraInfoDataCellParam, ExtraInfoDataCellParameter);
DEFINE_POINTER2(FlattenInterfaceParam, FlattenInterfaceParameter);
DEFINE_POINTER2(GraphInterfaceParam, GraphInterfaceParameter);
DEFINE_POINTER2(SparseGraphDatacellParam, SparseGraphDatacellParameter);
DEFINE_POINTER(ODescentParameter);

DEFINE_POINTER(HGraphParameter);
class HGraphParameter : public InnerIndexParameter {
public:
    explicit HGraphParameter(const JsonType& json);

    HGraphParameter();

    void
    FromJson(const JsonType& json) override;

    JsonType
    ToJson() const override;

    bool
    CheckCompatibility(const ParamPtr& other) const override;

public:
    FlattenInterfaceParamPtr base_codes_param{nullptr};
    GraphInterfaceParamPtr bottom_graph_param{nullptr};
    SparseGraphDatacellParamPtr hierarchical_graph_param{nullptr};

    ODescentParameterPtr odescent_param{nullptr};

    std::string graph_type{GRAPH_TYPE_VALUE_NSW};

    bool use_elp_optimizer{false};
    bool ignore_reorder{false};
    bool build_by_base{false};

    uint64_t ef_construction{400};
    float alpha{1.0F};

    bool support_duplicate{false};
    float duplicate_distance_threshold{0.0F};
    bool support_tombstone{false};
    bool support_force_remove{false};

    DataTypes data_type{DataTypes::DATA_TYPE_FLOAT};

    std::string name;
};

class HGraphSearchParameters : public IndexSearchParameter {
public:
    static HGraphSearchParameters
    FromJson(const std::string& json_string);

public:
    int64_t ef_search{30};
    uint32_t hops_limit{std::numeric_limits<uint32_t>::max()};
    bool use_reorder{false};
    bool use_extra_info_filter{false};
    bool rabitq_one_bit_search{false};
    // If > 0 and the active filter's ValidRatio() <= brute_force_threshold,
    // the search bypasses the graph traversal and runs an exact scan over the
    // valid inner ids using the best available flatten codes. Default 0
    // preserves existing behaviour.
    float brute_force_threshold{0.0F};

private:
    HGraphSearchParameters() = default;
};

}  // namespace vsag