source: trunk/sources/HeuristicLab.Problems.ExternalEvaluation/3.4/ExternalEvaluationProblem.cs @ 12504

Last change on this file since 12504 was 12504, checked in by mkommend, 5 years ago

#2025: Changed categories for all creatables.

File size: 7.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 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 System.Collections.Generic;
24using System.Drawing;
25using System.Linq;
26using System.Threading;
27using Google.ProtocolBuffers;
28using HeuristicLab.Analysis;
29using HeuristicLab.Common;
30using HeuristicLab.Core;
31using HeuristicLab.Data;
32using HeuristicLab.Optimization;
33using HeuristicLab.Parameters;
34using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
35
36namespace HeuristicLab.Problems.ExternalEvaluation {
37  [Item("External Evaluation Problem", "A problem that is evaluated in a different process.")]
38  [Creatable(CreatableAttribute.Categories.ExternalEvaluationProblems, Priority = 100)]
39  [StorableClass]
40  public sealed class ExternalEvaluationProblem : SingleObjectiveBasicProblem<IEncoding> {
41
42    public static new Image StaticItemImage {
43      get { return HeuristicLab.Common.Resources.VSImageLibrary.Type; }
44    }
45
46    #region Parameters
47    public OptionalValueParameter<EvaluationCache> CacheParameter {
48      get { return (OptionalValueParameter<EvaluationCache>)Parameters["Cache"]; }
49    }
50    public IValueParameter<CheckedItemCollection<IEvaluationServiceClient>> ClientsParameter {
51      get { return (IValueParameter<CheckedItemCollection<IEvaluationServiceClient>>)Parameters["Clients"]; }
52    }
53    public IValueParameter<SolutionMessageBuilder> MessageBuilderParameter {
54      get { return (IValueParameter<SolutionMessageBuilder>)Parameters["MessageBuilder"]; }
55    }
56    public IFixedValueParameter<SingleObjectiveOptimizationSupportScript> SupportScriptParameter {
57      get { return (IFixedValueParameter<SingleObjectiveOptimizationSupportScript>)Parameters["SupportScript"]; }
58    }
59    #endregion
60
61    #region Properties
62    public EvaluationCache Cache {
63      get { return CacheParameter.Value; }
64    }
65    public CheckedItemCollection<IEvaluationServiceClient> Clients {
66      get { return ClientsParameter.Value; }
67    }
68    public SolutionMessageBuilder MessageBuilder {
69      get { return MessageBuilderParameter.Value; }
70    }
71    public SingleObjectiveOptimizationSupportScript OptimizationSupportScript {
72      get { return SupportScriptParameter.Value; }
73    }
74    private ISingleObjectiveOptimizationSupport OptimizationSupport {
75      get { return SupportScriptParameter.Value; }
76    }
77    #endregion
78
79    [StorableConstructor]
80    private ExternalEvaluationProblem(bool deserializing) : base(deserializing) { }
81    private ExternalEvaluationProblem(ExternalEvaluationProblem original, Cloner cloner) : base(original, cloner) { }
82    public override IDeepCloneable Clone(Cloner cloner) {
83      return new ExternalEvaluationProblem(this, cloner);
84    }
85    public ExternalEvaluationProblem()
86      : base() {
87      Parameters.Remove("Maximization"); // readonly in base class
88      Parameters.Add(new FixedValueParameter<BoolValue>("Maximization", "Set to false if the problem should be minimized.", new BoolValue()));
89      Parameters.Add(new OptionalValueParameter<EvaluationCache>("Cache", "Cache of previously evaluated solutions."));
90      Parameters.Add(new ValueParameter<CheckedItemCollection<IEvaluationServiceClient>>("Clients", "The clients that are used to communicate with the external application.", new CheckedItemCollection<IEvaluationServiceClient>() { new EvaluationServiceClient() }));
91      Parameters.Add(new ValueParameter<SolutionMessageBuilder>("MessageBuilder", "The message builder that converts from HeuristicLab objects to SolutionMessage representation.", new SolutionMessageBuilder()));
92      Parameters.Add(new FixedValueParameter<SingleObjectiveOptimizationSupportScript>("SupportScript", "A script that can provide neighborhood and analyze the results of the optimization.", new SingleObjectiveOptimizationSupportScript()));
93
94      Operators.Add(new BestScopeSolutionAnalyzer());
95    }
96
97    #region Single Objective Problem Overrides
98    public override bool Maximization {
99      get { return Parameters.ContainsKey("Maximization") && ((IValueParameter<BoolValue>)Parameters["Maximization"]).Value.Value; }
100    }
101
102    public override double Evaluate(Individual individual, IRandom random) {
103      return Cache == null ? EvaluateOnNextAvailableClient(BuildSolutionMessage(individual)).Quality
104        : Cache.GetValue(BuildSolutionMessage(individual), m => EvaluateOnNextAvailableClient(m).Quality);
105    }
106
107    public override void Analyze(Individual[] individuals, double[] qualities, ResultCollection results, IRandom random) {
108      OptimizationSupport.Analyze(individuals, qualities, results, random);
109    }
110
111    public override IEnumerable<Individual> GetNeighbors(Individual individual, IRandom random) {
112      return OptimizationSupport.GetNeighbors(individual, random);
113    }
114    #endregion
115
116    #region Evaluation Helpers
117    private HashSet<IEvaluationServiceClient> activeClients = new HashSet<IEvaluationServiceClient>();
118    private object clientLock = new object();
119    private QualityMessage EvaluateOnNextAvailableClient(SolutionMessage message) {
120      IEvaluationServiceClient client = null;
121      lock (clientLock) {
122        client = Clients.CheckedItems.FirstOrDefault(c => !activeClients.Contains(c));
123        while (client == null && Clients.CheckedItems.Any()) {
124          Monitor.Wait(clientLock);
125          client = Clients.CheckedItems.FirstOrDefault(c => !activeClients.Contains(c));
126        }
127        if (client != null)
128          activeClients.Add(client);
129      }
130      try {
131        return client.Evaluate(message, GetQualityMessageExtensions());
132      }
133      finally {
134        lock (clientLock) {
135          activeClients.Remove(client);
136          Monitor.PulseAll(clientLock);
137        }
138      }
139    }
140
141    private ExtensionRegistry GetQualityMessageExtensions() {
142      return ExtensionRegistry.CreateInstance();
143    }
144
145    private SolutionMessage BuildSolutionMessage(Individual individual) {
146      lock (clientLock) {
147        SolutionMessage.Builder protobufBuilder = SolutionMessage.CreateBuilder();
148        protobufBuilder.SolutionId = 0;
149        var scope = new Scope();
150        individual.CopyToScope(scope);
151        foreach (var variable in scope.Variables) {
152          try {
153            MessageBuilder.AddToMessage(variable.Value, variable.Name, protobufBuilder);
154          }
155          catch (ArgumentException ex) {
156            throw new InvalidOperationException(string.Format("ERROR while building solution message: Parameter {0} cannot be added to the message", name), ex);
157          }
158        }
159        return protobufBuilder.Build();
160      }
161    }
162    #endregion
163  }
164}
Note: See TracBrowser for help on using the repository browser.