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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
// 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_DATA_FORMAT_DATASET_H_
#define SCANN_DATA_FORMAT_DATASET_H_

#include <atomic>
#include <memory>
#include <type_traits>
#include <utility>
#include <vector>

#include "absl/base/prefetch.h"
#include "absl/memory/memory.h"
#include "absl/strings/str_cat.h"
#include "scann/data_format/datapoint.h"
#include "scann/data_format/docid_collection.h"
#include "scann/data_format/docid_collection_interface.h"
#include "scann/data_format/features.pb.h"
#include "scann/data_format/sparse_low_level.h"
#include "scann/distance_measures/distance_measure_base.h"
#include "scann/proto/hashed.pb.h"
#include "scann/utils/atomic.h"
#include "scann/utils/common.h"
#include "scann/utils/iterators.h"
#include "scann/utils/types.h"
#include "scann/utils/util_functions.h"

namespace research_scann {

template <typename T>
class TypedDatasetView;
template <typename T>
class DenseDatasetView;

class DatasetView : public VirtualDestructor {
 public:
  virtual size_t size() const = 0;
  virtual bool empty() const = 0;
  virtual DimensionIndex dimensionality() const = 0;
  virtual DimensionIndex NumActiveDimensions() const = 0;
  virtual bool IsDense() const = 0;
  virtual bool IsSparse() const = 0;
  virtual string_view GetDocid(size_t index) const = 0;
  virtual research_scann::TypeTag TypeTag() const = 0;
  virtual void GetDatapoint(size_t index, Datapoint<double>* result) const = 0;
  virtual void GetDatapoint(size_t index, Datapoint<float>* result) const = 0;
  virtual void GetDenseDatapoint(size_t index,
                                 Datapoint<double>* result) const = 0;
  virtual void GetDenseDatapoint(size_t index,
                                 Datapoint<float>* result) const = 0;
  virtual void Prefetch(size_t index) const = 0;
  virtual double GetDistance(const DistanceMeasure& dist, size_t vec1_index,
                             size_t vec2_index) const = 0;
  virtual Status MeanByDimension(Datapoint<double>* result) const = 0;
  virtual Status MeanByDimension(ConstSpan<DatapointIndex> subset,
                                 Datapoint<double>* result) const = 0;
  virtual void MeanVarianceByDimension(Datapoint<double>* means,
                                       Datapoint<double>* variances) const = 0;
  virtual void MeanVarianceByDimension(ConstSpan<DatapointIndex> subset,
                                       Datapoint<double>* means,
                                       Datapoint<double>* variances) const = 0;
  virtual Normalization normalization() const = 0;
  virtual HashedItem::PackingStrategy packing_strategy() const = 0;
  virtual bool is_float() const = 0;
  virtual bool is_binary() const = 0;
};

template <typename T>
class TypedDatasetView : public virtual DatasetView {
 public:
  using const_iterator = RandomAccessIterator<const TypedDatasetView<T>>;
  const_iterator begin() const { return const_iterator(this, 0); }
  const_iterator end() const { return const_iterator(this, this->size()); }

  virtual DatapointPtr<T> operator[](size_t datapoint_index) const = 0;
  DatapointPtr<T> at(size_t datapoint_index) const {
    CHECK_LT(datapoint_index, this->size());
    return operator[](datapoint_index);
  }
};

template <typename T>
class TypedDataset;
template <typename T>
class DenseDataset;
template <typename T>
class SparseDataset;

class Dataset : public virtual DatasetView {
 public:
  SCANN_DECLARE_MOVE_ONLY_CLASS(Dataset);

  Dataset()
      : docids_(make_shared<VariableLengthDocidCollection>()),
        dimensionality_(0) {}

  explicit Dataset(unique_ptr<DocidCollectionInterface> docids)
      : docids_(std::move(docids)), dimensionality_(0) {
    DCHECK(docids_);
  }

