Free cookie consent management tool by TermsFeed Policy Generator

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

Last change on this file since 9682 was 9682, checked in by mkommend, 11 years ago

#2082: Added new plugins for parameter optimization and external evaluation in Scilab.

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