#ifndef SCANN_PARTITIONING_KMEANS_TREE_LIKE_PARTITIONER_H_
#define SCANN_PARTITIONING_KMEANS_TREE_LIKE_PARTITIONER_H_
#include <cstdint>
#include <limits>
#include <vector>
#include "absl/status/status.h"
#include "scann/data_format/datapoint.h"
#include "scann/distance_measures/distance_measure_base.h"
#include "scann/oss_wrappers/scann_threadpool.h"
#include "scann/partitioning/partitioner_base.h"
#include "scann/trees/kmeans_tree/kmeans_tree.h"
#include "scann/utils/types.h"
namespace research_scann {
template <typename T>
class KMeansTreeLikePartitioner : public Partitioner<T> {
public:
virtual const shared_ptr<const DistanceMeasure>& query_tokenization_distance()
const = 0;
virtual const shared_ptr<const KMeansTree>& kmeans_tree() const = 0;
using Partitioner<T>::TokensForDatapointWithSpilling;
using Partitioner<T>::TokensForDatapointWithSpillingBatched;
using Partitioner<T>::TokenForDatapoint;
using Partitioner<T>::TokenForDatapointBatched;
virtual Status TokensForDatapointWithSpilling(
const DatapointPtr<T>& dptr, ConstSpan<int32_t> max_centers_override,
vector<pair<DatapointIndex, float>>* result) const = 0;
virtual Status TokensForDatapointWithSpillingBatched(
const TypedDatasetView<T>& queries,
ConstSpan<std::vector<int32_t>> max_centers_override,
MutableSpan<std::vector<pair<DatapointIndex, float>>> results,
ThreadPool* pool = nullptr) const = 0;
virtual Status TokenForDatapoint(
const DatapointPtr<T>& dptr,
pair<DatapointIndex, float>* result) const = 0;
virtual Status TokenForDatapointBatched(
const TypedDatasetView<T>& queries,
std::vector<pair<DatapointIndex, float>>* result,
ThreadPool* pool) const = 0;
Status TokenForDatapointBatched(
const TypedDatasetView<T>& queries,
std::vector<pair<DatapointIndex, float>>* result) const {
return TokenForDatapointBatched(queries, result, nullptr);
}
virtual StatusOr<Datapoint<float>> ResidualizeToFloat(
const DatapointPtr<T>& dptr, int32_t token) const = 0;
StatusOr<Datapoint<float>> ResidualizeToFloat(const DatapointPtr<T>& dptr,
int32_t token, bool) const {
return ResidualizeToFloat(dptr, token);
}
virtual const DenseDataset<float>& LeafCenters() const = 0;
virtual uint32_t query_spilling_max_centers() const = 0;
virtual double query_spilling_threshold() const {
return std::numeric_limits<double>::infinity();
}
virtual QuerySpillingConfig::SpillingType query_spilling_type() const {
return QuerySpillingConfig::NO_SPILLING;
}
virtual int bottom_up_depth() const { return 1; }
ABSL_DEPRECATED("Use ConstSpan overload instead.")
Status TokensForDatapointWithSpilling(
const DatapointPtr<T>& dptr, int32_t max_centers_override,
vector<pair<DatapointIndex, float>>* result) const {
return TokensForDatapointWithSpilling(
dptr, ConstSpan<int32_t>{max_centers_override}, result);
}
ABSL_DEPRECATED("Use ConstSpan overload instead.")
Status TokensForDatapointWithSpillingBatched(
const TypedDatasetView<T>& queries,
ConstSpan<int32_t> max_centers_override,
MutableSpan<std::vector<pair<DatapointIndex, float>>> results,
ThreadPool* pool = nullptr) const {
vector<std::vector<int32_t>> max_centers_override_vec(
max_centers_override.size());
for (size_t i : IndicesOf(max_centers_override)) {
max_centers_override_vec[i] = {max_centers_override[i]};
}
return TokensForDatapointWithSpillingBatched(
queries, max_centers_override_vec, results, pool);
}
};
}
#endif