  size_t size() const final { return docids_->size(); }

  bool empty() const final { return size() == 0; }

  DimensionIndex dimensionality() const final { return dimensionality_.load(); }

  virtual DimensionIndex NumActiveDimensions() const = 0;

  virtual bool IsDense() const = 0;

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

  virtual void set_dimensionality(DimensionIndex dimensionality) = 0;

  virtual void Reserve(size_t n_points) {}

  void ReserveDocids(size_t n_docids) { docids_->Reserve(n_docids); }

  string_view GetDocid(size_t index) const final { return docids_->Get(index); }

  const shared_ptr<DocidCollectionInterface>& docids() const { return docids_; }

  virtual shared_ptr<DocidCollectionInterface> ReleaseDocids();

  virtual void clear() = 0;

  virtual research_scann::TypeTag TypeTag() const = 0;

  virtual void GetDatapoint(size_t index, Datapoint<double>* result) const = 0;

  virtual void GetDatapoint(size_t index, Datapoint<float>* result) const = 0;

  virtual void GetDenseDatapoint(size_t index,
                                 Datapoint<double>* result) const = 0;

  virtual void GetDenseDatapoint(size_t index,
                                 Datapoint<float>* result) const = 0;

  virtual void Prefetch(size_t index) const = 0;

  virtual double GetDistance(const DistanceMeasure& dist, size_t vec1_index,
                             size_t vec2_index) const = 0;

  virtual Status MeanByDimension(Datapoint<double>* result) const = 0;

  virtual Status MeanByDimension(ConstSpan<DatapointIndex> subset,
                                 Datapoint<double>* result) const = 0;

  virtual void MeanVarianceByDimension(Datapoint<double>* means,
                                       Datapoint<double>* variances) const = 0;

  virtual void MeanVarianceByDimension(ConstSpan<DatapointIndex> subset,
                                       Datapoint<double>* means,
                                       Datapoint<double>* variances) const = 0;

  virtual Status NormalizeUnitL2() = 0;

  virtual Status NormalizeZeroMeanUnitVariance() = 0;

  Normalization normalization() const final { return normalization_; }

  Status NormalizeByTag(Normalization tag);

  void set_normalization_tag(Normalization tag) { normalization_ = tag; }

  HashedItem::PackingStrategy packing_strategy() const final {
    return packing_strategy_;
  }

  void set_packing_strategy(HashedItem::PackingStrategy packing_strategy) {
    packing_strategy_ = packing_strategy;
  }

  virtual bool is_float() const = 0;

  bool is_binary() const final {
    return packing_strategy_ == HashedItem::BINARY;
  }

  virtual void set_is_binary(bool val) {
    packing_strategy_ = val ? HashedItem::BINARY : HashedItem::NONE;
  }

  virtual void ShrinkToFit() {}

  size_t DocidArrayCapacity() const { return docids_->capacity(); }

  virtual size_t MemoryUsageExcludingDocids() const = 0;

  size_t DocidMemoryUsage() const { return docids_->MemoryUsage(); }

  void AttachDocidCollection(shared_ptr<DocidCollectionInterface> docids) {
    DCHECK(docids);
    DCHECK_EQ(docids->size(), size());
    set_docids_no_checks(docids);
  }

  class Mutator;
  virtual StatusOr<typename Dataset::Mutator*> GetUntypedMutator() const = 0;

 protected:
  void set_dimensionality_no_checks(DimensionIndex dim) {
    dimensionality_.store(dim);
  }

  void set_docids_no_checks(shared_ptr<DocidCollectionInterface> docids) {
    docids_ = std::move(docids);
  }

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

  Status AppendDocid(string_view docid) { return docids_->Append(docid); }

 private:
  shared_ptr<DocidCollectionInterface> docids_;

  RelaxedAtomic<DimensionIndex> dimensionality_;

  Normalization normalization_ = NONE;

