TraceSampler.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 TRACE_SAMPLER_H_
#define TRACE_SAMPLER_H_

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

namespace shogun
{
template<class T> class SGVector;

class CTraceSampler : public CSGObject
{
public:
    CTraceSampler()
    : CSGObject()
    {
        init();

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

    CTraceSampler(index_t dimension)
    : CSGObject()
    {
        init();

        m_dimension=dimension;

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

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

    virtual SGVector<float64_t> sample(index_t idx) const = 0;

    virtual void precompute() = 0;

    virtual const index_t get_num_samples() const
    {
        return m_num_samples;
    }

    virtual const index_t get_dimension() const
    {
        return m_dimension;
    }

    virtual const char* get_name() const
    {
        return "TraceSampler";
    }

protected:
    index_t m_dimension;

    index_t m_num_samples;

private:
    void init()
    {
        m_num_samples=0;
        m_dimension=0;

        SG_ADD(&m_num_samples, "num_samples",
            "Number of samples this sampler can generate", MS_NOT_AVAILABLE);

        SG_ADD(&m_dimension, "sample_dimension",
            "Dimension of samples this sampler can generate", MS_NOT_AVAILABLE);
    }
};

}

#endif // TRACE_SAMPLER_H_