source: branches/2936_GQAPIntegration/HeuristicLab.Encodings.IntegerVectorEncoding/3.3/IntegerVectorCreator.cs @ 16710

Last change on this file since 16710 was 16710, checked in by gkronber, 3 months ago

#2936: merged r15682 & r16117:16658 from trunk/HeuristicLab.Encodings.IntegerVectorEncoding to branch/HeuristicLab.Encodings.IntegerVectorEncoding

File size: 4.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2019 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 HeuristicLab.Common;
23using HeuristicLab.Core;
24using HeuristicLab.Data;
25using HeuristicLab.Operators;
26using HeuristicLab.Optimization;
27using HeuristicLab.Parameters;
28using HEAL.Attic;
29
30namespace HeuristicLab.Encodings.IntegerVectorEncoding {
31  /// <summary>
32  /// A base class for operators creating int-valued vectors.
33  /// </summary>
34  [Item("IntegerVectorCreator", "A base class for operators creating int-valued vectors.")]
35  [StorableType("3C20D629-EFCB-4A1C-81B4-1DF0942B27F7")]
36  public abstract class IntegerVectorCreator : InstrumentedOperator, IIntegerVectorCreator, IStochasticOperator {
37    public override bool CanChangeName {
38      get { return false; }
39    }
40    public ILookupParameter<IRandom> RandomParameter {
41      get { return (LookupParameter<IRandom>)Parameters["Random"]; }
42    }
43    public ILookupParameter<IntegerVector> IntegerVectorParameter {
44      get { return (ILookupParameter<IntegerVector>)Parameters["IntegerVector"]; }
45    }
46    public IValueLookupParameter<IntValue> LengthParameter {
47      get { return (IValueLookupParameter<IntValue>)Parameters["Length"]; }
48    }
49    public IValueLookupParameter<IntMatrix> BoundsParameter {
50      get { return (IValueLookupParameter<IntMatrix>)Parameters["Bounds"]; }
51    }
52
53    [StorableConstructor]
54    protected IntegerVectorCreator(StorableConstructorFlag _) : base(_) { }
55    protected IntegerVectorCreator(IntegerVectorCreator original, Cloner cloner) : base(original, cloner) { }
56    protected IntegerVectorCreator()
57      : base() {
58      Parameters.Add(new LookupParameter<IRandom>("Random", "The pseudo random number generator which should be used for stochastic manipulation operators."));
59      Parameters.Add(new LookupParameter<IntegerVector>("IntegerVector", "The vector which should be manipulated."));
60      Parameters.Add(new ValueLookupParameter<IntValue>("Length", "The length of the vector."));
61      Parameters.Add(new ValueLookupParameter<IntMatrix>("Bounds", "The bounds matrix can contain one row for each dimension with three columns specifying minimum (inclusive), maximum (exclusive), and step size. If less rows are given the matrix is cycled."));
62    }
63
64    // BackwardsCompatibility3.3
65    #region Backwards compatible code, remove with 3.4
66    [StorableHook(HookType.AfterDeserialization)]
67    private void AfterDeserialization() {
68      if (!Parameters.ContainsKey("Bounds")) {
69        var min = ((IValueLookupParameter<IntValue>)Parameters["Minimum"]).Value as IntValue;
70        var max = ((IValueLookupParameter<IntValue>)Parameters["Maximum"]).Value as IntValue;
71        Parameters.Remove("Minimum");
72        Parameters.Remove("Maximum");
73        Parameters.Add(new ValueLookupParameter<IntMatrix>("Bounds", "The bounds matrix can contain one row for each dimension with three columns specifying minimum (inclusive), maximum (exclusive), and step size. If less rows are given the matrix is cycled."));
74        if (min != null && max != null) {
75          BoundsParameter.Value = new IntMatrix(new int[,] { { min.Value, max.Value, 1 } });
76        }
77      }
78    }
79    #endregion
80
81    public sealed override IOperation InstrumentedApply() {
82      IntegerVectorParameter.ActualValue = Create(RandomParameter.ActualValue, LengthParameter.ActualValue, BoundsParameter.ActualValue);
83      return base.InstrumentedApply();
84    }
85
86    protected abstract IntegerVector Create(IRandom random, IntValue length, IntMatrix bounds);
87  }
88}
Note: See TracBrowser for help on using the repository browser.