utils.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_UTILS_H
#define GAIA_UTILS_H

#include "dataset.h"
#include "point.h"
#include "pointlayout.h"
#include "Eigen/Core"


// This file contains some useful functions that were not generic enough to go
// inside a class, and that benefit a lot of other classes (most of them are related
// to dataset management)

namespace gaia2 {

inline QString mergeName(const QStringList& name) {
  return name.join(QString(NAME_SEPARATOR));
}

inline QStringList splitName(const QString& name, bool includeRootNode = false) {
  if (includeRootNode) return name.split(NAME_SEPARATOR);
  return name.split(NAME_SEPARATOR, QString::SkipEmptyParts);
}


QPair<QString, int> parseDimension(const QString& dimension);


void checkIsomorphDataSets(const DataSet* dataset1, const DataSet* dataset2,
                           bool checkOriginalLayout = true);


QStringList selectDescriptors(const PointLayout& layout,
                              DescriptorType type = UndefinedType,
                              const QStringList& select = QStringList("*"),
                              const QStringList& exclude = QStringList(),
                              bool failOnUnmatched = true);


typedef QList<QPair<Segment, Segment> > IndexMap;

void createIndexMappings(const PointLayout& oldLayout,
                         PointLayout& newLayout,
                         const Region& region, IndexMap& realMap,
                         IndexMap& stringMap, IndexMap& enumMap);


void transferPointData(const Point* p, Point* result,
                       const IndexMap& realMap, const IndexMap& stringMap,
                       const IndexMap& enumMap);

Point* mapPoint(const Point* p, const PointLayout& newLayout,
                const IndexMap& realMap, const IndexMap& stringMap,
                const IndexMap& enumMap);

RealDescriptor mergeDescriptors(const Point* p, int nseg, const Region& region);


PointLayout mergeLayouts(const PointLayout& layout1, const PointLayout& layout2);

Point* mergePoints(const Point* ds1, const Point* ds2);

DataSet* mergeDataSets(const DataSet* ds1, const DataSet* ds2);


QMap<int, QString> mapRegionIndicesToNames(const Region& region,
                                           const DataSet* dataset);

QList<QPair<double, QString> > dimensionParticipation(const Eigen::VectorXd& values,
                                                      const QMap<int, QString>& dnames);

QList<QPair<double, QString> > dimensionBoost(const Eigen::MatrixXf& featureVector,
                                              const Region& region,
                                              const DataSet* dataset);

QString formatDimensionParticipation(const QList<QPair<double, QString> >& participation,
                                     bool ratio = false);


QMap<QString, QList<int> > dimensionListToMapping(const QStringList& dims);

void setDataStreamVersion(QDataStream& out);

void checkValidDataStream(QDataStream& in);

enum BinaryFileFormat {
  Gaia_2_0 = 100,
  Gaia_2_1 = 101,
  Gaia_2_3 = 102
};

int gaiaVersion(const QDataStream& stream);

int memoryUsage(QString mtype = "VmSize");

} // namespace gaia2

#endif // GAIA_UTILS_H