  HashedItem::PackingStrategy packing_strategy_ = HashedItem::NONE;
};

class Dataset::Mutator : public VirtualDestructor {
 public:
  virtual Status RemoveDatapoint(string_view docid) = 0;

  virtual bool LookupDatapointIndex(string_view docid,
                                    DatapointIndex* index) const = 0;

  virtual void Reserve(size_t size) = 0;

  virtual Status RemoveDatapoint(DatapointIndex index) = 0;
};

template <typename T>
class TypedDataset : public Dataset, public virtual TypedDatasetView<T> {
 public:
  SCANN_DECLARE_MOVE_ONLY_CLASS(TypedDataset);

  TypedDataset() = default;

  explicit TypedDataset(unique_ptr<DocidCollectionInterface> docids)
      : Dataset(std::move(docids)) {}

  research_scann::TypeTag TypeTag() const final { return TagForType<T>(); }

  bool is_float() const final { return std::is_floating_point<T>::value; }

  using const_iterator = RandomAccessIterator<const TypedDataset<T>>;
  const_iterator begin() const { return const_iterator(this, 0); }
  const_iterator end() const { return const_iterator(this, this->size()); }

  virtual DatapointPtr<T> operator[](size_t datapoint_index) const = 0;

  DatapointPtr<T> at(size_t datapoint_index) const {
    CHECK_LT(datapoint_index, size());
    return operator[](datapoint_index);
  }

  virtual Status Append(const DatapointPtr<T>& dptr, string_view docid) = 0;
  Status Append(const DatapointPtr<T>& dptr);

  virtual Status Append(const GenericFeatureVector& gfv, string_view docid) = 0;
  Status Append(const GenericFeatureVector& gfv);

  void AppendOrDie(const DatapointPtr<T>& dptr, string_view docid);
  void AppendOrDie(const GenericFeatureVector& gfv, string_view docid);
  void AppendOrDie(const DatapointPtr<T>& dptr);
  void AppendOrDie(const GenericFeatureVector& gfv);

  void GetDatapoint(size_t index, Datapoint<double>* result) const final;
  void GetDatapoint(size_t index, Datapoint<float>* result) const final;
  Status MeanByDimension(Datapoint<double>* result) const final;
  Status MeanByDimension(ConstSpan<DatapointIndex> subset,
                         Datapoint<double>* result) const final;
  void MeanVarianceByDimension(Datapoint<double>* means,
                               Datapoint<double>* variances) const final;
  void MeanVarianceByDimension(ConstSpan<DatapointIndex> subset,
                               Datapoint<double>* means,
                               Datapoint<double>* variances) const final;
  Status NormalizeUnitL2() final;
  Status NormalizeZeroMeanUnitVariance() final;

  class Mutator;
  virtual StatusOr<typename TypedDataset::Mutator*> GetMutator() const = 0;
  StatusOr<typename Dataset::Mutator*> GetUntypedMutator() const final {
    SCANN_ASSIGN_OR_RETURN(Dataset::Mutator * result, GetMutator());
    return result;
  }
};

template <typename T>
class TypedDataset<T>::Mutator : public Dataset::Mutator {
 public:
  virtual StatusOr<Datapoint<T>> GetDatapoint(DatapointIndex index) const = 0;

  virtual Status AddDatapoint(const DatapointPtr<T>& dptr,
                              string_view docid) = 0;

  Status RemoveDatapoint(string_view docid) override = 0;

  virtual Status UpdateDatapoint(const DatapointPtr<T>& dptr,
                                 string_view docid) = 0;

  bool LookupDatapointIndex(string_view docid,
                            DatapointIndex* index) const override = 0;

  void Reserve(size_t size) override = 0;

  Status RemoveDatapoint(DatapointIndex index) override = 0;
  virtual Status UpdateDatapoint(const DatapointPtr<T>& dptr,
                                 DatapointIndex index) = 0;
};

template <typename T>
class DenseDataset final : public TypedDataset<T> {
 public:
  SCANN_DECLARE_MOVE_ONLY_CLASS(DenseDataset);

