scann-core 0.2.1

Rust bindings for scann-core: ScaNN's approximate nearest-neighbour vector search core as a standalone library (derived from Google's ScaNN; not an official Google product)
Documentation
// Copyright 2026 The Google Research Authors.
//
// 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.
//
// Modified in 2026 by Elias Benali (@ebenali) and TheCleaners for
// scann-core (a derived work of ScaNN, not an official Google product);
// see NOTICE.

#ifndef SCANN_UTILS_SINGLE_MACHINE_RETRAINING_H_
#define SCANN_UTILS_SINGLE_MACHINE_RETRAINING_H_

#include "absl/synchronization/mutex.h"
#include "scann/base/single_machine_base.h"
#include "scann/base/single_machine_factory_options.h"
#include "scann/oss_wrappers/scann_threadpool.h"
#include "scann/utils/common.h"

namespace research_scann {

StatusOrSearcherUntyped RetrainAndReindexSearcher(
    UntypedSingleMachineSearcherBase* searcher,
    absl::Mutex* searcher_pointer_mutex, const ScannConfig& config,
    shared_ptr<ThreadPool> parallelization_pool = nullptr);

// scann-core: spherical partitioning (PartitioningConfig::SPHERICAL) trains
// on, and tags its dataset as, unit-L2-norm vectors. These keep an index's
// vectors actually unit-norm wherever they enter it (build, upsert,
// retraining), so vectors added at different times are stored alike.
bool IsSphericalPartitioning(const ScannConfig& config);
// Scales `v` to unit L2 norm, as NormalizeUnitL2 (utils/datapoint_utils.h)
// does, unless it is zero, non-finite or already unit-norm to within float
// rounding (then it is left bit-for-bit alone).
void NormalizeForSphericalPartitioning(MutableSpan<float> v);

}

#endif