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

Last change on this file since 15583 was 15583, checked in by swagner, 18 months ago

#2640: Updated year of copyrights in license headers

File size: 5.4 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;
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    protected ProblemDefinitionScript(string code)
58      : base(code) {
59      variableStore = new VariableStore();
60    }
61
62    IEncoding IProblemDefinition.Encoding {
63      get { return CompiledProblemDefinition.Encoding; }
64    }
65
66    private readonly object compileLock = new object();
67    private volatile IProblemDefinition compiledProblemDefinition;
68    protected IProblemDefinition CompiledProblemDefinition {
69      get {
70        // double checked locking pattern
71        if (compiledProblemDefinition == null) {
72          lock (compileLock) {
73            if (compiledProblemDefinition == null) {
74              if (codeChanged) throw new ProblemDefinitionScriptException("The code has been changed, but was not recompiled.");
75              Compile(false);
76            }
77          }
78        }
79        return compiledProblemDefinition;
80      }
81    }
82    public dynamic Instance {
83      get { return compiledProblemDefinition; }
84    }
85
86    public sealed override Assembly Compile() {
87      return Compile(true);
88    }
89
90    private Assembly Compile(bool fireChanged) {
91      var assembly = base.Compile();
92      var types = assembly.GetTypes();
93      if (!types.Any(x => typeof(CompiledProblemDefinition).IsAssignableFrom(x)))
94        throw new ProblemDefinitionScriptException("The compiled code doesn't contain a problem definition." + Environment.NewLine + "The problem definition must be a subclass of CompiledProblemDefinition.");
95      if (types.Count(x => typeof(CompiledProblemDefinition).IsAssignableFrom(x)) > 1)
96        throw new ProblemDefinitionScriptException("The compiled code contains multiple problem definitions." + Environment.NewLine + "Only one subclass of CompiledProblemDefinition is allowed.");
97
98      CompiledProblemDefinition inst;
99      try {
100        inst = (CompiledProblemDefinition)Activator.CreateInstance(types.Single(x => typeof(CompiledProblemDefinition).IsAssignableFrom(x)));
101      } catch (Exception e) {
102        compiledProblemDefinition = null;
103        throw new ProblemDefinitionScriptException("Instantiating the problem definition failed." + Environment.NewLine + "Check your default constructor.", e);
104      }
105
106      try {
107        inst.vars = new Variables(VariableStore);
108        inst.Initialize();
109      } catch (Exception e) {
110        compiledProblemDefinition = null;
111        throw new ProblemDefinitionScriptException("Initializing the problem definition failed." + Environment.NewLine + "Check your Initialize() method.", e);
112      }
113
114      try {
115        compiledProblemDefinition = inst;
116        if (fireChanged) OnProblemDefinitionChanged();
117      } catch (Exception e) {
118        compiledProblemDefinition = null;
119        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);
120      }
121
122      codeChanged = false;
123      return assembly;
124    }
125
126    protected override void OnCodeChanged() {
127      base.OnCodeChanged();
128      compiledProblemDefinition = null;
129      codeChanged = true;
130    }
131
132    public event EventHandler ProblemDefinitionChanged;
133    protected virtual void OnProblemDefinitionChanged() {
134      var handler = ProblemDefinitionChanged;
135      if (handler != null) handler(this, EventArgs.Empty);
136    }
137  }
138}
Note: See TracBrowser for help on using the repository browser.