  DenseDataset() {}

  explicit DenseDataset(unique_ptr<DocidCollectionInterface> docids)
      : TypedDataset<T>(std::move(docids)) {}

  DenseDataset(std::vector<T> datapoint_vec,
               unique_ptr<DocidCollectionInterface> docids);

  DenseDataset(std::vector<T>&& datapoint_vec, size_t num_dp);

  DenseDataset<T> Copy() const {
    auto result = DenseDataset<T>(data_, this->docids()->Copy());
    result.set_normalization_tag(this->normalization());

    result.set_dimensionality(this->dimensionality());
    return result;
  }

  bool IsDense() const final { return true; }

  using const_iterator = RandomAccessIterator<const DenseDataset<T>>;
  const_iterator begin() const { return const_iterator(this, 0); }
  const_iterator end() const { return const_iterator(this, this->size()); }

  size_t n_elements() const {
    return static_cast<size_t>(this->size()) *
           static_cast<size_t>(this->dimensionality());
  }

  void Reserve(size_t n) final;
  void ReserveImpl(size_t n);

  void Resize(size_t n);

  template <typename Real>
  void ConvertType(DenseDataset<Real>* target) const {
    ConvertType(target, this->size());
  }
  template <typename Real>
  void ConvertType(DenseDataset<Real>* target, DatapointIndex first_n) const;

  ConstSpan<T> data() const { return data_; }
  ConstSpan<T> data(size_t index) const {
    return MakeConstSpan(data_.data() + index * stride_, stride_);
  }
  MutableSpan<T> mutable_data() { return MakeMutableSpan(data_); }
  MutableSpan<T> mutable_data(size_t index) {
    return MakeMutableSpan(data_.data() + index * stride_, stride_);
  }

  vector<T> ClearRecyclingDataVector() {
    vector<T> result = std::move(data_);
    this->clear();
    return result;
  }

  void clear() final;
  DimensionIndex NumActiveDimensions() const final;
  void ShrinkToFit() final;
  size_t MemoryUsageExcludingDocids() const final;
  inline DatapointPtr<T> operator[](size_t i) const final;
  void set_dimensionality(DimensionIndex dimensionality) final;
  void set_is_binary(bool val) final;
  void GetDenseDatapoint(size_t index, Datapoint<double>* result) const final;
  void GetDenseDatapoint(size_t index, Datapoint<float>* result) const final;
  inline void Prefetch(size_t index) const final;
  double GetDistance(const DistanceMeasure& dist, size_t vec1_index,
                     size_t vec2_index) const final;
  using TypedDataset<T>::Append;
  Status Append(const DatapointPtr<T>& dptr, string_view docid) final;
  Status Append(const GenericFeatureVector& gfv, string_view docid) final;
  shared_ptr<DocidCollectionInterface> ReleaseDocids() final;

  using TypedDataset<T>::AppendOrDie;

  void AppendOrDie(ConstSpan<T> values, string_view docid) {
    AppendOrDie(MakeDatapointPtr<T>(values), docid);
  }
  void AppendOrDie(ConstSpan<T> values) {
    AppendOrDie(MakeDatapointPtr<T>(values), absl::StrCat(this->size()));
  }

  class Mutator : public TypedDataset<T>::Mutator {
   public:
    SCANN_DECLARE_MOVE_ONLY_CLASS(Mutator);

    static StatusOr<unique_ptr<typename DenseDataset<T>::Mutator>> Create(
        DenseDataset<T>* dataset);

    ~Mutator() final {}

    StatusOr<Datapoint<T>> GetDatapoint(DatapointIndex index) const final;

    Status AddDatapoint(const DatapointPtr<T>& dptr, string_view docid) final;

    Status RemoveDatapoint(string_view docid) final;
    Status RemoveDatapoint(DatapointIndex index) final;

