source: branches/HeuristicLab.ExternalEvaluation Scientific/HeuristicLab.Problems.ExternalEvaluation.Scilab/3.3/ScilabParameterVectorEvaluator.cs @ 9715

Last change on this file since 9715 was 9715, checked in by mkommend, 6 years ago

#2082: Updated external evaluation scientific branch to use the new HL data types.

File size: 6.7 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2013 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.IO;
24using System.Linq;
25using HeuristicLab.Common;
26using HeuristicLab.Core;
27using HeuristicLab.Data;
28using HeuristicLab.Parameters;
29using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
30using HeuristicLab.Problems.ParameterOptimization;
31
32namespace HeuristicLab.Problems.ExternalEvaluation.Scilab {
33  [Item("SciLabParameterVectorEvaluator", "An evaluator which takes a parameter vector and returns a quality value, calculated by a Scilab script.")]
34  [StorableClass]
35  public sealed class ScilabParameterVectorEvaluator : ParameterVectorEvaluator {
36    private const string QualityVariableParameterName = "QualityVariableName";
37    private const string ScilabEvaluationScriptParameterName = "ScilabEvaluationScript";
38    private const string InitializationScriptParameterName = "InitializationScript";
39
40    #region parameters
41    public ILookupParameter<StringValue> QualityVariableParameter {
42      get { return (ILookupParameter<StringValue>)Parameters[QualityVariableParameterName]; }
43    }
44    public ILookupParameter<TextFileValue> ScilabEvaluationScriptParameter {
45      get { return (ILookupParameter<TextFileValue>)Parameters[ScilabEvaluationScriptParameterName]; }
46    }
47    public IFixedValueParameter<TextFileValue> InitializationScriptParameter {
48      get { return (IFixedValueParameter<TextFileValue>)Parameters[InitializationScriptParameterName]; }
49    }
50    #endregion
51
52    public TextFileValue InitializationScript {
53      get { return InitializationScriptParameter.Value; }
54    }
55
56    [StorableConstructor]
57    private ScilabParameterVectorEvaluator(bool deserializing) : base(deserializing) { }
58    private ScilabParameterVectorEvaluator(ScilabParameterVectorEvaluator original, Cloner cloner)
59      : base(original, cloner) {
60    }
61    public override IDeepCloneable Clone(Cloner cloner) {
62      return new ScilabParameterVectorEvaluator(this, cloner);
63    }
64
65    public ScilabParameterVectorEvaluator()
66      : base() {
67      Parameters.Add(new LookupParameter<StringValue>(QualityVariableParameterName, "The name of the quality variable of the Scilab script."));
68      Parameters.Add(new LookupParameter<TextFileValue>(ScilabEvaluationScriptParameterName, "The path to the Scilab evaluation script."));
69      Parameters.Add(new FixedValueParameter<TextFileValue>(InitializationScriptParameterName, "The path to a Scilab script the should be execute before the evaluation starts.", new TextFileValue()));
70    }
71
72    [StorableHook(HookType.AfterDeserialization)]
73    private void AfterDeserialization() {
74      InitializeState();
75    }
76
77    public override void InitializeState() {
78      base.InitializeState();
79
80      if (string.IsNullOrEmpty(InitializationScript.Value)) return;
81      if (!InitializationScript.Exists()) throw new FileNotFoundException(string.Format("The initialization script \"{0}\" cannot be found.", InitializationScript.Value));
82      int result = DotNetScilab.Scilab.Instance.execScilabScript(InitializationScript.Value);
83      if (result != 0) ThrowSciLabException(InitializationScript.Value, result);
84    }
85
86    private readonly object locker = new object();
87    public override IOperation Apply() {
88      var evaluationScript = ScilabEvaluationScriptParameter.ActualValue;
89      if (string.IsNullOrEmpty(evaluationScript.Value)) throw new FileNotFoundException("The evaluation script in the problem is not set.");
90      if (!evaluationScript.Exists()) throw new FileNotFoundException(string.Format("The evaluation script \"{0}\" cannot be found.", evaluationScript.Value));
91
92      //Scilab is used via a c++ wrapper that calls static methods. Hence it is not possible to parallelize the evaluation.
93      lock (locker) {
94        int result;
95        var parameterVector = ParameterVectorParameter.ActualValue;
96        var parameterNames = ParameterNamesParameter.ActualValue;
97        if (parameterNames.Any(string.IsNullOrEmpty)) throw new ArgumentException("Not all parameter names are provided.");
98        var scilab = DotNetScilab.Scilab.Instance;
99
100        for (int i = 0; i < ProblemSizeParameter.ActualValue.Value; i++) {
101          result = scilab.createNamedMatrixOfDouble(parameterNames[i], 1, 1, new double[] { parameterVector[i] });
102          if (result != 0) throw new InvalidOperationException("Error while setting the parameter " + parameterNames[i] + " to " + parameterVector[i] + "  (ErrorCode: " + result + ").");
103        }
104
105        string script = ScilabEvaluationScriptParameter.ActualValue.Value;
106        result = scilab.execScilabScript(script);
107        if (result != 0) ThrowSciLabException(script, result);
108
109        string qualityVariableName = QualityVariableParameter.ActualValue.Value;
110        double[] values = scilab.readNamedMatrixOfDouble(qualityVariableName);
111        if (values == null) throw new InvalidOperationException(string.Format("Could not find the variable \"{0}\" in the Scilab workspace, that should hold the quality value.", qualityVariableName));
112        double quality = values[0];
113
114        if (double.IsNaN(quality)) quality = double.MaxValue;
115        if (double.IsInfinity(quality)) quality = double.MaxValue;
116
117        QualityParameter.ActualValue = new DoubleValue(quality);
118        return base.Apply();
119      }
120    }
121
122    private void ThrowSciLabException(string fileName, int errorCode) {
123      const string code = "errorMsg = lasterror();";
124      int result = DotNetScilab.Scilab.Instance.SendScilabJob(code);
125      if (result != 0) throw new InvalidOperationException(string.Format("An error occured during the execution of the Scilab script {0}.", fileName));
126
127      string errorMessage = DotNetScilab.Scilab.Instance.readNamedMatrixOfString("errorMsg")[0];
128
129      string message = string.Format("The error {1} occured during the execution of the Scilab script {0}. \r\n\r\n {2}", fileName, errorCode, errorMessage);
130      throw new InvalidOperationException(message);
131    }
132  }
133}
Note: See TracBrowser for help on using the repository browser.