Free cookie consent management tool by TermsFeed Policy Generator

source: branches/Persistence Test/HeuristicLab.RealVector/3.2/UniformOnePositionManipulator.cs @ 4593

Last change on this file since 4593 was 1530, checked in by gkronber, 16 years ago

Moved source files of plugins Hive ... Visualization.Test into version-specific sub-folders. #576

File size: 3.5 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 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 System.Collections.Generic;
24using System.Text;
25using HeuristicLab.Core;
26using HeuristicLab.Data;
27
28namespace HeuristicLab.RealVector {
29  /// <summary>
30  /// Uniformly distributed change of a single position of a real vector.
31  /// </summary>
32  public class UniformOnePositionManipulator : RealVectorManipulatorBase {
33    /// <inheritdoc select="summary"/>
34    public override string Description {
35      get { return "Uniformly distributed change of a single position of a real vector."; }
36    }
37
38    /// <summary>
39    /// Initializes a new instance of <see cref="UniformOnePositionManipulator"/> with two variable infos
40    /// (<c>Minimum</c> and <c>Maximum</c>).
41    /// </summary>
42    public UniformOnePositionManipulator() {
43      AddVariableInfo(new VariableInfo("Minimum", "Minimum of the sampling range for the vector element (included)", typeof(DoubleData), VariableKind.In));
44      AddVariableInfo(new VariableInfo("Maximum", "Maximum of the sampling range for the vector element (excluded)", typeof(DoubleData), VariableKind.In));
45    }
46
47    /// <summary>
48    /// Changes randomly a single position in the given real <paramref name="vector"/>.
49    /// </summary>
50    /// <param name="random">A random number generator.</param>
51    /// <param name="vector">The real vector to manipulate.</param>
52    /// <param name="min">The minimum value of the sampling range for
53    /// the vector element to change (inclusive).</param>
54    /// <param name="max">The maximum value of the sampling range for
55    /// the vector element to change (exclusive).</param>
56    /// <returns>The new real vector that has been manipulated.</returns>
57    public static double[] Apply(IRandom random, double[] vector, double min, double max) {
58      double[] result = (double[])vector.Clone();
59      int index = random.Next(result.Length);
60      result[index] = min + random.NextDouble() * (max - min);
61      return result;
62    }
63
64    /// <summary>
65    /// Changes randomly a single position in the given real <paramref name="vector"/>.
66    /// </summary>
67    /// <remarks>Calls <see cref="Apply"/>.</remarks>
68    /// <param name="scope">The current scope.</param>
69    /// <param name="random">A random number generator.</param>
70    /// <param name="vector">The real vector to manipulate.</param>
71    /// <returns>The new real vector that has been manipulated.</returns>
72    protected override double[] Manipulate(IScope scope, IRandom random, double[] vector) {
73      double min = GetVariableValue<DoubleData>("Minimum", scope, true).Data;
74      double max = GetVariableValue<DoubleData>("Maximum", scope, true).Data;
75      return Apply(random, vector, min, max);
76    }
77  }
78}
Note: See TracBrowser for help on using the repository browser.