Free cookie consent management tool by TermsFeed Policy Generator

source: branches/2965_CancelablePersistence/HeuristicLab.Optimization/3.3/Interfaces/ISolutionSimilarityCalculator.cs @ 16605

Last change on this file since 16605 was 15583, checked in by swagner, 7 years ago

#2640: Updated year of copyrights in license headers

File size: 2.7 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2018 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.Optimization {
26  /// <summary>
27  /// An interface which represents an operator for similarity calculation.
28  /// </summary>
29  public interface ISolutionSimilarityCalculator : IItem, IEqualityComparer<IScope> {
30    string SolutionVariableName { get; set; }
31    string QualityVariableName { get; set; }
32    bool ExecuteInParallel { get; set; }
33    int MaxDegreeOfParallelism { get; set; }
34
35    /// <summary>
36    /// Calculates the similarity of two solutions.
37    /// </summary>
38    /// <param name="leftSolution">The first scope that contains a solution.</param>
39    /// <param name="rightSolution">The second scope that contains a solution.</param>
40    /// <returns>A double between zero and one. Zero means the two solutions differ in every aspect, one indicates that the two solutions are the same.</returns>
41    double CalculateSolutionSimilarity(IScope leftSolution, IScope rightSolution);
42
43    /// <summary>
44    /// Calculates the similarity of solutions in one scope.
45    /// </summary>
46    /// <param name="solutionCrowd">The scope that contains solutions.</param>
47    /// <returns>A similarity matrix. Zero means the two solutions differ in every aspect, one indicates that the two solutions are the same.</returns>
48    double[][] CalculateSolutionCrowdSimilarity(IScope solutionCrowd);
49
50    /// <summary>
51    /// Calculates the similarity of solutions in two scopes.
52    /// </summary>
53    /// <param name="leftSolutionCrowd">The first scope that contains solutions.</param>
54    /// <param name="rightSolutionCrowd">The second scope that contains solutions.</param>
55    /// <returns>A similarity matrix. Zero means the two solutions differ in every aspect, one indicates that the two solutions are the same.</returns>
56    double[][] CalculateSolutionCrowdSimilarity(IScope leftSolutionCrowd, IScope rightSolutionCrowd);
57  }
58}
Note: See TracBrowser for help on using the repository browser.