1 | #region License Information
|
---|
2 | /* HeuristicLab
|
---|
3 | * Copyright (C) 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 |
|
---|
22 | using System;
|
---|
23 | using System.Collections.Generic;
|
---|
24 | using System.Linq;
|
---|
25 | using System.Threading;
|
---|
26 | using HEAL.Attic;
|
---|
27 | using HeuristicLab.Analysis;
|
---|
28 | using HeuristicLab.Common;
|
---|
29 | using HeuristicLab.Core;
|
---|
30 | using HeuristicLab.Data;
|
---|
31 | using HeuristicLab.Encodings.RealVectorEncoding;
|
---|
32 | using HeuristicLab.Optimization;
|
---|
33 | using HeuristicLab.Parameters;
|
---|
34 | using HeuristicLab.Problems.Instances;
|
---|
35 |
|
---|
36 | namespace HeuristicLab.Problems.TestFunctions {
|
---|
37 | [Item("Test Function (single-objective)", "Test function with real valued inputs and a single objective.")]
|
---|
38 | [StorableType("F0AB7236-2C9B-49DC-9D4F-A3558FD9E992")]
|
---|
39 | [Creatable(CreatableAttribute.Categories.Problems, Priority = 90)]
|
---|
40 | public sealed class SingleObjectiveTestFunctionProblem : RealVectorProblem,
|
---|
41 | IProblemInstanceConsumer<SOTFData> {
|
---|
42 |
|
---|
43 | #region Parameter Properties
|
---|
44 | public OptionalValueParameter<RealVector> BestKnownSolutionParameter {
|
---|
45 | get { return (OptionalValueParameter<RealVector>)Parameters["BestKnownSolution"]; }
|
---|
46 | }
|
---|
47 | public IValueParameter<ISingleObjectiveTestFunction> TestFunctionParameter {
|
---|
48 | get { return (IValueParameter<ISingleObjectiveTestFunction>)Parameters["TestFunction"]; }
|
---|
49 | }
|
---|
50 | #endregion
|
---|
51 |
|
---|
52 | #region Properties
|
---|
53 | public ISingleObjectiveTestFunction TestFunction {
|
---|
54 | get { return TestFunctionParameter.Value; }
|
---|
55 | set { TestFunctionParameter.Value = value; }
|
---|
56 | }
|
---|
57 | #endregion
|
---|
58 |
|
---|
59 | [StorableConstructor]
|
---|
60 | private SingleObjectiveTestFunctionProblem(StorableConstructorFlag _) : base(_) { }
|
---|
61 | private SingleObjectiveTestFunctionProblem(SingleObjectiveTestFunctionProblem original, Cloner cloner)
|
---|
62 | : base(original, cloner) {
|
---|
63 | RegisterEventHandlers();
|
---|
64 | }
|
---|
65 | public SingleObjectiveTestFunctionProblem()
|
---|
66 | : base(new RealVectorEncoding("Point")) {
|
---|
67 | Parameters.Add(new OptionalValueParameter<RealVector>("BestKnownSolution", "The best known solution for this test function instance."));
|
---|
68 | Parameters.Add(new ValueParameter<ISingleObjectiveTestFunction>("TestFunction", "The function that is to be optimized.", new Ackley()));
|
---|
69 | Maximization = TestFunction.Maximization;
|
---|
70 |
|
---|
71 | BestKnownQuality = TestFunction.BestKnownQuality;
|
---|
72 |
|
---|
73 | InitializeOperators();
|
---|
74 | RegisterEventHandlers();
|
---|
75 | }
|
---|
76 |
|
---|
77 | public override IDeepCloneable Clone(Cloner cloner) {
|
---|
78 | return new SingleObjectiveTestFunctionProblem(this, cloner);
|
---|
79 | }
|
---|
80 |
|
---|
81 | [StorableHook(HookType.AfterDeserialization)]
|
---|
82 | private void AfterDeserialization() {
|
---|
83 | RegisterEventHandlers();
|
---|
84 | }
|
---|
85 |
|
---|
86 | private void RegisterEventHandlers() {
|
---|
87 | Evaluator.QualityParameter.ActualNameChanged += Evaluator_QualityParameter_ActualNameChanged;
|
---|
88 | TestFunctionParameter.ValueChanged += TestFunctionParameterOnValueChanged;
|
---|
89 | }
|
---|
90 |
|
---|
91 | public override ISingleObjectiveEvaluationResult Evaluate(RealVector individual, IRandom random, CancellationToken cancellationToken) {
|
---|
92 | var quality = TestFunction.Evaluate(individual);
|
---|
93 | return new SingleObjectiveEvaluationResult(quality);
|
---|
94 | }
|
---|
95 |
|
---|
96 | public override void Analyze(RealVector[] realVectors, double[] qualities, ResultCollection results, IRandom random) {
|
---|
97 | var best = GetBestSolution(realVectors, qualities);
|
---|
98 |
|
---|
99 | DoubleValue bestKnownQuality = BestKnownQualityParameter.Value;
|
---|
100 | RealVector bestKnownSolution = null;
|
---|
101 | var bestKnownUpdate = bestKnownQuality == null || IsBetter(best.Item2, bestKnownQuality.Value);
|
---|
102 | if (bestKnownUpdate) {
|
---|
103 | if (bestKnownQuality != null) bestKnownQuality.Value = best.Item2;
|
---|
104 | else BestKnownQualityParameter.Value = bestKnownQuality = new DoubleValue(best.Item2);
|
---|
105 | BestKnownSolutionParameter.Value = bestKnownSolution = (RealVector)best.Item1.Clone();
|
---|
106 | }
|
---|
107 |
|
---|
108 | SingleObjectiveTestFunctionSolution solution = null;
|
---|
109 | if (results.TryGetValue("Best Solution", out var res)) {
|
---|
110 | solution = (SingleObjectiveTestFunctionSolution)res.Value;
|
---|
111 | if (IsBetter(best.Item2, solution.BestQuality.Value)) {
|
---|
112 | solution.BestRealVector = (RealVector)best.Item1.Clone();
|
---|
113 | solution.BestQuality = new DoubleValue(best.Item2);
|
---|
114 | }
|
---|
115 | } else {
|
---|
116 | solution = new SingleObjectiveTestFunctionSolution((RealVector)best.Item1.Clone(),
|
---|
117 | new DoubleValue(best.Item2),
|
---|
118 | TestFunctionParameter.Value) {
|
---|
119 | BestKnownRealVector = bestKnownSolution,
|
---|
120 | Bounds = BoundsParameter.Value
|
---|
121 | };
|
---|
122 | results.Add(new Result("Best Solution", solution));
|
---|
123 | }
|
---|
124 | if (best.Item1.Length == 2) solution.Population = new ItemArray<RealVector>(realVectors.Select(x => (RealVector)x.Clone()));
|
---|
125 | if (bestKnownUpdate) solution.BestKnownRealVector = bestKnownSolution;
|
---|
126 | }
|
---|
127 |
|
---|
128 | #region Events
|
---|
129 | protected override void OnEncodingChanged() {
|
---|
130 | base.OnEncodingChanged();
|
---|
131 | Parameterize();
|
---|
132 | }
|
---|
133 | protected override void OnEvaluatorChanged() {
|
---|
134 | base.OnEvaluatorChanged();
|
---|
135 | Evaluator.QualityParameter.ActualNameChanged += Evaluator_QualityParameter_ActualNameChanged;
|
---|
136 | Parameterize();
|
---|
137 | }
|
---|
138 | protected override void DimensionOnChanged() {
|
---|
139 | base.DimensionOnChanged();
|
---|
140 | if (Dimension < TestFunction.MinimumProblemSize || Dimension > TestFunction.MaximumProblemSize)
|
---|
141 | Dimension = Math.Min(TestFunction.MaximumProblemSize, Math.Max(TestFunction.MinimumProblemSize, Dimension));
|
---|
142 | }
|
---|
143 | protected override void BoundsOnChanged() {
|
---|
144 | base.BoundsOnChanged();
|
---|
145 | Parameterize();
|
---|
146 | }
|
---|
147 | private void Evaluator_QualityParameter_ActualNameChanged(object sender, EventArgs e) {
|
---|
148 | Parameterize();
|
---|
149 | }
|
---|
150 | private void TestFunctionParameterOnValueChanged(object sender, EventArgs eventArgs) {
|
---|
151 | var problemSizeChange = Dimension < TestFunction.MinimumProblemSize
|
---|
152 | || Dimension > TestFunction.MaximumProblemSize;
|
---|
153 | if (problemSizeChange) {
|
---|
154 | Dimension = Math.Max(TestFunction.MinimumProblemSize, Math.Min(Dimension, TestFunction.MaximumProblemSize));
|
---|
155 | }
|
---|
156 | BestKnownQuality = TestFunction.BestKnownQuality;
|
---|
157 | Bounds = (DoubleMatrix)TestFunction.Bounds.Clone();
|
---|
158 | var bestSolution = TestFunction.GetBestKnownSolution(Dimension);
|
---|
159 | BestKnownSolutionParameter.Value = bestSolution;
|
---|
160 | Maximization = TestFunction.Maximization;
|
---|
161 |
|
---|
162 | OnReset();
|
---|
163 | }
|
---|
164 | #endregion
|
---|
165 |
|
---|
166 | #region Helpers
|
---|
167 | private void InitializeOperators() {
|
---|
168 | Operators.Add(new SingleObjectiveTestFunctionImprovementOperator());
|
---|
169 | Operators.Add(new SingleObjectiveTestFunctionPathRelinker());
|
---|
170 | Operators.Add(new SingleObjectiveTestFunctionSimilarityCalculator());
|
---|
171 | Operators.Add(new EuclideanSimilarityCalculator());
|
---|
172 | Operators.Add(new AdditiveMoveEvaluator());
|
---|
173 |
|
---|
174 | Parameterize();
|
---|
175 | }
|
---|
176 |
|
---|
177 | private void Parameterize() {
|
---|
178 | var operators = new List<IItem>();
|
---|
179 | foreach (var op in Operators.OfType<PopulationSimilarityAnalyzer>()) {
|
---|
180 | var calcs = Operators.OfType<ISolutionSimilarityCalculator>().ToArray();
|
---|
181 | op.SimilarityCalculatorParameter.ValidValues.Clear();
|
---|
182 | foreach (var c in calcs) {
|
---|
183 | // TODO: unified encoding parameters
|
---|
184 | c.SolutionVariableName = ((IRealVectorSolutionOperator)Encoding.SolutionCreator).RealVectorParameter.ActualName;
|
---|
185 | c.QualityVariableName = Evaluator.QualityParameter.ActualName;
|
---|
186 | op.SimilarityCalculatorParameter.ValidValues.Add(c);
|
---|
187 | }
|
---|
188 | }
|
---|
189 | foreach (var op in Operators.OfType<ISingleObjectiveTestFunctionAdditiveMoveEvaluator>()) {
|
---|
190 | operators.Add(op);
|
---|
191 | op.QualityParameter.ActualName = Evaluator.QualityParameter.ActualName;
|
---|
192 | op.QualityParameter.Hidden = true;
|
---|
193 | foreach (var movOp in Encoding.Operators.OfType<IRealVectorAdditiveMoveQualityOperator>())
|
---|
194 | movOp.MoveQualityParameter.ActualName = op.MoveQualityParameter.ActualName;
|
---|
195 | }
|
---|
196 | foreach (var op in Operators.OfType<IRealVectorParticleCreator>()) {
|
---|
197 | // TODO: unified encoding parameters
|
---|
198 | op.RealVectorParameter.ActualName = ((IRealVectorSolutionOperator)Encoding.SolutionCreator).RealVectorParameter.ActualName;
|
---|
199 | op.RealVectorParameter.Hidden = true;
|
---|
200 | op.BoundsParameter.ActualName = BoundsParameter.Name;
|
---|
201 | op.BoundsParameter.Hidden = true;
|
---|
202 | }
|
---|
203 | foreach (var op in Operators.OfType<IRealVectorParticleUpdater>()) {
|
---|
204 | // TODO: unified encoding parameters
|
---|
205 | op.RealVectorParameter.ActualName = ((IRealVectorSolutionOperator)Encoding.SolutionCreator).RealVectorParameter.ActualName;
|
---|
206 | op.RealVectorParameter.Hidden = true;
|
---|
207 | op.BoundsParameter.ActualName = BoundsParameter.Name;
|
---|
208 | op.BoundsParameter.Hidden = true;
|
---|
209 | }
|
---|
210 | foreach (var op in Operators.OfType<IRealVectorSwarmUpdater>()) {
|
---|
211 | op.MaximizationParameter.ActualName = MaximizationParameter.Name;
|
---|
212 | op.MaximizationParameter.Hidden = true;
|
---|
213 | }
|
---|
214 | foreach (var op in Operators.OfType<ISingleObjectiveImprovementOperator>()) {
|
---|
215 | operators.Add(op);
|
---|
216 | op.SolutionParameter.ActualName = Encoding.Name;
|
---|
217 | op.SolutionParameter.Hidden = true;
|
---|
218 | }
|
---|
219 | foreach (var op in Operators.OfType<ITestFunctionSolutionSimilarityCalculator>()) {
|
---|
220 | operators.Add(op);
|
---|
221 | op.SolutionVariableName = Encoding.Name;
|
---|
222 | op.QualityVariableName = Evaluator.QualityParameter.ActualName;
|
---|
223 | op.Bounds = Bounds;
|
---|
224 | }
|
---|
225 |
|
---|
226 | if (operators.Count > 0) Encoding.ConfigureOperators(operators);
|
---|
227 | }
|
---|
228 | #endregion
|
---|
229 |
|
---|
230 | public void Load(SOTFData data) {
|
---|
231 | Name = data.Name;
|
---|
232 | Description = data.Description;
|
---|
233 | TestFunction = data.TestFunction;
|
---|
234 | }
|
---|
235 | }
|
---|
236 | }
|
---|