Free cookie consent management tool by TermsFeed Policy Generator

source: branches/2520_PersistenceReintegration/HeuristicLab.Problems.QuadraticAssignment/3.3/QAPSimilarityCalculator.cs @ 16453

Last change on this file since 16453 was 16453, checked in by jkarder, 6 years ago

#2520: updated year of copyrights

File size: 3.5 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2019 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;
23using HeuristicLab.Common;
24using HeuristicLab.Core;
25using HeuristicLab.Data;
26using HeuristicLab.Encodings.PermutationEncoding;
27using HeuristicLab.Optimization.Operators;
28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
29
30namespace HeuristicLab.Problems.QuadraticAssignment {
31  /// <summary>
32  /// An operator that performs similarity calculation between two quadratic assignment solutions.
33  /// </summary>
34  /// <remarks>
35  /// The operator calculates the similarity based on the number of edges the two solutions have in common.
36  /// </remarks>
37  [Item("QAPSimilarityCalculator", "An operator that performs similarity calculation between two quadratic assignment solutions. The operator calculates the similarity based on the number of edges the two solutions have in common.")]
38  [StorableClass]
39  public sealed class QAPSimilarityCalculator : SingleObjectiveSolutionSimilarityCalculator {
40    protected override bool IsCommutative { get { return true; } }
41
42    [Storable]
43    public DoubleMatrix Weights { get; set; }
44    [Storable]
45    public DoubleMatrix Distances { get; set; }
46
47    private QAPSimilarityCalculator(bool deserializing) : base(deserializing) { }
48    private QAPSimilarityCalculator(QAPSimilarityCalculator original, Cloner cloner)
49      : base(original, cloner) {
50      Weights = cloner.Clone(original.Weights);
51      Distances = cloner.Clone(original.Distances);
52    }
53    public QAPSimilarityCalculator() : base() { }
54
55    public override IDeepCloneable Clone(Cloner cloner) {
56      return new QAPSimilarityCalculator(this, cloner);
57    }
58
59    public static double CalculateSimilarity(Permutation left, Permutation right, DoubleMatrix weights, DoubleMatrix distances) {
60      if (left == null || right == null)
61        throw new ArgumentException("Cannot calculate similarity because one of the provided solutions or both are null.");
62      if (left.Length != right.Length)
63        throw new ArgumentException("Cannot calculate similarity because the provided solutions have different lengths.");
64      if (left.Length == 0)
65        throw new ArgumentException("Cannot calculate similarity because solutions are of length 0.");
66      if (ReferenceEquals(left, right)) return 1.0;
67
68      return QAPPermutationProximityCalculator.CalculatePhenotypeSimilarity(left, right, weights, distances);
69    }
70
71    public override double CalculateSolutionSimilarity(IScope leftSolution, IScope rightSolution) {
72      var sol1 = leftSolution.Variables[SolutionVariableName].Value as Permutation;
73      var sol2 = rightSolution.Variables[SolutionVariableName].Value as Permutation;
74
75      return CalculateSimilarity(sol1, sol2, Weights, Distances);
76    }
77  }
78}
Note: See TracBrowser for help on using the repository browser.