ProbingSampler.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 PROBING_SAMPLER_H_
#define PROBING_SAMPLER_H_

#include <shogun/lib/config.h>

#ifdef HAVE_COLPACK
#ifdef HAVE_EIGEN3

#include <shogun/mathematics/linalg/ratapprox/tracesampler/TraceSampler.h>

namespace shogun
{

enum EOrderingVariant
{
    NATURAL=0,
    LARGEST_FIRST,
    DYNAMIC_LARGEST_FIRST,
    DISTANCE_TWO_LARGEST_FIRST,
    SMALLEST_LAST,
    DISTANCE_TWO_SMALLEST_LAST,
    INCIDENCE_DEGREE,
    DISTANCE_TWO_INCIDENCE_DEGREE,
    RANDOM
};

enum EColoringVariant
{
    DISTANCE_ONE=0,
    ACYCLIC,
    ACYCLIC_FOR_INDIRECT_RECOVERY,
    STAR,
    RESTRICTED_STAR,
    DISTANCE_TWO
};

template<class T> class SGVector;
template<class T> class SGString;
template<class T> class CSparseMatrixOperator;

class CProbingSampler : public CTraceSampler
{
public:
    CProbingSampler();

    CProbingSampler(CSparseMatrixOperator<float64_t>* matrix_operator,
        int64_t power=1, EOrderingVariant ordering=NATURAL,
        EColoringVariant coloring=DISTANCE_TWO);

    virtual ~CProbingSampler();

    SGVector<int32_t> get_coloring_vector() const;

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

    virtual void precompute();

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

private:
    CSparseMatrixOperator<float64_t>* m_matrix_operator;

    int64_t m_power;

    SGVector<int32_t> m_coloring_vector;

    SGString<char> m_ordering;

    SGString<char> m_coloring;

    void init();

};

}

#endif // HAVE_EIGEN3
#endif // HAVE_COLPACK
#endif // PROBING_SAMPLER_H_