Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.RealVector/UniformRandomRealVectorGenerator.cs @ 1393

Last change on this file since 1393 was 1184, checked in by vdorfer, 16 years ago

Created API documentation for HeuristicLab.RealVector namespace (#331)

File size: 4.0 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  /// Generates a new random real vector with each element uniformly distributed in a specified range.
31  /// </summary>
32  public class UniformRandomRealVectorGenerator : OperatorBase {
33    /// <inheritdoc select="summary"/>
34    public override string Description {
35      get { return "Operator generating a new random real vector with each element uniformly distributed in a specified range."; }
36    }
37
38    /// <summary>
39    /// Initializes a new instance of <see cref="UniformRandomRealVectorGenerator"/> with five variable infos
40    /// (<c>Random</c>, <c>Length</c>, <c>Minimum</c>, <c>Maximum</c> and <c>RealVector</c>).
41    /// </summary>
42    public UniformRandomRealVectorGenerator() {
43      AddVariableInfo(new VariableInfo("Random", "Pseudo random number generator", typeof(IRandom), VariableKind.In));
44      AddVariableInfo(new VariableInfo("Length", "Vector length", typeof(IntData), VariableKind.In));
45      AddVariableInfo(new VariableInfo("Minimum", "Minimum of the sampling range for each vector element (included)", typeof(DoubleData), VariableKind.In));
46      AddVariableInfo(new VariableInfo("Maximum", "Maximum of the sampling range for each vector element (excluded)", typeof(DoubleData), VariableKind.In));
47      AddVariableInfo(new VariableInfo("RealVector", "Created random real vector", typeof(DoubleArrayData), VariableKind.New));
48    }
49
50    /// <summary>
51    /// Generates a new random real vector with the given <paramref name="length"/>.
52    /// </summary>
53    /// <param name="random">The random number generator.</param>
54    /// <param name="length">The length of the real vector.</param>
55    /// <param name="min">The minimum value of the sampling range for each vector element (inclusive).</param>
56    /// <param name="max">The maximum value of the sampling range for each vector element (exclusive).</param>
57    /// <returns>The newly created real vector.</returns>
58    public static double[] Apply(IRandom random, int length, double min, double max) {
59      double[] result = new double[length];
60      for (int i = 0; i < length; i++)
61        result[i] = min + random.NextDouble() * (max - min);
62      return result;
63    }
64
65    /// <summary>
66    /// Generates a new random real vector and injects it in the given <paramref name="scope"/>.
67    /// </summary>
68    /// <param name="scope">The scope where to get the values from and where to inject the newly
69    /// created real vector.</param>
70    /// <returns><c>null</c>.</returns>
71    public override IOperation Apply(IScope scope) {
72      IRandom random = GetVariableValue<IRandom>("Random", scope, true);
73      int length = GetVariableValue<IntData>("Length", scope, true).Data;
74      double min = GetVariableValue<DoubleData>("Minimum", scope, true).Data;
75      double max = GetVariableValue<DoubleData>("Maximum", scope, true).Data;
76
77      double[] vector = Apply(random, length, min, max);
78      scope.AddVariable(new Variable(scope.TranslateName("RealVector"), new DoubleArrayData(vector)));
79
80      return null;
81    }
82  }
83}
Note: See TracBrowser for help on using the repository browser.