ShiftInvariantKernel.h

Go to the documentation of this file.

/*
 * Copyright (c) The Shogun Machine Learning Toolbox
 * Written (w) 2016 Soumyajit De
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those
 * of the authors and should not be interpreted as representing official policies,
 * either expressed or implied, of the Shogun Development Team.
 */

#include <shogun/lib/config.h>

#ifndef SHIFT_INVARIANT_KERNEL_H_
#define SHIFT_INVARIANT_KERNEL_H_

#include <shogun/kernel/Kernel.h>
#include <shogun/distance/CustomDistance.h>

namespace shogun
{

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

    CShiftInvariantKernel(CFeatures *l, CFeatures *r);

    virtual ~CShiftInvariantKernel();

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

    virtual void precompute_distance();

    virtual void cleanup();

    virtual float64_t compute(int32_t x, int32_t y)=0;

    virtual EKernelType get_kernel_type()=0;

    virtual EFeatureType get_feature_type()=0;

    virtual EFeatureClass get_feature_class()=0;

    virtual EDistanceType get_distance_type() const;

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

protected:
    virtual float64_t distance(int32_t idx_a, int32_t idx_b) const;

    CDistance* m_distance;

private:
    virtual void register_params();

    CCustomDistance* m_precomputed_distance;

    void set_precomputed_distance(CCustomDistance* precomputed_distance);

    CCustomDistance* get_precomputed_distance() const;

};

}

#endif // SHIFT_INVARIANT_KERNEL_H__