mknn_predefined_index.hpp

/*
 * Copyright (C) 2012-2015, Juan Manuel Barrios <juanmanuel@barrios.cl>
 * All rights reserved.
 *
 * This file is part of MetricKnn.
 * MetricKnn is made available under the terms of the BSD 2-Clause License.
 */

#ifndef MKNN_PREDEFINED_INDEX_HPP_
#define MKNN_PREDEFINED_INDEX_HPP_

#include "../metricknn_cpp.hpp"

namespace mknn {

class PredefIndex {
public:
    static void helpListIndexes();

    static void helpPrintIndex(std::string id_index);
    static bool testIndexId(std::string id_index);
    static IndexParams LinearScan_indexParams();
    static ResolverParams LinearScan_resolverExactNearestNeighbors(long long knn,
            double range, long long max_threads);

    static ResolverParams LinearScan_resolverExactFarthestNeighbors(
            long long knn, long long max_threads);

    static IndexParams Laesa_indexParams(long long num_pivots);
    static ResolverParams Laesa_resolverExactNearestNeighbors(long long knn,
            double range, long long max_threads);
    static ResolverParams Laesa_resolverApproximateNearestNeighbors(
            long long knn, double range, long long max_threads,
            double approximation_percentage);

    static IndexParams SnakeTable_indexParams(long long num_pivots);
    static ResolverParams SnakeTable_resolverExactNearestNeighbors(long long knn,
            double range, long long max_threads);

    static IndexParams FlannLinearScan_indexParams();

    static IndexParams FlannKdTree_indexParams(long long num_trees);

    static IndexParams FlannKmeansTree_indexParams(long long branching,
            long long iterations);

    static IndexParams FlannLSH_indexParams(long long table_number,
            long long key_size, long long multi_probe_level);
    static IndexParams FlannAutoIndex_indexParams(double target_precision,
            double build_weight, double memory_weight, double sample_fraction);
    static ResolverParams Flann_resolverExactNearestNeighbors(long long knn,
            long long max_threads);

    static ResolverParams Flann_resolverApproximateNearestNeighbors(
            long long knn, long long max_threads, long long num_checks);

};

}

#endif