LinearKernel.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) 1999-2010 Soeren Sonnenburg
 * Copyright (C) 1999-2009 Fraunhofer Institute FIRST and Max-Planck-Society
 * Copyright (C) 2010 Berlin Institute of Technology
 */

#ifndef _LINEARKERNEL_H___
#define _LINEARKERNEL_H___

#include <shogun/lib/common.h>
#include <shogun/kernel/DotKernel.h>
#include <shogun/features/DotFeatures.h>
#include <shogun/machine/KernelMachine.h>

namespace shogun
{
    class CKernelMachine;
    class CDotFeatures;

class CLinearKernel: public CDotKernel
{
    public:
        CLinearKernel();

        CLinearKernel(CDotFeatures* l, CDotFeatures* r);

        virtual ~CLinearKernel();

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

        virtual void cleanup();

        virtual EKernelType get_kernel_type() { return K_LINEAR; }

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

        virtual bool init_optimization(
            int32_t num_suppvec, int32_t* sv_idx, float64_t* alphas);

        virtual bool init_optimization(CKernelMachine* km);

        virtual bool delete_optimization();

        virtual float64_t compute_optimized(int32_t idx);

        virtual void clear_normal();

        virtual void add_to_normal(int32_t idx, float64_t weight);

        inline const float64_t* get_normal(int32_t& len)
        {
            if (lhs && normal)
            {
                len = ((CDotFeatures*) lhs)->get_dim_feature_space();
                return normal;
            }
            else
            {
                len = 0;
                return NULL;
            }
        }

        inline void get_w(float64_t** dst_w, int32_t* dst_dims)
        {
            ASSERT(lhs && normal);
            int32_t len = ((CDotFeatures*) lhs)->get_dim_feature_space();
            ASSERT(dst_w && dst_dims);
            *dst_dims=len;
            *dst_w=SG_MALLOC(float64_t, *dst_dims);
            ASSERT(*dst_w);
            memcpy(*dst_w, normal, sizeof(float64_t) * (*dst_dims));
        }

        inline void set_w(float64_t* src_w, int32_t src_w_dim)
        {
            ASSERT(lhs && src_w_dim==((CDotFeatures*) lhs)->get_dim_feature_space());
            clear_normal();
            memcpy(normal, src_w, sizeof(float64_t) * src_w_dim);
        }

    protected:
        float64_t* normal;
        int32_t normal_length;
};
}
#endif /* _LINEARKERNEL_H__ */