SphericalKernel.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.
 *
 * Based on GaussianKernel, Written (W) 1999-2010 Soeren Sonnenburg
 * Written (W) 2011 Shashwat Lal Das
 * Copyright (C) 2011 Berlin Institute of Technology and Max-Planck-Society
 */

#include <shogun/lib/config.h>

#ifndef _SPHERICALKERNEL_H__
#define _SPHERICALKERNEL_H__

#include <shogun/lib/common.h>
#include <shogun/kernel/Kernel.h>
#include <shogun/distance/Distance.h>

namespace shogun
{

class CDistance;

class CSphericalKernel: public CKernel
{
    public:
    CSphericalKernel();

    CSphericalKernel(int32_t size, float64_t sigma, CDistance* dist);

    CSphericalKernel(CFeatures *l, CFeatures *r, float64_t sigma, CDistance* dist);

    virtual bool init(CFeatures* l, CFeatures* r);

    virtual EKernelType get_kernel_type() { return K_SPHERICAL; }

    virtual EFeatureType get_feature_type() { return distance->get_feature_type(); }

    virtual EFeatureClass get_feature_class() { return distance->get_feature_class(); }

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

    virtual void set_sigma(float64_t s)
    {
        sigma=s;
    }

    virtual float64_t get_sigma() const
    {
        return sigma;
    }

    virtual ~CSphericalKernel();

private:
    void register_params();

protected:

    CDistance* distance;

    float64_t sigma;

    virtual float64_t compute(int32_t idx_a, int32_t idx_b);
};
}

#endif /* _SPHERICALKERNEL_H__ */