KernelLookup.h

#ifndef _theplu_yat_classifier_kernel_lookup_
#define _theplu_yat_classifier_kernel_lookup_

// $Id: KernelLookup.h 3293 2014-07-25 03:42:58Z peter $

/*
  Copyright (C) 2005 Jari Häkkinen, Peter Johansson
  Copyright (C) 2006 Jari Häkkinen, Peter Johansson, Markus Ringnér
  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
  Copyright (C) 2010, 2012, 2014 Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/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 3 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 yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include "Kernel.h"
#include "yat/utility/Container2DIterator.h"
#include "yat/utility/Index.h"
#include "yat/utility/iterator_traits.h"
#include "yat/utility/StrideIterator.h"

#include <boost/shared_ptr.hpp>

namespace theplu {
namespace yat {
namespace classifier {

  class KernelFunction;
  class MatrixLookup;
  class MatrixLookupWeighted;

  class KernelLookup
  {

  public:
    typedef double value_type;

    typedef const double const_reference;

    typedef utility::StrideIterator<
    utility::Container2DIterator<const KernelLookup, const double,
                                 const_reference> >
    const_iterator;

    typedef const_iterator const_column_iterator;

    typedef const_iterator const_row_iterator;

    KernelLookup(const Kernel& kernel, const bool owner=false);

    KernelLookup(const Kernel& kernel, const utility::Index& row, 
                 const utility::Index& column, const bool owner=false);

    KernelLookup(const KernelLookup& kl);


    KernelLookup(const KernelLookup& kl, const utility::Index& row, 
                 const utility::Index& column);

    KernelLookup(const KernelLookup& kl, const utility::Index&, 
                 const bool row=false);

    virtual ~KernelLookup(void);

    const_iterator begin(void) const;

    const_column_iterator begin_column(size_t) const;

    const_row_iterator begin_row(size_t) const;

    size_t columns(void) const;

    MatrixLookup data(void) const;

    MatrixLookupWeighted data_weighted(void) const;

    double element(const DataLookup1D& vec, size_t i) const;

    double element(const DataLookupWeighted1D& vec, size_t i) const;

    const_iterator end(void) const;

    const_column_iterator end_column(size_t) const;

    const_row_iterator end_row(size_t) const;

    size_t rows(void) const;

    KernelLookup selected(const utility::Index& index) const;
    
    KernelLookup test_kernel(const MatrixLookup& data) const;

    KernelLookup test_kernel(const MatrixLookupWeighted& data) const;

    bool weighted(void) const;

    const_reference operator()(size_t row, size_t column) const;

  private:
    const KernelLookup& operator=(const KernelLookup&);
    bool validate(const utility::Index&) const;

    utility::Index column_index_;
    boost::shared_ptr<const Kernel> kernel_;
    utility::Index row_index_;
  }; // class KernelLookup

}}} // of namespace classifier, yat, and theplu

#endif