source: trunk/yat/microarray/DataSet.h @ 706

#ifndef _theplu_yat_microarray_dataset_
#define _theplu_yat_microarray_dataset_

// $Id: DataSet.h 706 2006-12-19 08:59:19Z jari $

/*
  Copyright (C) The authors contributing to this file.

  This file is part of the yat library, http://lev.thep.lu.se/trac/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of the
  License, or (at your option) any later version.

  The yat library 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 GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

#include "yat/classifier/MatrixLookup.h"
#include "yat/classifier/Target.h"

#include <map>
#include <string>
#include <vector>

namespace theplu {
namespace yat {
namespace microarray {

  ///
  /// @brief DataSet
  ///
  /// @note the interface of this class will most likely change.
  ///
  class DataSet
  {
  public:
    /// 
    /// @brief Constructor
    /// 
    DataSet(const classifier::MatrixLookup&, const classifier::Target&, 
            const std::vector<std::string>&);

    /// 
    /// Constructing a dataset that is a subset of @a data, namely the
    /// probes overlapping @a data and @a probes.
    /// 
    DataSet(const DataSet& data, const std::vector<std::string>& probes);

    ///
    /// @return probes
    ///
    inline const std::vector<std::string>& probe(void) const { return probe_; }

    ///
    /// @return target
    ///
    inline const classifier::Target& target(void) const { return target_; }

    ///
    /// @return data
    ///
    inline const classifier::MatrixLookup& data(void) const { return data_; }

  private:
    ///
    /// @brief The copy constructor
    ///
    DataSet(const DataSet&);

    ///
    /// @brief The assignment operator
    ///
    DataSet& operator=(const DataSet&);

    classifier::MatrixLookup data_;
    std::vector<std::string> probe_;
    const classifier::Target& target_;

  };

}}} // end of namespace utility, yat, and theplu


#endif