[14512] | 1 | #region License Information
|
---|
| 2 | /* HeuristicLab
|
---|
[17181] | 3 | * Copyright (C) Heuristic and Evolutionary Algorithms Laboratory (HEAL)
|
---|
[14512] | 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 |
|
---|
| 22 | using System;
|
---|
| 23 | using System.Collections.Generic;
|
---|
| 24 | using HeuristicLab.Common;
|
---|
| 25 | using HeuristicLab.Core;
|
---|
[17097] | 26 | using HEAL.Attic;
|
---|
[14512] | 27 |
|
---|
| 28 | namespace HeuristicLab.Algorithms.DataAnalysis {
|
---|
| 29 | /// <summary>
|
---|
[15249] | 30 | /// The angular distance as defined as a normalized distance measure dependent on the angle between two vectors.
|
---|
[14512] | 31 | /// </summary>
|
---|
[17097] | 32 | [StorableType("C87DE522-CB6D-485B-B2F7-6FE79B4E4DC6")]
|
---|
[15249] | 33 | [Item("CosineDistance", "The angular distance as defined as a normalized distance measure dependent on the angle between two vectors.")]
|
---|
[15207] | 34 | public class CosineDistance : DistanceBase<IEnumerable<double>> {
|
---|
| 35 | #region HLConstructors & Cloning
|
---|
[14512] | 36 | [StorableConstructor]
|
---|
[17097] | 37 | protected CosineDistance(StorableConstructorFlag _) : base(_) { }
|
---|
[15207] | 38 | protected CosineDistance(CosineDistance original, Cloner cloner)
|
---|
[14512] | 39 | : base(original, cloner) { }
|
---|
[15207] | 40 | public CosineDistance() { }
|
---|
[14512] | 41 | public override IDeepCloneable Clone(Cloner cloner) {
|
---|
[15207] | 42 | return new CosineDistance(this, cloner);
|
---|
[14512] | 43 | }
|
---|
| 44 | #endregion
|
---|
| 45 |
|
---|
| 46 | #region statics
|
---|
[15571] | 47 | public static double GetDistance(IEnumerable<double> point1, IEnumerable<double> point2) {
|
---|
| 48 | using (IEnumerator<double> p1Enum = point1.GetEnumerator(), p2Enum = point2.GetEnumerator()) {
|
---|
| 49 | var innerprod = 0.0;
|
---|
| 50 | var length1 = 0.0;
|
---|
| 51 | var length2 = 0.0;
|
---|
| 52 | while (p1Enum.MoveNext() & p2Enum.MoveNext()) {
|
---|
| 53 | double d1 = p1Enum.Current, d2 = p2Enum.Current;
|
---|
| 54 | innerprod += d1 * d2;
|
---|
| 55 | length1 += d1 * d1;
|
---|
| 56 | length2 += d2 * d2;
|
---|
| 57 | }
|
---|
| 58 | var divisor = Math.Sqrt(length1 * length2);
|
---|
| 59 | if (divisor.IsAlmost(0)) throw new ArgumentException("Cosine distance is not defined on vectors of length 0");
|
---|
| 60 | if (p1Enum.MoveNext() || p2Enum.MoveNext()) throw new ArgumentException("Cosine distance not defined on vectors of different length");
|
---|
| 61 | return 1 - innerprod / divisor;
|
---|
[14767] | 62 | }
|
---|
[14512] | 63 | }
|
---|
| 64 | #endregion
|
---|
[14767] | 65 | public override double Get(IEnumerable<double> a, IEnumerable<double> b) {
|
---|
[15571] | 66 | return GetDistance(a, b);
|
---|
[14512] | 67 | }
|
---|
| 68 | }
|
---|
[15571] | 69 | } |
---|