HeuristicLab.Encodings.BinaryVectorEncoding/3.3/BinaryVectorCreator.cs

   1 #region License Information
   2 /* HeuristicLab
   3  * Copyright (C) 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
  22 using HeuristicLab.Common;
  23 using HeuristicLab.Core;
  24 using HeuristicLab.Data;
  25 using HeuristicLab.Operators;
  26 using HeuristicLab.Optimization;
  27 using HeuristicLab.Parameters;
  28 using HEAL.Attic;
  29
  30 namespace HeuristicLab.Encodings.BinaryVectorEncoding {
  31   /// <summary>
  32   /// A base class for operators creating bool-valued vectors.
  33   /// </summary>
  34   [Item("BinaryVectorCreator", "A base class for operators creating bool-valued vectors.")]
  35   [StorableType("5CE4B676-CE68-4338-AF85-A289D3C8BA69")]
  36   public abstract class BinaryVectorCreator : InstrumentedOperator, IBinaryVectorCreator, 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<BinaryVector> BinaryVectorParameter {
  44       get { return (ILookupParameter<BinaryVector>)Parameters["BinaryVector"]; }
  45     }
  46     public IValueLookupParameter<IntValue> LengthParameter {
  47       get { return (IValueLookupParameter<IntValue>)Parameters["Length"]; }
  48     }
  49
  50     [StorableConstructor]
  51     protected BinaryVectorCreator(StorableConstructorFlag _) : base(_) { }
  52     protected BinaryVectorCreator(BinaryVectorCreator original, Cloner cloner) : base(original, cloner) { }
  53     protected BinaryVectorCreator()
  54       : base() {
  55       Parameters.Add(new LookupParameter<IRandom>("Random", "The pseudo random number generator which should be used for stochastic manipulation operators."));
  56       Parameters.Add(new LookupParameter<BinaryVector>("BinaryVector", "The vector which should be manipulated."));
  57       Parameters.Add(new ValueLookupParameter<IntValue>("Length", "The length of the vector."));
  58     }
  59
  60     public sealed override IOperation InstrumentedApply() {
  61       BinaryVectorParameter.ActualValue = Create(RandomParameter.ActualValue, LengthParameter.ActualValue);
  62       return base.InstrumentedApply();
  63     }
  64
  65     protected abstract BinaryVector Create(IRandom random, IntValue length);
  66   }
  67 }