Free cookie consent management tool by TermsFeed Policy Generator

source: branches/TSNE/HeuristicLab.Algorithms.DataAnalysis/3.4/Interfaces/TSNEInterfaces/IDistance.cs @ 14512

Last change on this file since 14512 was 14512, checked in by bwerth, 7 years ago

#2700 worked in several comments from mkommend, extended analysis during algorithm run, added more Distances, made algorithm stoppable

File size: 2.1 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2016 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System.Collections.Generic;
23using HeuristicLab.Core;
24
25namespace HeuristicLab.Algorithms.DataAnalysis {
26  public interface IDistance<in T> : IItem {
27    /// <summary>
28    /// Calculates a distance measure between two arbitrary Vectors. The distance value d is
29    /// 1.) positive  d(x,y)>=0
30    /// 2.) symmetric d(x,y) = d(y,x)
31    /// 3.) zero-reflexive d(x,x) =0;
32    /// </summary>
33    /// <param name="a">an array representing point x</param>
34    /// <param name="b">>an array representing point y</param>
35    /// <returns>d(x,y)</returns>
36    double Get(T a, T b);
37
38    /// <summary>
39    /// Calculates the correct kernel measure if it is smaller than threshold, but any value greater then threshold if the correct distance is greater.
40    /// This is for performace only
41    /// </summary>
42    /// <param name="a"></param>
43    /// <param name="b"></param>
44    /// <param name="threshold"></param>
45    /// <returns></returns>
46    double Get(T a, T b, double threshold);
47
48    /// <summary>
49    /// Returns a comparator wich compares the distances to item. (allows for sorting nearest/farthest neighbours)
50    /// </summary>
51    /// <param name="item"></param>
52    /// <returns></returns>
53    IComparer<T> GetDistanceComparer(T item);
54  }
55}
Note: See TracBrowser for help on using the repository browser.