/usr/include/shogun/converter/StochasticProximityEmbedding.h is in libshogun-dev 3.2.0-7.5.
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 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | /*
* 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) 2012-2013 Fernando José Iglesias García
* Copyright (C) 2012-2013 Fernando José Iglesias García
*/
#ifndef STOCHASTICPROXIMITYEMBEDDING_H_
#define STOCHASTICPROXIMITYEMBEDDING_H_
#include <shogun/lib/config.h>
#ifdef HAVE_EIGEN3
#include <shogun/converter/EmbeddingConverter.h>
#include <shogun/features/Features.h>
#include <shogun/distance/Distance.h>
namespace shogun
{
/** Stochastic Proximity Embedding (SPE) strategy */
enum ESPEStrategy
{
SPE_GLOBAL,
SPE_LOCAL,
};
/** @brief class StochasticProximityEmbedding used to construct embeddings of data using
* the Stochastic Proximity algorithm.
*
* Agrafiotis, D. K. (2002)
* Stochastic Proximity Embedding
* Retrieved from:
* http://www.dimitris-agrafiotis.com/Papers/jcc20078.pdf
*
* This class provides two different strategies for the computation of the embedding.
* In each iteration, both strategies choose two sets of feature vectors whose
* representation in the embedded space is updated. The first set is randomly chosen
* in both strategies. However, the second set is obtained differently depending on
* the strategy used. In the SPE_GLOBAL strategy, the second set is still
* chosen at random. On the other hand, if SPE_LOCAL is used, first of all, the
* K-Nearest Neighbors of each of the feature vectors in the first set is obtained
* and secondly, a number of feature vectors among these K-Nearest Neighbors is chosen
* to form the second set.
*
* The parameter K for K-Nearest Neighbors in SPE_LOCAL corresponds to the class member
* "m_k". Each of the two sets used on every iteration is formed by "m_nupdates" feature
* vectors. Therefore, the number of feature vectors given must be always at least two
* times the value of "m_nupdates".
*
* In order to avoid problems with memory in case a large number of features vectors is
* to be embedded, the distance matrix is never computed explicitily. This has the
* drawback that it is likely that the same distances are computed several times during
* the process.
*
* Uses implementation from the Tapkee library.
*
* Only CEuclideanDistance distance is supported for the moment.
*
*/
class CStochasticProximityEmbedding : public CEmbeddingConverter
{
public:
/** constructor */
CStochasticProximityEmbedding();
/** destructor */
virtual ~CStochasticProximityEmbedding();
/** apply to features
*
* @param features features to embed
* @return embedding features
*/
virtual CFeatures* apply(CFeatures* features);
/** setter for number of neighbors k in local strategy
*
* @param k k value
*/
void set_k(int32_t k);
/** getter for number of neighbors k in local strategy
*
* @return k value
*/
int32_t get_k() const;
/** setter for strategy parameter
*
* @param strategy type of SPE strategy
*/
void set_strategy(ESPEStrategy strategy);
/** getter for type of SPE strategy
*
* @return strategy value
*/
ESPEStrategy get_strategy() const;
/** setter for regularization parameter
*
* @param tolerance regularization value
*/
void set_tolerance(float32_t tolerance);
/** getter for regularization parameter
*
* @return regularization value
*/
int32_t get_tolerance() const;
/** setter for number of updates per iteration
*
* @param nupdates number of updates per SPE iteration
*/
void set_nupdates(int32_t nupdates);
/** getter for number of updates per iteration
*
* @return nupdates value
*/
int32_t get_nupdates() const;
/** setter for the maximum number of iterations
*
* @param max_iteration the maximum number of iterations
*/
void set_max_iteration(const int32_t max_iteration);
/** getter for the maximum number of iterations
*
* @return the maximum number of iterations
*/
int32_t get_max_iteration() const;
/** get name */
virtual const char* get_name() const;
private:
/** default init */
void init();
/** apply embedding to CDistance
* @param distance TODO Euclidean works fine, check with others
* @return new features in the embedded space
*/
virtual CDenseFeatures< float64_t >* embed_distance(CDistance* distance);
private:
/** SPE strategy */
ESPEStrategy m_strategy;
/** number of neighbours in local strategy */
int32_t m_k;
/** regularization parameter */
float32_t m_tolerance;
/** number of apdates per SPE iteration */
int32_t m_nupdates;
/** maximum number of iterations */
int32_t m_max_iteration;
};
} /* namespace shogun */
#endif /* HAVE_EIGEN3 */
#endif /* STOCHASTICPROXIMITYEMBEDDING_H_ */
|