Changeset 1179


Ignore:
Timestamp:
01/27/09 13:42:30 (13 years ago)
Author:
abeham
Message:

added documentation to ChildrenInitializer

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/sources/HeuristicLab.Evolutionary/ChildrenInitializer.cs

    r1159 r1179  
    2828
    2929namespace HeuristicLab.Evolutionary {
     30  /// <summary>
     31  /// Initializes and prepares the children for crossover
     32  /// </summary>
    3033  public class ChildrenInitializer : OperatorBase {
     34    /// <inheritdoc select="summary"/>
    3135    public override string Description {
    3236      get {
     
    3539    }
    3640
     41    /// <summary>
     42    /// Initializes a new instance of <see cref="ChildrenInitializer"/> with one variable info: <c>ParentsPerChild</c>.
     43    /// </summary>
    3744    public ChildrenInitializer()
    3845      : base() {
     
    4249    }
    4350
     51    /// <summary>
     52    /// Initializes the children as new scopes and inserts their parents as subscopes.
     53    /// </summary>
     54    /// <exception cref="InvalidOperationException">Thrown when the number of selected parents is not a natural multiple of <c>ParentsPerChild</c>.</exception>
     55    /// <param name="scope">The scope that houses all the selected parents as subscopes.</param>
     56    /// <returns><c>null</c>.</returns>
    4457    public override IOperation Apply(IScope scope) {
    4558      int parents = GetVariableValue<IntData>("ParentsPerChild", scope, true).Data;
Note: See TracChangeset for help on using the changeset viewer.