/usr/include/shogun/distance/CosineDistance.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 | /*
* 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 Christian Gehl
* Copyright (C) 2008-2009 Fraunhofer Institute FIRST
*/
#ifndef _COSINEDISTANCE_H___
#define _COSINEDISTANCE_H___
#include <shogun/lib/common.h>
#include <shogun/distance/DenseDistance.h>
namespace shogun
{
/** @brief class CosineDistance
*
* The Cosine distance is obtained by using the Cosine similarity (Orchini
* similarity, angular similarity, normalized dot product), which
* measures similarity between two vectors by finding their angle.
* An extension to the Cosine similarity yields the Tanimoto coefficient.
*
* \f[\displaystyle
* d(\bf{x},\bf{x'}) = 1 - \frac{\sum_{i=1}^{n}\bf{x_{i}}\bf{x'_{i}}}
* {\sqrt{\sum_{i=1}^{n} x_{i}^2 \sum_{i=1}^{n} {x'}_{i}^2}} \quad x,x' \in R^{n}
* \f]
*
* @see <a href="http://en.wikipedia.org/wiki/Cosine_similarity"> Wikipedia:
* Cosine similarity </a>
* @see CTanimotoDistance
*/
class CCosineDistance: public CDenseDistance<float64_t>
{
public:
/** default constructor */
CCosineDistance();
/** constructor
*
* @param l features of left-hand side
* @param r features of right-hand side
*/
CCosineDistance(CDenseFeatures<float64_t>* l, CDenseFeatures<float64_t>* r);
virtual ~CCosineDistance();
/** init distance
*
* @param l features of left-hand side
* @param r features of right-hand side
* @return if init was successful
*/
virtual bool init(CFeatures* l, CFeatures* r);
/** cleanup distance */
virtual void cleanup();
/** get distance type we are
*
* @return distance type COSINE
*/
virtual EDistanceType get_distance_type() { return D_COSINE; }
/** get name of the distance
*
* @return name Cosine distance
*/
virtual const char* get_name() const { return "CosineDistance"; }
protected:
/// compute distance for features a and b
/// idx_{a,b} denote the index of the feature vectors
/// in the corresponding feature object
virtual float64_t compute(int32_t idx_a, int32_t idx_b);
};
} // namespace shogun
#endif /* _COSINEDISTANCE_H___ */
|