/usr/include/shogun/kernel/KernelNormalizer.h is in libshogun-dev 1.1.0-4ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | /*
* 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) 2008-2009 Soeren Sonnenburg
* Copyright (C) 2008-2009 Fraunhofer Institute FIRST and Max-Planck-Society
*/
#ifndef _KERNELNORMALIZER_H___
#define _KERNELNORMALIZER_H___
#include <shogun/kernel/Kernel.h>
#include <shogun/base/Parameter.h>
namespace shogun
{
/** normalizer type */
enum ENormalizerType
{
N_REGULAR = 0,
N_MULTITASK = 1
};
class CKernel;
/** @brief The class Kernel Normalizer defines a function to post-process kernel values.
*
* Formally it defines f(.,.,.)
*
* \f[
* k'({\bf x},{\bf x'}) = f(k({\bf x},{\bf x'}),{\bf x},{\bf x'})
* \f]
*
* examples for f(.,.,.) would be scaling with a constant
*
* \f[
* f(k({\bf x},{\bf x'}), ., .)= \frac{1}{c}\cdot k({\bf x},{\bf x'})
* \f]
*
* as can be found in class CAvgDiagKernelNormalizer, the identity (cf.
* CIdentityKernelNormalizer), dividing by the Square Root of the product of
* the diagonal elements which effectively normalizes the vectors in feature
* space to norm 1 (see CSqrtDiagKernelNormalizer)
*
* \f[
* k'({\bf x},{\bf x'}) = \frac{k({\bf x},{\bf x'})}{\sqrt{k({\bf x},{\bf x})k({\bf x'},{\bf x'})}}
* \f]
*/
class CKernelNormalizer : public CSGObject
{
public:
/** default constructor
*/
CKernelNormalizer() : CSGObject()
{
register_params();
m_type = N_REGULAR;
}
/** default destructor */
virtual ~CKernelNormalizer() { }
/** initialization of the normalizer (if needed)
* @param k kernel */
virtual bool init(CKernel* k)=0;
/** normalize the kernel value
* @param value kernel value
* @param idx_lhs index of left hand side vector
* @param idx_rhs index of right hand side vector
*/
virtual float64_t normalize(
float64_t value, int32_t idx_lhs, int32_t idx_rhs)=0;
/** normalize only the left hand side vector
* @param value value of a component of the left hand side feature vector
* @param idx_lhs index of left hand side vector
*/
virtual float64_t normalize_lhs(float64_t value, int32_t idx_lhs)=0;
/** normalize only the right hand side vector
* @param value value of a component of the right hand side feature vector
* @param idx_rhs index of right hand side vector
*/
virtual float64_t normalize_rhs(float64_t value, int32_t idx_rhs)=0;
/** register the parameters
*/
virtual void register_params()
{
m_parameters->add((machine_int_t*) &m_type, "m_type","Normalizer type.");
}
/** getter for normalizer type
*/
ENormalizerType get_normalizer_type()
{
return m_type;
}
/** setter for normalizer type
* @param type type of normalizer
*/
void set_normalizer_type(ENormalizerType type)
{
m_type = type;
}
protected:
/** normalizer type */
ENormalizerType m_type;
};
}
#endif
|