#region License Information
/* HeuristicLab
* Copyright (C) 2002-2015 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
*
* This file is part of HeuristicLab.
*
* HeuristicLab is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* HeuristicLab is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with HeuristicLab. If not, see .
*/
#endregion
using System;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Operators;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
namespace HeuristicLab.Encodings.RealVectorEncoding {
///
/// Checks if all elements of a real vector are inside the bounds.
/// If not, the elements are mirrored at the bounds.
///
[Item("ReflectiveBoundsChecker", "Checks if all elements of a real vector are inside the bounds. If not, elements are mirrored at the bounds.")]
[StorableClass("752716CC-81D8-432B-959A-4A022E8B8F2C")]
public class ReflectiveBoundsChecker : SingleSuccessorOperator, IRealVectorBoundsChecker {
public LookupParameter RealVectorParameter {
get { return (LookupParameter)Parameters["RealVector"]; }
}
public ValueLookupParameter BoundsParameter {
get { return (ValueLookupParameter)Parameters["Bounds"]; }
}
[StorableConstructor]
protected ReflectiveBoundsChecker(bool deserializing) : base(deserializing) { }
protected ReflectiveBoundsChecker(ReflectiveBoundsChecker original, Cloner cloner) : base(original, cloner) { }
///
/// Initializes a new instance of with two parameters
/// (RealVector, Bounds).
///
public ReflectiveBoundsChecker()
: base() {
Parameters.Add(new LookupParameter("RealVector", "The real-valued vector for which the bounds should be checked."));
Parameters.Add(new ValueLookupParameter("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."));
}
public override IDeepCloneable Clone(Cloner cloner) {
return new ReflectiveBoundsChecker(this, cloner);
}
///
/// Checks if all elements of the given are inside the bounds and if not, they are mirrored at the 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.
/// The vector to check.
/// The corrected real vector.
public static void Apply(RealVector vector, DoubleMatrix bounds) {
for (int i = 0; i < vector.Length; i++) {
double min = bounds[i % bounds.Rows, 0], max = bounds[i % bounds.Rows, 1];
if (vector[i] < min) {
int reflectionCount = (int)Math.Truncate((min - vector[i]) / (max - min)) + 1;
double reflection = (min - vector[i]) % (max - min);
if (IsOdd(reflectionCount)) vector[i] = min + reflection;
else vector[i] = max - reflection;
}
if (vector[i] > max) {
int reflectionCount = (int)Math.Truncate((vector[i] - max) / (max - min)) + 1;
double reflection = (vector[i] - max) % (max - min);
if (IsOdd(reflectionCount)) vector[i] = max - reflection;
else vector[i] = min + reflection;
}
}
}
private static bool IsOdd(int number) {
return number % 2 == 1;
}
///
/// Checks if all elements of the given are inside the bounds and if not, they are mirrored at the bounds.
///
/// Thrown when either vector or bounds could not be found.
/// Calls .
///
public override IOperation Apply() {
if (RealVectorParameter.ActualValue == null) throw new InvalidOperationException("ReflectiveBoundsChecker: Parameter " + RealVectorParameter.ActualName + " could not be found.");
if (BoundsParameter.ActualValue == null) throw new InvalidOperationException("ReflectiveBoundsChecker: Parameter " + BoundsParameter.ActualName + " could not be found.");
Apply(RealVectorParameter.ActualValue, BoundsParameter.ActualValue);
return base.Apply();
}
}
}