Rename ivf_flat_index_group to ivf_flat_group (#385)

Author: jparismorgan

src/include/index/README/IVF.md

@@ -4,7 +4,7 @@ There are four primary classes in the `IVFFlatIndex` design:
 
 1. `IVFFlatIndex`: The type-erased C++ class interface to an IVF index.
 2. `ivf_flat_index`: The typed C++ class that implements the IVF index.
-3. `ivf_flat_index_group`: The C++ class that represents the TileDB comprising the arrays that make up the IVF index (centroids, partititioned vectors, partitioned ids, index, etc.).
+3. `ivf_flat_group`: The C++ class that represents the TileDB comprising the arrays that make up the IVF index (centroids, partititioned vectors, partitioned ids, index, etc.).
 4. `ivf_flat_index_metadata`: The C++ class that represents the metadata for the group (types of the arrays, history of the group, etc.)
 
 ## Design Principles
@@ -22,14 +22,14 @@ on a partitioned feature vector array.
 
 The `ivf_flat_index` is simply an inverted index. It is not "aware" of anything
 having to do with TileDB arrays, including URIs, groups, arrays, metadata, and the
-like. That is all handled by the `ivf_flat_index_group` class.
+like. That is all handled by the `ivf_flat_group` class.
 
-The `ivf_flat_index_group` is the interface between the `ivf_flat_index` and the
+The `ivf_flat_group` is the interface between the `ivf_flat_index` and the
 TileDB index arrays. It contains all of the information necessary to fill the
 arrays in an `ivf_flat_index` at a given timestamp.
 
 The `ivf_flat_index_metadata` class encapsulates metadata in a class separate from
-`ivf_flat_index_group` for the sake of convenience.
+`ivf_flat_group` for the sake of convenience.
 
 ## Functionality
 
@@ -205,7 +205,7 @@ In the non-cloud case, insertions into the `vamana` (graph-based) indexes is ext
 
 ### `ivf_flat_index`
 
-### `ivf_flat_index_group`
+### `ivf_flat_group`
 
 ### `ivf_flat_index_metadata`
 

src/include/index/ivf_flat_group.h

@@ -33,8 +33,8 @@
  * version of the index.
  */
 
-#ifndef TILEDB_IVF_FLAT_INDEX_GROUP_H
-#define TILEDB_IVF_FLAT_INDEX_GROUP_H
+#ifndef TILEDB_IVF_FLAT_GROUP_H
+#define TILEDB_IVF_FLAT_GROUP_H
 
 #include "index/index_defs.h"
 #include "index/index_group.h"
@@ -48,7 +48,7 @@
      }}};
 
 template <class index_type>
-class ivf_flat_index_group : public base_index_group<index_type> {
+class ivf_flat_group : public base_index_group<index_type> {
   using Base = base_index_group<index_type>;
 
   using Base::array_key_to_array_name_;
@@ -65,7 +65,7 @@ class ivf_flat_index_group : public base_index_group<index_type> {
   static const int32_t tile_size_bytes{64 * 1024 * 1024};
 
  public:
-  ivf_flat_index_group(
+  ivf_flat_group(
       const tiledb::Context& ctx,
       const std::string& uri,
       tiledb_query_type_t rw = TILEDB_READ,

src/include/index/ivf_flat_index.h

@@ -73,7 +73,7 @@ enum class kmeans_init { none, kmeanspp, random };
  * Class representing an inverted file (IVF) index for flat (non-compressed)
  * feature vectors.  The class simply holds the index data itself, it is
  * unaware of where the data comes from -- reading and writing data is done
- * via an ivf_flat_index_group.  Thus, this class does not hold information
+ * via an ivf_flat_group.  Thus, this class does not hold information
  * about the group (neither the group members, nor the group metadata).
  *
  * @tparam partitioned_vectors_feature_type
@@ -92,7 +92,7 @@ class ivf_flat_index {
   using score_type = float;  // @todo -- this should be a parameter?
   using centroid_feature_type = score_type;
 
-  using group_type = ivf_flat_index_group<ivf_flat_index>;
+  using group_type = ivf_flat_group<ivf_flat_index>;
   using metadata_type = ivf_flat_index_metadata;
 
  private:
@@ -119,7 +119,7 @@ class ivf_flat_index {
   /** The timestamp at which the index was created */
   TemporalPolicy temporal_policy_{TimeTravel, 0};
 
-  std::unique_ptr<ivf_flat_index_group<ivf_flat_index>> group_;
+  std::unique_ptr<ivf_flat_group<ivf_flat_index>> group_;
 
   /****************************************************************************
    * Index representation
@@ -222,7 +222,7 @@ class ivf_flat_index {
       const std::string& uri,
       std::optional<TemporalPolicy> temporal_policy = std::nullopt)
       : temporal_policy_{temporal_policy.has_value() ? *temporal_policy : TemporalPolicy()}
-      , group_{std::make_unique<ivf_flat_index_group<ivf_flat_index>>(
+      , group_{std::make_unique<ivf_flat_group<ivf_flat_index>>(
             ctx, uri, TILEDB_READ, temporal_policy_)} {
     /**
      * Read the centroids.  How the partitioned_vectors_ are read in will be
@@ -750,7 +750,7 @@ class ivf_flat_index {
       const std::string& group_uri,
       const std::string& storage_version = "") const {
     // Write the group
-    auto write_group = ivf_flat_index_group<ivf_flat_index>(
+    auto write_group = ivf_flat_group<ivf_flat_index>(
         ctx,
         group_uri,
         TILEDB_WRITE,

src/include/test/unit_inner_product_distance.cc

@@ -34,9 +34,6 @@
 #include "detail/linalg/matrix.h"
 #include "detail/scoring/inner_product.h"
 
-TEST_CASE("inner_product_distance: null test", "[inner_product_distance]") {
-}
-
 TEST_CASE(
     "inner_product_distance: simple vectors", "[inner_product_distance]") {
   auto u = std::vector<uint8_t>{1, 2, 3, 4};