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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
// 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.



#ifndef SCANN_DATA_FORMAT_DATAPOINT_H_
#define SCANN_DATA_FORMAT_DATAPOINT_H_

#include <cstdint>
#include <utility>

#include "absl/base/attributes.h"
#include "absl/log/check.h"
#include "absl/log/log.h"
#include "scann/data_format/features.pb.h"
#include "scann/data_format/gfv_conversion.h"
#include "scann/proto/hashed.pb.h"
#include "scann/utils/common.h"
#include "scann/utils/infinite_one_array.h"
#include "scann/utils/types.h"

namespace research_scann {

template <typename T>
class DatapointPtr;
template <typename T>
class Datapoint;

template <>
class DatapointPtr<NoValue> final {
 public:
  DatapointPtr() {}

  DatapointPtr(const DimensionIndex* indices, const NoValue* values,
               DimensionIndex nonzero_entries, DimensionIndex dimensionality)
      : indices_(indices),
        nonzero_entries_(nonzero_entries),
        dimensionality_(dimensionality) {
    CHECK(!values) << "values must be nullptr";
  }

  const DimensionIndex* indices() const { return indices_; }
  ConstSpan<DimensionIndex> indices_span() const {
    return ConstSpan<DimensionIndex>(indices_, indices_ ? nonzero_entries_ : 0);
  }
  bool has_values() const { return false; }
  InfiniteOneArray<NoValue> values() const {
    return InfiniteOneArray<NoValue>();
  }
  InfiniteOneArray<NoValue> values_span() const {
    return InfiniteOneArray<NoValue>();
  }
  bool IsDense() const { return false; }
  bool IsSparse() const { return true; }
  bool IsAllOnes() const { return true; }
  bool IsFinite() const { return true; }
  DimensionIndex nonzero_entries() const { return nonzero_entries_; }
  DatapointPtr<NoValue> ToSparseBinary() const { return *this; }

 private:
  const DimensionIndex* indices_ = nullptr;
  DimensionIndex nonzero_entries_ = 0;
  DimensionIndex dimensionality_ = 0;
};

template <typename T>
class DatapointPtr final {
 public:
  DatapointPtr() = default;

  DatapointPtr(const DimensionIndex* indices, const T* values,
               DimensionIndex nonzero_entries, DimensionIndex dimensionality)
      : indices_(indices),
        values_(values),
        nonzero_entries_(nonzero_entries),
        dimensionality_(dimensionality) {}

  const DimensionIndex* indices() const { return indices_; }

  ConstSpan<DimensionIndex> indices_span() const {
    return ConstSpan<DimensionIndex>(indices_, indices_ ? nonzero_entries_ : 0);
  }

  const T* values() const { return values_; }

  bool has_values() const { return values_; }

  ConstSpan<T> values_span() const {
    return ConstSpan<T>(values_, values_ ? nonzero_entries_ : 0);
  }

  DimensionIndex nonzero_entries() const { return nonzero_entries_; }

  DimensionIndex dimensionality() const { return dimensionality_; }

  bool IsDense() const { return nonzero_entries_ > 0 && indices_ == nullptr; }

  bool IsSparse() const { return !IsDense(); }

  bool IsSparseOrigin() const { return nonzero_entries_ == 0; }

  bool IsAllOnes() const {
    return std::all_of(values_span().begin(), values_span().end(),
                       [](T val) { return val == 1; });
  }

  bool IsFinite() const {
    if constexpr (IsFloatingType<T>()) {
      for (T val : values_span()) {
        if (!std::isfinite(val)) return false;
      }
    }
    return true;
  }

  bool HasNonzero(DimensionIndex dimension_index) const;

  T GetElement(DimensionIndex dimension_index) const;

  T GetElementPacked(DimensionIndex dimension_index) const;

  GenericFeatureVector ToGfv() const {
    GenericFeatureVector result;
    ToGfv(result);
    return result;
  }

  void ToGfv(GenericFeatureVector& result) const;

  DatapointPtr<NoValue> ToSparseBinary() const {
    return DatapointPtr<NoValue>(indices_, nullptr, nonzero_entries_,
                                 dimensionality_);
  }

  ABSL_DEPRECATED("Prefer indices_span() over indices_slice()")
  ConstSpan<DimensionIndex> indices_slice() const { return indices_span(); }
  ABSL_DEPRECATED("Prefer values_span() over values_slice()")
  ConstSpan<T> values_slice() const { return values_span(); }

 private:
  void ToGfvIndicesAndMetadata(GenericFeatureVector* gfv) const;

  const DimensionIndex* indices_ = nullptr;

  const T* values_ = nullptr;

  DimensionIndex nonzero_entries_ = 0;

