[2900] | 1 | #region License Information
|
---|
| 2 | /* HeuristicLab
|
---|
| 3 | * Copyright (C) 2002-2010 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 |
|
---|
[3182] | 22 | using System;
|
---|
[4722] | 23 | using HeuristicLab.Common;
|
---|
[2900] | 24 | using HeuristicLab.Core;
|
---|
| 25 | using HeuristicLab.Data;
|
---|
| 26 | using HeuristicLab.Operators;
|
---|
[3182] | 27 | using HeuristicLab.Parameters;
|
---|
[2900] | 28 | using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
|
---|
| 29 |
|
---|
[3053] | 30 | namespace HeuristicLab.Encodings.RealVectorEncoding {
|
---|
[2900] | 31 | /// <summary>
|
---|
[3123] | 32 | /// Checks if all elements of a real vector are inside the bounds.
|
---|
[2900] | 33 | /// If not, the elements are corrected.
|
---|
| 34 | /// </summary>
|
---|
[3123] | 35 | [Item("BoundsChecker", "Checks if all elements of a real vector are inside the bounds. If not, elements are corrected.")]
|
---|
[3017] | 36 | [StorableClass]
|
---|
[3182] | 37 | public class BoundsChecker : SingleSuccessorOperator, IRealVectorBoundsChecker {
|
---|
[3060] | 38 | public LookupParameter<RealVector> RealVectorParameter {
|
---|
| 39 | get { return (LookupParameter<RealVector>)Parameters["RealVector"]; }
|
---|
[2900] | 40 | }
|
---|
[3123] | 41 | public ValueLookupParameter<DoubleMatrix> BoundsParameter {
|
---|
| 42 | get { return (ValueLookupParameter<DoubleMatrix>)Parameters["Bounds"]; }
|
---|
[2900] | 43 | }
|
---|
| 44 |
|
---|
[4722] | 45 | [StorableConstructor]
|
---|
| 46 | protected BoundsChecker(bool deserializing) : base(deserializing) { }
|
---|
| 47 | protected BoundsChecker(BoundsChecker original, Cloner cloner) : base(original, cloner) { }
|
---|
[2900] | 48 | /// <summary>
|
---|
[3123] | 49 | /// Initializes a new instance of <see cref="BoundsChecker"/> with two parameters
|
---|
| 50 | /// (<c>RealVector</c>, <c>Bounds</c>).
|
---|
[2900] | 51 | /// </summary>
|
---|
| 52 | public BoundsChecker()
|
---|
| 53 | : base() {
|
---|
[3060] | 54 | Parameters.Add(new LookupParameter<RealVector>("RealVector", "The real-valued vector for which the bounds should be checked."));
|
---|
[3123] | 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."));
|
---|
[2900] | 56 | }
|
---|
| 57 |
|
---|
[4722] | 58 | public override IDeepCloneable Clone(Cloner cloner) {
|
---|
| 59 | return new BoundsChecker(this, cloner);
|
---|
| 60 | }
|
---|
| 61 |
|
---|
[2900] | 62 | /// <summary>
|
---|
[3123] | 63 | /// Checks if all elements of the given <paramref name="vector"/> are inside the bounds and if not they are corrected.
|
---|
[2900] | 64 | /// </summary>
|
---|
[3123] | 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>
|
---|
[2900] | 66 | /// <param name="vector">The vector to check.</param>
|
---|
| 67 | /// <returns>The corrected real vector.</returns>
|
---|
[3123] | 68 | public static void Apply(RealVector vector, DoubleMatrix bounds) {
|
---|
[2900] | 69 | for (int i = 0; i < vector.Length; i++) {
|
---|
[3123] | 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;
|
---|
[2900] | 73 | }
|
---|
| 74 | }
|
---|
| 75 |
|
---|
| 76 | /// <summary>
|
---|
[3123] | 77 | /// Checks if all elements of the given <paramref name="vector"/> are inside the bounds and if not they are corrected.
|
---|
[2900] | 78 | /// </summary>
|
---|
[3123] | 79 | /// <exception cref="InvalidOperationException">Thrown when either vector or bounds could not be found.</exception>
|
---|
| 80 | /// <remarks>Calls <see cref="Apply(RealVector, DoubleMatrix)"/>.</remarks>
|
---|
[2900] | 81 | /// <inheritdoc select="returns" />
|
---|
[5177] | 82 | public override IOperation Apply(IExecutionContext context) {
|
---|
[2900] | 83 | if (RealVectorParameter.ActualValue == null) throw new InvalidOperationException("BoundsChecker: Parameter " + RealVectorParameter.ActualName + " could not be found.");
|
---|
[3123] | 84 | if (BoundsParameter.ActualValue == null) throw new InvalidOperationException("BoundsChecker: Parameter " + BoundsParameter.ActualName + " could not be found.");
|
---|
| 85 | Apply(RealVectorParameter.ActualValue, BoundsParameter.ActualValue);
|
---|
[5177] | 86 | return base.Apply(context);
|
---|
[2900] | 87 | }
|
---|
| 88 | }
|
---|
| 89 | }
|
---|