frozendataset.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_FROZENDATASET_H
#define GAIA_FROZENDATASET_H

#include <QString>
#include <QVector>
#include "types.h"

namespace gaia2 {

class DataSet;
class FrozenDataSet;
class FrozenSearchPoint;
class FrozenDistance;

template <typename DataSetType, typename PointType, typename SearchPointType, typename DistanceType>
class BaseView;

typedef BaseView<FrozenDataSet, FrozenPoint, FrozenSearchPoint, FrozenDistance> FrozenView;


class FrozenDataSet : public MatrixRXf, public QObject {
public:
  FrozenDataSet();
  FrozenDataSet(int npoints, int dimension);

  void load(const QString& filename);

  void save(const QString& filename) const;

  int size() const;

  int dimension() const;


  QStringList pointNames() const;

  const QString& pointName(int i) const;

  int pointIndex(const QString& name) const;

  FrozenPoint point(const QString& name) const;

  QPair<int, int> descriptorLocation(const QString& descriptorName) const;

  QStringList descriptorNames() const;

  void fromDataSet(const DataSet& dataset);

  static void checkValidFrozenDataSet(const DataSet& dataset);

  void setReferenceDataSet(DataSet* dataset = 0);

  const DataSet* referenceDataSet() const;


  void addView(FrozenView* view) { Q_UNUSED(view); }
  void removeView(FrozenView* view) { Q_UNUSED(view); }

protected:
  QVector<QString> _names;

  // map of desc -> (start, end) indices
  QMap<QString, QPair<int, int> > _layout;

  DataSet* _referenceDataSet;

};


} // namespace gaia2

#endif // GAIA_FROZENDATASET_H