cyclops.h

/* 
 * Copyright (C) 2006-2013  Music Technology Group - Universitat Pompeu Fabra
 *
 * This file is part of Gaia
 * 
 * Gaia is free software: you can redistribute it and/or modify it under 
 * the terms of the GNU Affero General Public License as published by the Free 
 * Software Foundation (FSF), either version 3 of the License, or (at your 
 * option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT 
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
 * details.
 * 
 * You should have received a copy of the Affero GNU General Public License
 * version 3 along with this program.  If not, see http://www.gnu.org/licenses/
 */

#ifndef GAIA_CYCLOPS_H
#define GAIA_CYCLOPS_H

#include "dataset.h"
#include "distancefunction.h"
#include "searchspace.h"

typedef QList<QString> CyclopsResultsHeader;
typedef QList<QList<QVariant> > CyclopsResultsValues;

class CyclopsResults {
 public:
  gaia2::SearchResults results;
  CyclopsResultsHeader header;
  CyclopsResultsValues values;

  void append(const gaia2::Result& r, const QList<QVariant>& values);

  void mid(int pos, int length);

  int size() const { return results.size(); }

  // NB: this is quite inefficient at the moment and could be optimized quite easily
  void sort();
};

class Cyclops : public QObject {
Q_OBJECT
 public:

  Cyclops();
  ~Cyclops();

  void load(const QString& datasetName, const QString& filename, int start = 0, int offset = -1);

  void loadNthPart(const QString& datasetName, const QString& filename, int idx, int total);

  void unload(const QString& datasetName);

  QStringList datasetNames() const;

  QString layout(const QString& datasetName) const;

  int size(const QString& datasetName) const;

  void setReferenceDataSet(const QString& dataset, const QString& referenceDataset);

  void createDistance(const QString& distanceName,
                              const QString& datasetName,
                              const QString& distance,
                              const gaia2::ParameterMap& params = gaia2::ParameterMap());

  void deleteDistance(const QString& distanceName);

  QStringList distanceNames() const;

  void indexOn(const QString& datasetName, const QString& descriptorName);

  CyclopsResults chainedSearch(const gaia2::yaml::Sequence& queries, const gaia2::yaml::Sequence& header, int numberResults, int offset = 0);

  gaia2::SearchResults nnSearchById(const QString& queryID,
                                    const QString& datasetName,
                                    const QString& distanceName,
                                    int numberResults,
                                    int offset = 0);

  gaia2::SearchResults nnSearchByIdWithFilter(const QString& queryID,
                                              const QString& datasetName,
                                              const QString& distanceName,
                                              const QString& filter,
                                              int numberResults,
                                              int offset = 0);

  gaia2::SearchResults nnSearchByExample(const gaia2::Point& query,
                                         const QString& datasetName,
                                         const QString& distanceName,
                                         int numberResults,
                                         int offset = 0);

  gaia2::SearchResults nnSearchByExampleWithFilter(const gaia2::Point& query,
                                                   const QString& datasetName,
                                                   const QString& distanceName,
                                                   const QString& filter,
                                                   int numberResults,
                                                   int offset = 0);

  const gaia2::Point* getPoint(const QString& datasetName, const QString& pointName) const;

  std::string getPoints(const QString& datasetName, const QStringList& pointNames, bool failOnError = true) const;

  void setup(const QString& filename);

  void setupFromYaml(const gaia2::yaml::Mapping& config);

 protected:
  gaia2::ResultSet nnSearch(const QString& methodName, const gaia2::yaml::Sequence& args,
                            const gaia2::ResultSet* inputSpace = 0);

  QMap<QString, gaia2::DataSet*> _datasets;
  QMap<QString, gaia2::View*> _views; // there should be a corresponding view for each dataset
  QMap<QString, gaia2::DistanceFunction*> _dfuncs;
};


#endif // GAIA_CYCLOPS_H