    Status UpdateDatapoint(const DatapointPtr<T>& dptr,
                           string_view docid) final;
    Status UpdateDatapoint(const DatapointPtr<T>& dptr,
                           DatapointIndex index) final;

    bool LookupDatapointIndex(string_view docid,
                              DatapointIndex* index) const final;

    void Reserve(size_t size) final;

   private:
    explicit Mutator(DenseDataset<T>* dataset,
                     DocidCollectionInterface::Mutator* docid_mutator)
        : dataset_(dataset), docid_mutator_(docid_mutator) {}
    DenseDataset<T>* dataset_ = nullptr;
    DocidCollectionInterface::Mutator* docid_mutator_ = nullptr;
  };

  StatusOr<typename TypedDataset<T>::Mutator*> GetMutator() const final;

 private:
  void SetStride();

  std::vector<T> data_;

  DimensionIndex stride_ = 0;

  mutable unique_ptr<typename DenseDataset<T>::Mutator> mutator_;

  template <typename U>
  friend class DenseDataset;
};

template <typename T>
class DenseDatasetSubView;
template <typename T>
class RandomDatapointsSubView;

template <typename T>
class DenseDatasetView : public virtual TypedDatasetView<T> {
 public:
  DenseDatasetView() = default;

  virtual const T* GetPtr(size_t i) const = 0;

  SCANN_INLINE ConstSpan<T> GetDatapointSpan(size_t i) const {
    return MakeConstSpan(GetPtr(i), dimensionality());
  }

  DimensionIndex dimensionality() const override = 0;

  virtual size_t size() const override = 0;

  research_scann::TypeTag TypeTag() const override { return TagForType<T>(); }

  virtual bool IsConsecutiveStorage() const { return false; }

  bool empty() const override { return this->size() == 0; }
  DimensionIndex NumActiveDimensions() const override {
    return this->dimensionality();
  }
  bool IsDense() const override { return true; }
  bool IsSparse() const override { return false; }
  string_view GetDocid(size_t index) const override { return ""; }
  void GetDatapoint(size_t index, Datapoint<double>* result) const override;
  void GetDatapoint(size_t index, Datapoint<float>* result) const override;
  void GetDenseDatapoint(size_t index,
                         Datapoint<double>* result) const override {
    this->GetDatapoint(index, result);
  }
  void GetDenseDatapoint(size_t index,
                         Datapoint<float>* result) const override {
    this->GetDatapoint(index, result);
  }
  void Prefetch(size_t index) const override {}
  double GetDistance(const DistanceMeasure& dist, size_t vec1_index,
                     size_t vec2_index) const override {
    return dist.GetDistanceDense((*this)[vec1_index], (*this)[vec2_index]);
  }
  Normalization normalization() const override { return NONE; }
  HashedItem::PackingStrategy packing_strategy() const override {
    return HashedItem::NONE;
  }
  bool is_float() const override { return std::is_floating_point<T>::value; }
  bool is_binary() const override { return false; }
  DatapointPtr<T> operator[](size_t i) const override {
    return MakeDatapointPtr<T>(nullptr, this->GetPtr(i), this->dimensionality(),
                               this->dimensionality());
  }

  Status MeanByDimension(Datapoint<double>* result) const override;
  Status MeanByDimension(ConstSpan<DatapointIndex> subset,
                         Datapoint<double>* result) const override;
  void MeanVarianceByDimension(Datapoint<double>* means,
                               Datapoint<double>* variances) const override;
  void MeanVarianceByDimension(ConstSpan<DatapointIndex> subset,
                               Datapoint<double>* means,
                               Datapoint<double>* variances) const override;

  virtual std::unique_ptr<DenseDatasetView<T>> subview(size_t offset,
                                                       size_t size) const {
    return std::make_unique<DenseDatasetSubView<T>>(this, offset, size);
  }

