DiceKernelNormalizer.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) 2009 Soeren Sonnenburg
 * Copyright (C) 2009 Fraunhofer Institute FIRST and Max-Planck-Society
 */

#ifndef _DICEKERNELNORMALIZER_H___
#define _DICEKERNELNORMALIZER_H___

#include <shogun/kernel/normalizer/KernelNormalizer.h>
#include <shogun/kernel/string/CommWordStringKernel.h>

namespace shogun
{
class CDiceKernelNormalizer : public CKernelNormalizer
{
    public:
        CDiceKernelNormalizer(bool use_opt_diag=false) : CKernelNormalizer(),
            diag_lhs(NULL), num_diag_lhs(0), diag_rhs(NULL), num_diag_rhs(0),
            use_optimized_diagonal_computation(use_opt_diag)
        {
            m_parameters->add_vector(&diag_lhs, &num_diag_lhs, "diag_lhs",
                              "K(x,x) for left hand side examples.");
            m_parameters->add_vector(&diag_rhs, &num_diag_rhs, "diag_rhs",
                              "K(x,x) for right hand side examples.");
            SG_ADD(&use_optimized_diagonal_computation,
                    "use_optimized_diagonal_computation",
                    "flat if optimized diagonal computation is used", MS_NOT_AVAILABLE);
        }

        virtual ~CDiceKernelNormalizer()
        {
            SG_FREE(diag_lhs);
            SG_FREE(diag_rhs);
        }

        virtual bool init(CKernel* k)
        {
            ASSERT(k);
            num_diag_lhs=k->get_num_vec_lhs();
            num_diag_rhs=k->get_num_vec_rhs();
            ASSERT(num_diag_lhs>0);
            ASSERT(num_diag_rhs>0);

            CFeatures* old_lhs=k->lhs;
            CFeatures* old_rhs=k->rhs;

            k->lhs=old_lhs;
            k->rhs=old_lhs;
            bool r1=alloc_and_compute_diag(k, diag_lhs, num_diag_lhs);

            k->lhs=old_rhs;
            k->rhs=old_rhs;
            bool r2=alloc_and_compute_diag(k, diag_rhs, num_diag_rhs);

            k->lhs=old_lhs;
            k->rhs=old_rhs;

            return r1 && r2;
        }

        inline virtual float64_t normalize(
            float64_t value, int32_t idx_lhs, int32_t idx_rhs)
        {
            float64_t diag_sum=diag_lhs[idx_lhs]*diag_rhs[idx_rhs];
            return 2*value/diag_sum;
        }

        inline virtual float64_t normalize_lhs(float64_t value, int32_t idx_lhs)
        {
            SG_ERROR("linadd not supported with Dice normalization.\n");
            return 0;
        }

        inline virtual float64_t normalize_rhs(float64_t value, int32_t idx_rhs)
        {
            SG_ERROR("linadd not supported with Dice normalization.\n");
            return 0;
        }

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

    public:
        bool alloc_and_compute_diag(CKernel* k, float64_t* &v, int32_t num)
        {
            SG_FREE(v);
            v=SG_MALLOC(float64_t, num);

            for (int32_t i=0; i<num; i++)
            {
                if (k->get_kernel_type() == K_COMMWORDSTRING)
                {
                    if (use_optimized_diagonal_computation)
                        v[i]=((CCommWordStringKernel*) k)->compute_diag(i);
                    else
                        v[i]=((CCommWordStringKernel*) k)->compute_helper(i,i, true);
                }
                else
                    v[i]=k->compute(i,i);

                if (v[i]==0.0)
                    v[i]=1e-16; /* avoid divide by zero exception */
            }

            return (v!=NULL);
        }

    protected:
        float64_t* diag_lhs;
        int32_t num_diag_lhs;

        float64_t* diag_rhs;
        int32_t num_diag_rhs;

        bool use_optimized_diagonal_computation;
};
}
#endif