/usr/include/shogun/distance/KernelDistance.h is in libshogun-dev 3.2.0-7.3build4.
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 | /*
* 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) 2010 Christian Widmer
* Copyright (C) 2010 Max-Planck-Society
*/
#include <shogun/lib/config.h>
#ifndef _KERNELDISTANCE_H___
#define _KERNELDISTANCE_H___
#include <shogun/lib/common.h>
#include <shogun/distance/Distance.h>
#include <shogun/kernel/Kernel.h>
namespace shogun
{
class CDistance;
/** @brief The Kernel distance takes a distance as input.
*
* It turns a kernel into something distance like by computing
*
* \f[
* d({\bf x}, {\bf x'}) = e^{-\frac{k({\bf x}, {\bf x'})}{width}}
* \f]
*/
class CKernelDistance: public CDistance
{
public:
/** default constructor */
CKernelDistance();
/** constructor
*
* @param width width
* @param k kernel
*/
CKernelDistance(float64_t width, CKernel* k);
/** constructor
*
* @param l features of left-hand side
* @param r features of right-hand side
* @param width width
* @param k kernel
*/
CKernelDistance(
CFeatures *l, CFeatures *r, float64_t width, CKernel* k);
/** destructor */
virtual ~CKernelDistance();
/** initialize kernel
*
* @param l features of left-hand side
* @param r features of right-hand side
* @return if initializing was successful
*/
virtual bool init(CFeatures* l, CFeatures* r);
/** return what type of kernel we are
*
* @return distance type DISTANCE
*/
virtual EDistanceType get_distance_type() { return D_UNKNOWN; }
/** return feature type the distance can deal with
*
* @return feature type of distance used
*/
virtual EFeatureType get_feature_type() { return kernel->get_feature_type(); }
/** return feature class the distance can deal with
*
* @return feature class of distance used
*/
virtual EFeatureClass get_feature_class() { return kernel->get_feature_class(); }
/** return the distances's name
*
* @return name Distance
*/
virtual const char* get_name() const { return "KernelDistance"; }
/** clean up kernel
*
*/
virtual void cleanup() { if (kernel) kernel->cleanup(); }
protected:
/** compute kernel function for features a and b
* idx_{a,b} denote the index of the feature vectors
* in the corresponding feature object
*
* @param idx_a index a
* @param idx_b index b
* @return computed kernel function at indices a,b
*/
float64_t compute(int32_t idx_a, int32_t idx_b);
private:
void init();
private:
/** kernel */
CKernel* kernel;
/** width */
float64_t width;
};
}
#endif /* _KERNELDISTANCE_H__ */
|