  virtual std::unique_ptr<DenseDatasetView<T>> random_datapoints_subview(
      ConstSpan<DatapointIndex> dp_idxs) const {
    return std::make_unique<RandomDatapointsSubView<T>>(this, dp_idxs);
  }
};

template <typename T>
class DefaultDenseDatasetView : public DenseDatasetView<T> {
 public:
  DefaultDenseDatasetView() = default;

  DefaultDenseDatasetView(const DenseDataset<T>& ds)
      : ptr_(ds.data().data()), size_(ds.size()) {
    if (ds.packing_strategy() == HashedItem::BINARY) {
      dims_ = ds.dimensionality() / 8 + (ds.dimensionality() % 8 > 0);
    } else if (ds.packing_strategy() == HashedItem::NIBBLE) {
      dims_ = ds.dimensionality() / 2 + (ds.dimensionality() % 2 > 0);
    } else {
      dims_ = ds.dimensionality();
    }
  }

  explicit DefaultDenseDatasetView(ConstSpan<T> span, size_t dimensionality)
      : ptr_(span.data()),
        dims_(dimensionality),
        size_(span.size() / dimensionality) {}

  SCANN_INLINE const T* GetPtr(size_t i) const final {
    return ptr_ + i * dims_;
  }

  SCANN_INLINE DimensionIndex dimensionality() const final { return dims_; }

  SCANN_INLINE size_t size() const final { return size_; }

  std::unique_ptr<DenseDatasetView<T>> subview(size_t offset,
                                               size_t size) const final {
    return absl::WrapUnique(
        new DefaultDenseDatasetView<T>(ptr_ + offset * dims_, dims_, size));
  }

  bool IsConsecutiveStorage() const override { return true; }

  ConstSpan<T> data() const { return ConstSpan<T>(ptr_, dims_ * size_); }

  bool empty() const { return size_ == 0; }

 private:
  DefaultDenseDatasetView(const T* ptr, size_t dim, size_t size)
      : ptr_(ptr), dims_(dim), size_(size) {}

  const T* __restrict__ ptr_ = nullptr;
  DimensionIndex dims_ = 0;
  size_t size_ = 0;
};

template <typename T>
class DenseDatasetSubView : public DenseDatasetView<T> {
 public:
  DenseDatasetSubView(const DenseDatasetView<T>* parent, size_t offset,
                      size_t size)
      : parent_view_(parent), offset_(offset), size_(size) {}

  SCANN_INLINE_FORWARDING const T* GetPtr(size_t i) const final {
    return parent_view_->GetPtr(offset_ + i);
  }

  SCANN_INLINE_FORWARDING DimensionIndex dimensionality() const final {
    return parent_view_->dimensionality();
  };

  SCANN_INLINE size_t size() const final { return size_; }

  std::unique_ptr<DenseDatasetView<T>> subview(size_t offset,
                                               size_t size) const final {
    return std::make_unique<DenseDatasetSubView<T>>(parent_view_,
                                                    offset + offset_, size);
  }

  bool IsConsecutiveStorage() const override {
    return parent_view_->IsConsecutiveStorage();
  }

 private:
  const DenseDatasetView<T>* __restrict__ parent_view_ = nullptr;
  const size_t offset_ = 0;
  const size_t size_ = 0;
};

template <typename T>
class RandomDatapointsSubView : public DenseDatasetView<T> {
 public:
  RandomDatapointsSubView(const DenseDatasetView<T>* parent,
                          ConstSpan<DatapointIndex> dp_idxs)
      : parent_view_(parent), dp_idxs_(dp_idxs.begin(), dp_idxs.end()) {}

  SCANN_INLINE_FORWARDING const T* GetPtr(size_t i) const final {
    return parent_view_->GetPtr(dp_idxs_[i]);
  }

  SCANN_INLINE_FORWARDING DimensionIndex dimensionality() const final {
    return parent_view_->dimensionality();
  };

