File: DiffusionRateFunction.h

package info (click to toggle)
tulip 4.8.0dfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 179,264 kB
  • ctags: 64,517
  • sloc: cpp: 600,444; ansic: 36,311; makefile: 22,136; python: 1,304; sh: 946; yacc: 522; xml: 337; pascal: 157; php: 66; lex: 55
file content (52 lines) | stat: -rw-r--r-- 2,200 bytes parent folder | download | duplicates (2)
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
/**
 *
 * This file is part of Tulip (www.tulip-software.org)
 *
 * Authors: David Auber and the Tulip development Team
 * from LaBRI, University of Bordeaux
 *
 * Tulip is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tulip is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 */

#ifndef NEIGHBORHOODDECREASINGFUNCTION_H_
#define NEIGHBORHOODDECREASINGFUNCTION_H_

#include "TimeDecreasingFunction.h"

/**
 * @brief Interface for distance rate computation functions.
 * Interface for distance rate computation functions. Distance rate is used in learning rate computation to handle the distance factor.
 * These objects take a TimeDecreasingFunction as the diffusion coefficient evolve with distance but also with time.
 * See SOM algorithm for more details on time coefficient in SOM computation.
 */
class DiffusionRateFunction {
public:
  DiffusionRateFunction(TimeDecreasingFunction* decreasingFunction);
  virtual ~DiffusionRateFunction();
  /**
   * Compute the diffusion rate in function of the current time and the distance.
   * @param distance The distance between the BMU and the node. This distance is the number of node to go through from BMU to current node.
   * @param currentIteration The current iteration number.
   * @param maxIteration The maximum iteration number.
   * @param inputSampleSize The sample size.
   * @return the diffusion rate.
   */
  virtual double computeSpaceRate(unsigned int distance,
                                  unsigned int currentIteration, unsigned int maxIteration,
                                  unsigned int inputSampleSize) = 0;
  TimeDecreasingFunction* getTimeDecreasingFunction();
  void setTimeDecreasingFunction(TimeDecreasingFunction* timeFunction);
protected:
  TimeDecreasingFunction *timeFunction;
};

#endif /* NEIGHBORHOODDECREASINGFUNCTION_H_ */