  DimensionIndex dimensionality_ = 0;
};

constexpr DimensionIndex kSparseDimensionality =
    numeric_limits<DimensionIndex>::max();

template <typename T>
inline DatapointPtr<T> MakeDatapointPtr(const DimensionIndex* indices,
                                        const T* values,
                                        DimensionIndex nonzero_entries,
                                        DimensionIndex dimensionality) {
  return DatapointPtr<T>(indices, values, nonzero_entries, dimensionality);
}

template <typename T>
inline DatapointPtr<T> MakeDatapointPtr(ConstSpan<T> values) {
  return MakeDatapointPtr(nullptr, values.data(), values.size(), values.size());
}
template <typename T>
inline DatapointPtr<T> MakeDatapointPtr(const T* ptr, DimensionIndex size) {
  return MakeDatapointPtr(nullptr, ptr, size, size);
}

template <int&... ExplicitArgumentBarrier, typename CollectionT,
          typename EnableIfConvertibleToConstSpan_SFINAE =
              decltype(std::declval<const CollectionT&>().data())>
inline auto MakeDatapointPtr(const CollectionT& c)
    -> decltype(MakeDatapointPtr(MakeConstSpan(c))) {
  return MakeDatapointPtr(MakeConstSpan(c));
}

inline DatapointPtr<uint8_t> MakeDenseBinaryDatapointPtr(
    ConstSpan<uint8_t> values, DimensionIndex dimensionality) {
  return MakeDatapointPtr(nullptr, values.data(), values.size(),
                          dimensionality);
}

inline DatapointPtr<uint8_t> MakeSparseBinaryDatapointPtr(
    ConstSpan<DimensionIndex> indices,
    DimensionIndex dimensionality = kSparseDimensionality) {
  return MakeDatapointPtr<uint8_t>(indices.data(), nullptr, indices.size(),
                                   dimensionality);
}

template <typename T>
inline DatapointPtr<T> MakeDatapointPtr(
    ConstSpan<DimensionIndex> indices, ConstSpan<T> values,
    DimensionIndex dimensionality = kSparseDimensionality) {
  constexpr DimensionIndex* kIndicesNullptr = nullptr;
  constexpr T* kValuesNullptr = nullptr;
  const bool has_indices = !indices.empty();
  const bool has_values = !values.empty();
  if (has_indices && has_values) {
    CHECK_EQ(values.size(), indices.size());
    return MakeDatapointPtr(indices.data(), values.data(), indices.size(),
                            dimensionality);
  }
  if (has_indices && !has_values) {
    return MakeDatapointPtr(indices.data(), kValuesNullptr, indices.size(),
                            dimensionality);
  }
  if (!has_indices && has_values) {
    if (dimensionality != kSparseDimensionality) {
      CHECK_EQ(values.size(), dimensionality);
    }
    return MakeDatapointPtr(values);
  }
  DCHECK(!has_indices && !has_values);

  return MakeDatapointPtr<T>(kIndicesNullptr, kValuesNullptr, 0,
                             dimensionality);
}

template <int&... ExplicitArgumentBarrier, typename CollectionT>
inline auto MakeDatapointPtr(ConstSpan<DimensionIndex> indices,
                             const CollectionT& values)
    -> decltype(MakeDatapointPtr(indices, MakeConstSpan(values))) {
  return MakeDatapointPtr(indices, MakeConstSpan(values));
}

inline DatapointPtr<uint8_t> MakeDatapointPtr(const HashedItem& item) {
  return MakeDatapointPtr(
      nullptr, reinterpret_cast<const uint8_t*>(item.indicator_vars().data()),
      item.indicator_vars().size(), item.indicator_vars().size());
}

template <typename T>
class Datapoint final {
 public:
  Datapoint() : dimensionality_(0), normalization_(NONE) {}

  Datapoint(ConstSpan<DimensionIndex> indices, ConstSpan<T> values,
            DimensionIndex dimensionality)
      : indices_(indices.begin(), indices.end()),
        values_(values.begin(), values.end()),
        dimensionality_(dimensionality),
        normalization_(NONE) {}

  Datapoint(std::vector<DimensionIndex> indices, std::vector<T> values,
            DimensionIndex dimensionality)
      : indices_(std::move(indices)),
        values_(std::move(values)),
        dimensionality_(dimensionality),
        normalization_(NONE) {}

  Status FromGfv(const GenericFeatureVector& gfv);

  std::vector<DimensionIndex>* mutable_indices() { return &indices_; }
  MutableSpan<DimensionIndex> mutable_indices_span() {
    return MutableSpan<DimensionIndex>(indices_);
  }

  const std::vector<DimensionIndex>& indices() const { return indices_; }
  ConstSpan<DimensionIndex> indices_span() const { return indices_; }

  std::vector<T>* mutable_values() { return &values_; }
  MutableSpan<T> mutable_values_span() { return MutableSpan<T>(values_); }

  const std::vector<T>& values() const { return values_; }
  ConstSpan<T> values_span() const { return values_; }

  DimensionIndex nonzero_entries() const {
    return (IsDense()) ? values_.size() : indices_.size();
  }

  DimensionIndex dimensionality() const {
    return (dimensionality_ == 0) ? nonzero_entries() : dimensionality_;
  }

  void set_dimensionality(DimensionIndex new_value) {
    dimensionality_ = new_value;
  }

  bool IsDense() const { return indices_.empty() && !values_.empty(); }

  bool IsSparse() const { return !IsDense(); }

