DataManager.h

/*
 * This file is part of the statismo library.
 *
 * Author: Marcel Luethi (marcel.luethi@unibas.ch)
 *
 * Copyright (c) 2011 University of Basel
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of the project's author nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS addINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef __DATAMANAGER_H_
#define __DATAMANAGER_H_

#include <list>

#include "Config.h"
#include "CommonTypes.h"
#include "DataItem.h"
#include "Exceptions.h"
#include "HDF5Utils.h"
#include "ModelInfo.h"
#include "Representer.h"
#include "StatismoUtils.h"

namespace statismo {

template<typename T>
class CrossValidationFold {
  public:
    typedef DataItem<T> DataItemType;
    typedef std::list<const DataItemType*> DataItemListType;

    /***
     * Create an empty fold
     */
    CrossValidationFold() {
    }
    ;

    CrossValidationFold(const DataItemListType& trainingData,
                        const DataItemListType& testingData) :
        m_trainingData(trainingData), m_testingData(testingData) {
    }

    DataItemListType GetTrainingData() const {
        return m_trainingData;
    }

    DataItemListType GetTestingData() const {
        return m_testingData;
    }

  private:
    DataItemListType m_trainingData;
    DataItemListType m_testingData;
};

template<typename T>
class DataManager {

  public:

    typedef Representer<T> RepresenterType;
    typedef typename RepresenterType::DatasetPointerType DatasetPointerType;
    typedef typename RepresenterType::DatasetConstPointerType DatasetConstPointerType;

    typedef DataItem<T> DataItemType;
    typedef DataItemWithSurrogates<T> DataItemWithSurrogatesType;
    typedef std::list<const DataItemType*> DataItemListType;
    typedef CrossValidationFold<T> CrossValidationFoldType;
    typedef std::list<CrossValidationFoldType> CrossValidationFoldListType;

    static DataManager<T>* Create(const RepresenterType* representer) {
        return new DataManager<T>(representer);
    }

    static DataManager<T>* Load(Representer<T>* representer,
                                const std::string& filename);


    void Delete() {
        delete this;
    }

    virtual ~DataManager();

    virtual void AddDataset(DatasetConstPointerType dataset,
                            const std::string& URI);

    virtual void Save(const std::string& filename) const;

    DataItemListType GetData() const;

    unsigned GetNumberOfSamples() const {
        return m_DataItemList.size();
    }

    CrossValidationFoldListType GetCrossValidationFolds(unsigned nFolds,
            bool randomize = true) const;

    CrossValidationFoldListType GetLeaveOneOutCrossValidationFolds() const;

  protected:
    DataManager(const RepresenterType* representer);

    DataManager(const DataManager<T>& orig);
    DataManager& operator=(const DataManager<T>& rhs);

    RepresenterType* m_representer;

    // members
    DataItemListType m_DataItemList;
};

}

#include "DataManager.hxx"

#endif /* __DATAMANAGER_H_ */