LinearOperator.h

Go to the documentation of this file.

/*
 * This program 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.
 * 
 * Written (W) 2013 Soumyajit De
 */

#ifndef LINEAR_OPERATOR_H_
#define LINEAR_OPERATOR_H_

#include <shogun/lib/config.h>
#include <shogun/base/SGObject.h>
#include <shogun/base/Parameter.h>

namespace shogun
{
template<class T> class SGVector;

template<class T> class CLinearOperator : public CSGObject
{
public:
    CLinearOperator()
    : CSGObject()
    {
        init();

        SG_GCDEBUG("%s created (%p)\n", this->get_name(), this)
    }

    CLinearOperator(index_t dimension)
    : CSGObject()
    {
        init();
    
        m_dimension=dimension;

        SG_GCDEBUG("%s created (%p)\n", this->get_name(), this)
    }

    virtual ~CLinearOperator()
    {
        SG_GCDEBUG("%s destroyed (%p)\n", this->get_name(), this)
    }

    const index_t get_dimension() const
    {
        return m_dimension;
    }

    virtual SGVector<T> apply(SGVector<T> b) const = 0;

    virtual const char* get_name() const
    {
        return "LinearOperator";
    }
protected:
    index_t m_dimension;

private:
    void init()
    {
        m_dimension=0;

        SG_ADD(&m_dimension, "dimension",
            "Dimension of the vector on which linear operator can apply",
            MS_NOT_AVAILABLE);
    }

};
}

#endif // LINEAR_OPERATOR_H_