  bool IsSparseBinary() const { return values_.empty(); }

  void MakeNotBinary();

  DatapointPtr<T> ToPtr() const {
    const DimensionIndex* indices_data =
        indices_.empty() ? nullptr : indices_.data();
    const T* values_data = values_.empty() ? nullptr : values_.data();
    return MakeDatapointPtr(indices_data, values_data, nonzero_entries(),
                            dimensionality());
  }

  GenericFeatureVector ToGfv() const {
    GenericFeatureVector result;
    ToGfv(result);
    return result;
  }

  void ToGfv(GenericFeatureVector& result) const;

  void clear() {
    indices_.clear();
    values_.clear();
    dimensionality_ = 0;
    normalization_ = NONE;
  }

  void ZeroFill(size_t dimensionality) {
    clear();
    values_.resize(dimensionality);
  }

  Normalization normalization() const { return normalization_; }

  void set_normalization(Normalization val) { normalization_ = val; }

  void Swap(Datapoint<T>* rhs) { std::swap(*this, *rhs); }

  bool IndicesSorted() const;

  void SortIndices();

  void RemoveExplicitZeroesFromSparseVector();

  ABSL_DEPRECATED("Prefer mutable_indices_span() over mutable_indices_slice()")
  MutableSpan<DimensionIndex> mutable_indices_slice() {
    return mutable_indices_span();
  }
  ABSL_DEPRECATED("Prefer indices_span() over indices_slice()")
  ConstSpan<DimensionIndex> indices_slice() const { return indices_span(); }
  ABSL_DEPRECATED("Prefer mutable_values_span() over mutable_values_slice()")
  MutableSpan<T> mutable_values_slice() { return mutable_values_span(); }
  ABSL_DEPRECATED("Prefer values_span() over values_slice()")
  ConstSpan<T> values_slice() const { return values_span(); }

 private:
  Status FromGfvImpl(const GenericFeatureVector& gfv);

  std::vector<DimensionIndex> indices_;

  std::vector<T> values_;

  DimensionIndex dimensionality_;

  Normalization normalization_;
};

template <typename T>
Datapoint<T> MakeDenseDatapoint(ConstSpan<T> values) {
  ConstSpan<DimensionIndex> indices(nullptr, 0);
  return Datapoint<T>(indices, values, values.size());
}

template <typename T>
Datapoint<T> MakeSparseDatapoint(ConstSpan<DimensionIndex> indices,
                                 ConstSpan<T> values,
                                 DimensionIndex dimensionality) {
  CHECK_EQ(indices.size(), values.size());
  return Datapoint<T>(indices, values, dimensionality);
}

template <typename T>
T DatapointPtr<T>::GetElementPacked(DimensionIndex dimension_index) const {
  DCHECK_GT(dimensionality(), nonzero_entries());
  const auto array_offset = dimension_index / 8;
  const auto bit_offset = dimension_index % 8;
  return (values()[array_offset] >> bit_offset) & 1;
}

template <>
inline float DatapointPtr<float>::GetElementPacked(
    DimensionIndex dimension_index) const {
  LOG(FATAL) << "Can't happen.";
}

template <>
inline double DatapointPtr<double>::GetElementPacked(
    DimensionIndex dimension_index) const {
  LOG(FATAL) << "Can't happen.";
}

template <typename T>
void DatapointPtr<T>::ToGfv(GenericFeatureVector& result) const {
  result.Clear();
  ToGfvIndicesAndMetadata(&result);

  if (dimensionality() == nonzero_entries() || IsSparse()) {
    if (values() == nullptr) {
      result.set_feature_type(GenericFeatureVector::BINARY);
    } else {
      result.set_feature_type(GenericFeatureVector::INT64);
      for (size_t i = 0; i < nonzero_entries(); ++i) {
        result.add_feature_value_int64(values()[i]);
      }
    }
  } else {
    DCHECK_GT(dimensionality(), nonzero_entries());
    DCHECK(IsUint8<T>());
    result.set_feature_type(GenericFeatureVector::BINARY);
    UnpackBinaryToInt64<T>(ConstSpan<T>(values(), nonzero_entries()),
                           dimensionality(), &result);
  }
}

template <>
inline void DatapointPtr<float>::ToGfv(GenericFeatureVector& result) const {
  result.Clear();
  result.set_feature_type(GenericFeatureVector::FLOAT);
  ToGfvIndicesAndMetadata(&result);
  for (size_t i = 0; i < nonzero_entries(); ++i) {
    result.add_feature_value_float(values()[i]);
  }
}

template <>
inline void DatapointPtr<double>::ToGfv(GenericFeatureVector& result) const {
  result.Clear();
  result.set_feature_type(GenericFeatureVector::DOUBLE);
  ToGfvIndicesAndMetadata(&result);
  for (size_t i = 0; i < nonzero_entries(); ++i) {
    result.add_feature_value_double(values()[i]);
  }
}

SCANN_INSTANTIATE_TYPED_CLASS(extern, DatapointPtr);
SCANN_INSTANTIATE_TYPED_CLASS(extern, Datapoint);

}  // namespace research_scann

#endif