TestUtils.h

/**
 * Copyright (c) 2015-present, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the CC-by-NC license found in the
 * LICENSE file in the root directory of this source tree.
 */

// Copyright 2004-present Facebook. All Rights Reserved.

#pragma once

#include "../../FaissAssert.h"
#include "../../Index.h"
#include <initializer_list>
#include <memory>
#include <string>
#include <vector>

namespace faiss { namespace gpu {

/// Generates and displays a new seed for the test
void newTestSeed();

/// Uses an explicit seed for the test
void setTestSeed(long seed);

/// Returns the relative error in difference between a and b
/// (|a - b| / (0.5 * (|a| + |b|))
float relativeError(float a, float b);

/// Generates a random integer in the range [a, b]
int randVal(int a, int b);

/// Generates a random bool
bool randBool();

/// Select a random value from the given list of values provided as an
/// initializer_list
template <typename T>
T randSelect(std::initializer_list<T> vals) {
  FAISS_ASSERT(vals.size() > 0);
  int sel = randVal(0, vals.size());

  int i = 0;
  for (auto v : vals) {
    if (i++ == sel) {
      return v;
    }
  }

  // should not get here
  return *vals.begin();
}

/// Generates a collection of random vectors in the range [0, 1]
std::vector<float> randVecs(int num, int dim);

/// Compare two indices via query for similarity
void compareIndices(faiss::Index& refIndex,
                    faiss::Index& testIndex,
                    int numQuery, int dim, int k,
                    const std::string& configMsg,
                    float maxRelativeError = 6e-5f,
                    float pctMaxDiff1 = 0.1f,
                    float pctMaxDiffN = 0.005f);

/// Display specific differences in the two (distance, index) lists
void compareLists(const float* refDist,
                  const faiss::Index::idx_t* refInd,
                  const float* testDist,
                  const faiss::Index::idx_t* testInd,
                  int dim1, int dim2,
                  const std::string& configMsg,
                  bool printBasicStats, bool printDiffs, bool assertOnErr,
                  float maxRelativeError = 6e-5f,
                  float pctMaxDiff1 = 0.1f,
                  float pctMaxDiffN = 0.005f);

} }