source: branches/GeneralizedQAP/HeuristicLab.Encodings.IntegerVectorEncoding/3.3/Creators/UniformRandomIntegerVectorCreator.cs @ 15605

Last change on this file since 15605 was 15605, checked in by abeham, 20 months ago

#1614: merged trunk into branch

File size: 3.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2018 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 HeuristicLab.Common;
23using HeuristicLab.Core;
24using HeuristicLab.Data;
25using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
26
27namespace HeuristicLab.Encodings.IntegerVectorEncoding {
28  /// <summary>
29  /// Generates a new random integer vector with each element uniformly distributed in a specified range.
30  /// </summary>
31  [Item("UniformRandomIntegerVectorCreator", "An operator which creates a new random int vector with each element uniformly distributed in a specified range.")]
32  [StorableClass]
33  public class UniformRandomIntegerVectorCreator : IntegerVectorCreator {
34    [StorableConstructor]
35    protected UniformRandomIntegerVectorCreator(bool deserializing) : base(deserializing) { }
36    protected UniformRandomIntegerVectorCreator(UniformRandomIntegerVectorCreator original, Cloner cloner) : base(original, cloner) { }
37    public UniformRandomIntegerVectorCreator() : base() { }
38
39    public override IDeepCloneable Clone(Cloner cloner) {
40      return new UniformRandomIntegerVectorCreator(this, cloner);
41    }
42
43    /// <summary>
44    /// Generates a new random integer vector with the given <paramref name="length"/>.
45    /// </summary>
46    /// <param name="random">The random number generator.</param>
47    /// <param name="length">The length of the int vector.</param>
48    /// <param name="bounds">A matrix containing the inclusive lower and inclusive upper bound in the first and second column and a step size in the third column.
49    /// Each line represents the bounds for a certain dimension. If fewer lines are given, the lines are cycled.</param>
50    /// <returns>The newly created integer vector.</returns>
51    public static IntegerVector Apply(IRandom random, int length, IntMatrix bounds) {
52      var result = new IntegerVector(length);
53      result.Randomize(random, bounds);
54      return result;
55    }
56
57    /// <summary>
58    /// Forwards the call to <see cref="Apply(IRandom, int, int, int)"/>.
59    /// </summary>
60    /// <param name="random">The pseudo random number generator to use.</param>
61    /// <param name="length">The length of the int vector.</param>
62    /// <param name="bounds">Contains in each row for each dimension minimum (inclusive), maximum (inclusive), and step size.</param>
63    /// <returns>The newly created int vector.</returns>
64    protected override IntegerVector Create(IRandom random, IntValue length, IntMatrix bounds) {
65      return Apply(random, length.Value, bounds);
66    }
67  }
68}
Note: See TracBrowser for help on using the repository browser.