Changeset 1157 for trunk/sources/HeuristicLab.IntVector/UniformRandomIntVectorGenerator.cs

Timestamp:

01/21/09 11:36:53 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.IntVector namespace and changed some comments in HeuristicLab.Random and HeuristicLab.Selection.Offspring namespace(#331)

File:

• trunk/sources/HeuristicLab.IntVector/UniformRandomIntVectorGenerator.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.IntVector/UniformRandomIntVectorGenerator.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.IntVector {
+  /// <summary>
+  /// Generates a new random integer vector with each element uniformly distributed in a specified range.
+  /// </summary>
   public class UniformRandomIntVectorGenerator : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get { return "Operator generating a new random integer vector with each element uniformly distributed in a specified range."; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="UniformRandomIntVectorGenerator"/> with five variable infos
+    /// (<c>Random</c>, <c>Length</c>, <c>Minimum</c>, <c>Maximum</c> and <c>IntVector</c>).
+    /// </summary>
     public UniformRandomIntVectorGenerator() {
       AddVariableInfo(new VariableInfo("Random", "Pseudo random number generator", typeof(IRandom), VariableKind.In));
@@ -40 +48 @@
     }
 
+    /// <summary>
+    /// Generates a new random integer vector with the given <paramref name="length"/>.
+    /// </summary>
+    /// <param name="random">The random number generator.</param>
+    /// <param name="length">The length of the int vector.</param>
+    /// <param name="min">The minimum value of the sampling range for each vector element (inclusive).</param>
+    /// <param name="max">The maximum value of the sampling range for each vector element (exclusive).</param>
+    /// <returns>The newly created integer vector.</returns>
     public static int[] Apply(IRandom random, int length, int min, int max) {
       int[] result = new int[length];
@@ -47 +63 @@
     }
 
+    /// <summary>
+    /// Generates a new random integer vector and injects it in the given <paramref name="scope"/>.
+    /// </summary>
+    /// <param name="scope">The scope where to get the values from and where to inject the newly 
+    /// created integer vector.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       IRandom random = GetVariableValue<IRandom>("Random", scope, true);