  SCANN_INLINE size_t size() const final { return dp_idxs_.size(); }

  std::unique_ptr<DenseDatasetView<T>> subview(size_t offset,
                                               size_t size) const final {
    return std::make_unique<DenseDatasetSubView<T>>(this, offset, size);
  }

  bool IsConsecutiveStorage() const override { return false; }

 private:
  const DenseDatasetView<T>* __restrict__ parent_view_ = nullptr;
  const std::vector<DatapointIndex> dp_idxs_;
};

template <typename T>
class StridedDatasetView final : public DenseDatasetView<T> {
 public:
  StridedDatasetView(const T* ptr, size_t dimension, size_t stride, size_t size)
      : ptr_(ptr), dims_(dimension), stride_(stride), size_(size) {}

  SCANN_INLINE const T* GetPtr(size_t i) const final {
    return ptr_ + i * stride_;
  }

  SCANN_INLINE DimensionIndex dimensionality() const final { return dims_; }

  SCANN_INLINE size_t size() const final { return size_; }

  std::unique_ptr<DenseDatasetView<T>> subview(size_t offset,
                                               size_t size) const final {
    CHECK_LE(offset + size, size_);
    return absl::WrapUnique(new StridedDatasetView<T>(ptr_ + offset * stride_,
                                                      dims_, stride_, size));
  }

 private:
  const T* __restrict__ ptr_ = nullptr;
  DimensionIndex dims_ = 0;
  size_t stride_ = 0;
  size_t size_ = 0;
};

template <typename T>
class SpanDenseDatasetView final : public DenseDatasetView<T> {
 public:
  SpanDenseDatasetView(ConstSpan<T> span, size_t dimension)
      : ptr_(span.data()),
        dimension_(dimension),
        size_(span.size() / dimension) {
    CHECK_EQ(span.size() % dimension, 0);
  }

  SCANN_INLINE const T* GetPtr(size_t i) const override {
    return ptr_ + i * dimension_;
  }
  SCANN_INLINE DimensionIndex dimensionality() const override {
    return dimension_;
  }
  SCANN_INLINE size_t size() const override { return size_; }
  SCANN_INLINE bool IsConsecutiveStorage() const override { return true; }

 private:
  const T* __restrict__ ptr_ = nullptr;
  uint32_t dimension_;
  uint32_t size_;
};

template <typename T>
class SparseDataset final : public TypedDataset<T> {
 public:
  SCANN_DECLARE_MOVE_ONLY_CLASS(SparseDataset);

  SparseDataset() {}

  explicit SparseDataset(unique_ptr<DocidCollectionInterface> docids)
      : TypedDataset<T>(std::move(docids)) {}

  explicit SparseDataset(DimensionIndex dimensionality) : SparseDataset() {
    this->set_dimensionality(dimensionality);
  }

  bool IsDense() const final { return false; }

  using const_iterator = RandomAccessIterator<const SparseDataset<T>>;
  const_iterator begin() const { return const_iterator(this, 0); }
  const_iterator end() const { return const_iterator(this, this->size()); }

  using TypedDataset<T>::Append;

  Status Append(const GenericFeatureVector& gfv, string_view docid) final;
  Status Append(const DatapointPtr<T>& dptr, string_view docid) final;

  using TypedDataset<T>::AppendOrDie;

  void AppendOrDie(ConstSpan<DimensionIndex> indices, ConstSpan<T> values,
                   string_view docid = "") {
    AppendOrDie(MakeDatapointPtr<T>(indices, values, this->dimensionality()),
                docid);
  }

  void Reserve(size_t n_points) final;

  void Reserve(size_t n_points, size_t n_entries);

  DimensionIndex NonzeroEntriesForDatapoint(DatapointIndex i) const {
    return repr_.NonzeroEntriesForDatapoint(i);
  }

  size_t num_entries() const { return repr_.indices().size(); }

