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