Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Problems.Programmable/3.3/ProblemDefinitionScript.cs @ 11998

Last change on this file since 11998 was 11949, checked in by mkommend, 9 years ago

#2174: Distributed files in programmable problem branch to the correct plugins.

File size: 5.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2014 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.Linq;
24using System.Reflection;
25using HeuristicLab.Common;
26using HeuristicLab.Core;
27using HeuristicLab.Optimization;
28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
29using HeuristicLab.Scripting;
30
31namespace HeuristicLab.Problems.Programmable {
32  [Item("ProblemDefinitionScript", "Script that defines the parameter vector and evaluates the solution for a programmable problem.")]
33  [StorableClass]
34  public abstract class ProblemDefinitionScript : Script, IProblemDefinition {
35    protected bool SuppressEvents { get; set; }
36
37    [Storable]
38    private VariableStore variableStore;
39    public VariableStore VariableStore {
40      get { return variableStore; }
41    }
42
43    [Storable]
44    private bool codeChanged;
45
46    [StorableConstructor]
47    protected ProblemDefinitionScript(bool deserializing) : base(deserializing) { }
48    protected ProblemDefinitionScript(ProblemDefinitionScript original, Cloner cloner)
49      : base(original, cloner) {
50      variableStore = cloner.Clone(original.variableStore);
51      codeChanged = original.codeChanged;
52    }
53    protected ProblemDefinitionScript()
54      : base() {
55      variableStore = new VariableStore();
56    }
57
58    IEncoding IProblemDefinition.Encoding {
59      get { return CompiledProblemDefinition.Encoding; }
60    }
61
62    private readonly object compileLock = new object();
63    private volatile IProblemDefinition compiledProblemDefinition;
64    protected IProblemDefinition CompiledProblemDefinition {
65      get {
66        // double checked locking pattern
67        if (compiledProblemDefinition == null) {
68          lock (compileLock) {
69            if (compiledProblemDefinition == null) {
70              if (codeChanged) throw new ProblemDefinitionScriptException("The code has been changed, but was not recompiled.");
71              Compile(false);
72            }
73          }
74        }
75        return compiledProblemDefinition;
76      }
77    }
78
79    public sealed override Assembly Compile() {
80      return Compile(true);
81    }
82
83    private Assembly Compile(bool fireChanged) {
84      var assembly = base.Compile();
85      var types = assembly.GetTypes();
86      if (!types.Any(x => typeof(CompiledProblemDefinition).IsAssignableFrom(x)))
87        throw new ProblemDefinitionScriptException("The compiled code doesn't contain a problem definition." + Environment.NewLine + "The problem definition must be a subclass of CompiledProblemDefinition.");
88      if (types.Count(x => typeof(CompiledProblemDefinition).IsAssignableFrom(x)) > 1)
89        throw new ProblemDefinitionScriptException("The compiled code contains multiple problem definitions." + Environment.NewLine + "Only one subclass of CompiledProblemDefinition is allowed.");
90
91      CompiledProblemDefinition inst;
92      try {
93        inst = (CompiledProblemDefinition)Activator.CreateInstance(types.Single(x => typeof(CompiledProblemDefinition).IsAssignableFrom(x)));
94      } catch (Exception e) {
95        compiledProblemDefinition = null;
96        throw new ProblemDefinitionScriptException("Instantiating the problem definition failed." + Environment.NewLine + "Check your default constructor.", e);
97      }
98
99      try {
100        inst.vars = new Variables(VariableStore);
101        inst.Initialize();
102      } catch (Exception e) {
103        compiledProblemDefinition = null;
104        throw new ProblemDefinitionScriptException("Initializing the problem definition failed." + Environment.NewLine + "Check your Initialize() method.", e);
105      }
106
107      try {
108        compiledProblemDefinition = inst;
109        if (fireChanged) OnProblemDefinitionChanged();
110      } catch (Exception e) {
111        compiledProblemDefinition = null;
112        throw new ProblemDefinitionScriptException("Using the problem definition in the problem failed." + Environment.NewLine + "Examine this error message carefully (often there is an issue with the defined encoding).", e);
113      }
114
115      codeChanged = false;
116      return assembly;
117    }
118
119    protected override void OnCodeChanged() {
120      base.OnCodeChanged();
121      compiledProblemDefinition = null;
122      codeChanged = true;
123    }
124
125    public event EventHandler ProblemDefinitionChanged;
126    protected virtual void OnProblemDefinitionChanged() {
127      var handler = ProblemDefinitionChanged;
128      if (handler != null) handler(this, EventArgs.Empty);
129    }
130  }
131}
Note: See TracBrowser for help on using the repository browser.