  bool AllValuesNonNegative() const {
    return std::is_unsigned<T>::value || repr_.values().empty() ||
           *std::min_element(repr_.values().begin(), repr_.values().end()) >= 0;
  }

  void clear() final;

  void ConvertType(SparseDataset<double>* target);

  inline DatapointPtr<T> operator[](size_t i) const final;
  void set_dimensionality(DimensionIndex dimensionality) final;
  DimensionIndex NumActiveDimensions() const final;
  void GetDenseDatapoint(size_t index, Datapoint<double>* result) const final;
  void GetDenseDatapoint(size_t index, Datapoint<float>* result) const final;
  inline void Prefetch(size_t index) const final;
  double GetDistance(const DistanceMeasure& dist, size_t vec1_index,
                     size_t vec2_index) const final;
  size_t MemoryUsageExcludingDocids() const final;
  void ShrinkToFit() final;

  StatusOr<typename TypedDataset<T>::Mutator*> GetMutator() const final {
    return UnimplementedError("Sparse dataset does not support mutation.");
  }

 private:
  Status AppendImpl(const GenericFeatureVector& gfv, string_view docid);
  Status AppendImpl(const DatapointPtr<T>& dptr, string_view docid);

  template <typename OutT>
  void GetDenseDatapointImpl(size_t index, Datapoint<OutT>* result) const;

  mutable SparseDatasetLowLevel<DimensionIndex, T> repr_;

  template <typename U>
  friend class SparseDataset;
};

template <typename T>
DatapointPtr<T> DenseDataset<T>::operator[](size_t i) const {
  DCHECK_LT(i, this->size());
  return MakeDatapointPtr(nullptr, data_.data() + i * stride_, stride_,
                          this->dimensionality());
}

template <typename T>
void DenseDataset<T>::Prefetch(size_t i) const {
  DCHECK_LT(i, this->size());
  absl::PrefetchToLocalCacheNta(
      reinterpret_cast<const char*>(data_.data() + i * stride_));
}

template <typename T>
template <typename Real>
void DenseDataset<T>::ConvertType(DenseDataset<Real>* target,
                                  DatapointIndex first_n) const {
  static_assert(std::is_floating_point<Real>(),
                "Real template parameter must be either float or double for "
                "DenseDataset::ConvertType.");
  CHECK(!this->is_binary()) << "Not implemented for binary datasets.";
  DCHECK(target);
  target->clear();
  target->set_dimensionality_no_checks(this->dimensionality());
  target->stride_ = stride_;
  first_n = std::min<size_t>(first_n, this->size());
  if (first_n == this->size()) {
    target->set_docids_no_checks(this->docids()->Copy());
  } else {
    target->set_docids_no_checks(make_unique<VariableLengthDocidCollection>(
        VariableLengthDocidCollection::CreateWithEmptyDocids(first_n)));
  }
  target->data_.insert(target->data_.begin(), data_.begin(),
                       data_.begin() + first_n * stride_);
}

template <typename T>
DatapointPtr<T> SparseDataset<T>::operator[](size_t i) const {
  DCHECK_LT(i, this->size());
  auto low_level_result = repr_.Get(i);
  return MakeDatapointPtr(low_level_result.indices, low_level_result.values,
                          low_level_result.nonzero_entries,
                          this->dimensionality());
}

template <typename T>
void SparseDataset<T>::Prefetch(size_t i) const {
  DCHECK_LT(i, this->size());
  repr_.Prefetch(i);
}

SCANN_INSTANTIATE_TYPED_CLASS(extern, TypedDatasetView);
SCANN_INSTANTIATE_TYPED_CLASS(extern, DenseDatasetView);
SCANN_INSTANTIATE_TYPED_CLASS(extern, TypedDataset);
SCANN_INSTANTIATE_TYPED_CLASS(extern, SparseDataset);
SCANN_INSTANTIATE_TYPED_CLASS(extern, DenseDataset);

}  // namespace research_scann

#endif