Free cookie consent management tool by TermsFeed Policy Generator

source: branches/1888_OaaS/HeuristicLab.Encodings.IntegerVectorEncoding/3.3/IntegerVectorManipulator.cs @ 17313

Last change on this file since 17313 was 8184, checked in by abeham, 12 years ago

#1775:

  • Updated documentation and error messages
  • Added an extra base class to unify the implementation of the round methods
File size: 2.6 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2012 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.Optimization;
25using HeuristicLab.Parameters;
26using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
27
28namespace HeuristicLab.Encodings.IntegerVectorEncoding {
29  /// <summary>
30  /// A base class for operators that manipulate int-valued vectors.
31  /// </summary>
32  [Item("IntegerVectorManipulator", "A base class for operators that manipulate int-valued vectors.")]
33  [StorableClass]
34  public abstract class IntegerVectorManipulator : IntegerVectorOperator, IIntegerVectorManipulator, IStochasticOperator {
35    public override bool CanChangeName {
36      get { return false; }
37    }
38    public ILookupParameter<IRandom> RandomParameter {
39      get { return (LookupParameter<IRandom>)Parameters["Random"]; }
40    }
41    public ILookupParameter<IntegerVector> IntegerVectorParameter {
42      get { return (ILookupParameter<IntegerVector>)Parameters["IntegerVector"]; }
43    }
44
45    [StorableConstructor]
46    protected IntegerVectorManipulator(bool deserializing) : base(deserializing) { }
47    protected IntegerVectorManipulator(IntegerVectorManipulator original, Cloner cloner) : base(original, cloner) { }
48    protected IntegerVectorManipulator()
49      : base() {
50      Parameters.Add(new LookupParameter<IRandom>("Random", "The pseudo random number generator which should be used for stochastic manipulation operators."));
51      Parameters.Add(new LookupParameter<IntegerVector>("IntegerVector", "The vector which should be manipulated."));
52    }
53
54    public sealed override IOperation Apply() {
55      Manipulate(RandomParameter.ActualValue, IntegerVectorParameter.ActualValue);
56      return base.Apply();
57    }
58
59    protected abstract void Manipulate(IRandom random, IntegerVector integerVector);
60  }
61}
Note: See TracBrowser for help on using the repository browser.