Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Encodings.RealVectorEncoding/3.3/BoundsChecker.cs @ 10845

Last change on this file since 10845 was 9456, checked in by swagner, 12 years ago

Updated copyright year and added some missing license headers (#1889)

File size: 4.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 HeuristicLab.Common;
24using HeuristicLab.Core;
25using HeuristicLab.Data;
26using HeuristicLab.Operators;
27using HeuristicLab.Parameters;
28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
29
30namespace HeuristicLab.Encodings.RealVectorEncoding {
31  /// <summary>
32  /// Checks if all elements of a real vector are inside the bounds.
33  /// If not, elements are set to the respective values of the bounds.
34  /// </summary>
35  [Item("BoundsChecker", "Checks if all elements of a real vector are inside the bounds. If not, elements are set to the respective values of the bounds.")]
36  [StorableClass]
37  public class BoundsChecker : SingleSuccessorOperator, IRealVectorBoundsChecker {
38    public LookupParameter<RealVector> RealVectorParameter {
39      get { return (LookupParameter<RealVector>)Parameters["RealVector"]; }
40    }
41    public ValueLookupParameter<DoubleMatrix> BoundsParameter {
42      get { return (ValueLookupParameter<DoubleMatrix>)Parameters["Bounds"]; }
43    }
44
45    [StorableConstructor]
46    protected BoundsChecker(bool deserializing) : base(deserializing) { }
47    protected BoundsChecker(BoundsChecker original, Cloner cloner) : base(original, cloner) { }
48    /// <summary>
49    /// Initializes a new instance of <see cref="BoundsChecker"/> with two parameters
50    /// (<c>RealVector</c>, <c>Bounds</c>).
51    /// </summary>
52    public BoundsChecker()
53      : base() {
54      Parameters.Add(new LookupParameter<RealVector>("RealVector", "The real-valued vector for which the bounds should be checked."));
55      Parameters.Add(new ValueLookupParameter<DoubleMatrix>("Bounds", "The lower and upper bound (1st and 2nd column) of the positions in the vector. If there are less rows than dimensions, the rows are cycled."));
56    }
57
58    public override IDeepCloneable Clone(Cloner cloner) {
59      return new BoundsChecker(this, cloner);
60    }
61
62    /// <summary>
63    /// Checks if all elements of the given <paramref name="vector"/> are inside the bounds and if not, elements are set to the respective values of the bounds.
64    /// </summary>
65    /// <param name="bounds">The lower and upper bound (1st and 2nd column) of the positions in the vector. If there are less rows than dimensions, the rows are cycled.</param>
66    /// <param name="vector">The vector to check.</param>
67    /// <returns>The corrected real vector.</returns>
68    public static void Apply(RealVector vector, DoubleMatrix bounds) {
69      for (int i = 0; i < vector.Length; i++) {
70        double min = bounds[i % bounds.Rows, 0], max = bounds[i % bounds.Rows, 1];
71        if (vector[i] < min) vector[i] = min;
72        if (vector[i] > max) vector[i] = max;
73      }
74    }
75
76    /// <summary>
77    /// Checks if all elements of the given <paramref name="vector"/> are inside the bounds and if not, elements are set to the respective values of the bounds.
78    /// </summary>
79    /// <exception cref="InvalidOperationException">Thrown when either vector or bounds could not be found.</exception>
80    /// <remarks>Calls <see cref="Apply(RealVector, DoubleMatrix)"/>.</remarks>
81    /// <inheritdoc select="returns" />
82    public override IOperation Apply() {
83      if (RealVectorParameter.ActualValue == null) throw new InvalidOperationException("BoundsChecker: Parameter " + RealVectorParameter.ActualName + " could not be found.");
84      if (BoundsParameter.ActualValue == null) throw new InvalidOperationException("BoundsChecker: Parameter " + BoundsParameter.ActualName + " could not be found.");
85      Apply(RealVectorParameter.ActualValue, BoundsParameter.ActualValue);
86      return base.Apply();
87    }
88  }
89}
Note: See TracBrowser for help on using the repository browser.