Free cookie consent management tool by TermsFeed Policy Generator

Ignore:
Timestamp:
01/16/09 11:24:03 (15 years ago)
Author:
vdorfer
Message:

Created API documentation for HeuristicLab.Random, HeuristicLab.SGA and HeuristicLab.Selection.OffspringSelection namespace (#331)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/sources/HeuristicLab.Selection.OffspringSelection/OffspringSelector.cs

    r301 r1153  
    2727
    2828namespace HeuristicLab.Selection.OffspringSelection {
     29  /// <summary>
     30  /// Selects successful and also according to the selection pressure some unsuccessful children.
     31  /// </summary>
    2932  public class OffspringSelector : OperatorBase {
     33    /// <inheritdoc select="summary"/>
    3034    public override string Description {
    3135      get { return @"TODO\r\nOperator description still missing ..."; }
    3236    }
    3337
     38    /// <summary>
     39    /// Initializes a new instance of <see cref="OffspringSelector"/> with seven variable infos
     40    /// (<c>SuccessfulChild</c>, <c>SelectionPressureLimit</c>, <c>SuccessRatioLimit</c>,
     41    /// <c>SelectionPressure</c>, <c>SuccessRatio</c>, <c>GoodChildren</c> and <c>BadChildren</c>).
     42    /// </summary>
    3443    public OffspringSelector() {
    3544      AddVariableInfo(new VariableInfo("SuccessfulChild", "True if the child was successful", typeof(BoolData), VariableKind.In));
     
    4251    }
    4352
     53    /// <summary>
     54    /// Selects successful children and also some bad ones depending on the selection
     55    /// pressure out of a population.
     56    /// </summary>
     57    /// <param name="scope">The current scope of the parents and the children.</param>
     58    /// <returns>The next operation or null.</returns>
    4459    public override IOperation Apply(IScope scope) {
    4560      double selectionPressureLimit = GetVariableValue<DoubleData>("SelectionPressureLimit", scope, true).Data;
Note: See TracChangeset for help on using the changeset viewer.