Changeset 1188 for trunk/sources/HeuristicLab.TestFunctions/TestFunctionInjector.cs

Timestamp:

01/30/09 10:38:42 (15 years ago)

Author:

vdorfer

Message:

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

File:

• trunk/sources/HeuristicLab.TestFunctions/TestFunctionInjector.cs (modified) (8 diffs)

trunk/sources/HeuristicLab.TestFunctions/TestFunctionInjector.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.TestFunctions {
+  /// <summary>
+  /// Injects the necessary variables for optimizing a test function
+  /// </summary>
   public class TestFunctionInjector : OperatorBase {
+    /// <inheritdoc select="summary"/>
     public override string Description {
       get {
@@ -34 +38 @@
     }
 
+    /// <summary>
+    /// Gets or sets the boolean flag whether it is an optimization problem or not.
+    /// </summary>
     public bool Maximization {
       get { return GetVariable("Maximization").GetValue<BoolData>().Data; }
@@ -39 +46 @@
     }
 
+    /// <summary>
+    /// Gets or sets the lower bound.
+    /// </summary>
     public double LowerBound {
       get { return GetVariable("LowerBound").GetValue<DoubleData>().Data; }
@@ -44 +54 @@
     }
 
+    /// <summary>
+    /// Gets or sets the upper bound.
+    /// </summary>
     public double UpperBound {
       get { return GetVariable("UpperBound").GetValue<DoubleData>().Data; }
@@ -49 +62 @@
     }
 
+    /// <summary>
+    /// Gets or sets the dimension.
+    /// </summary>
     public int Dimension {
       get { return GetVariable("Dimension").GetValue<IntData>().Data; }
@@ -54 +70 @@
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="TestFunctionInjector"/> with four variable infos
+    /// (<c>Maximization</c>, <c>LowerBound</c>, <c>UpperBound</c> and <c>Dimension</c>).
+    /// </summary>
     public TestFunctionInjector()
       : base() {
@@ -62 +82 @@
     }
 
+    /// <summary>
+    /// Injects the necessary variables for optimizing a test function.
+    /// </summary>
+    /// <param name="scope">The scope where to inject the variables.</param>
+    /// <returns><c>null</c>.</returns>
     public override IOperation Apply(IScope scope) {
       scope.AddVariable((IVariable)GetVariable("Maximization").Clone());
@@ -70 +95 @@
     }
 
+    /// <summary>
+    /// Creates a new instance of <see cref="TestFunctionInjectorView"/> to represent the current 
+    /// instance visually.
+    /// </summary>
+    /// <returns>The newly created view as <see cref="TestFunctionInjectorView"/>.</returns>
     public override IView CreateView() {
       return new TestFunctionInjectorView(this);