Free cookie consent management tool by TermsFeed Policy Generator

Changeset 5423


Ignore:
Timestamp:
02/04/11 04:35:08 (13 years ago)
Author:
swagner
Message:

Updated XML comments in BoundsChecker and ReflectiveBoundsChecker (#1395)

Location:
trunk/sources/HeuristicLab.Encodings.RealVectorEncoding/3.3
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/sources/HeuristicLab.Encodings.RealVectorEncoding/3.3/BoundsChecker.cs

    r5381 r5423  
    3030namespace HeuristicLab.Encodings.RealVectorEncoding {
    3131  /// <summary>
    32   /// Checks if all elements of a real vector are inside the bounds. 
    33   /// If not, the elements are corrected.
     32  /// Checks if all elements of a real vector are inside the bounds.
     33  /// If not, elements are set to the respective values of the bounds.
    3434  /// </summary>
    3535  [Item("BoundsChecker", "Checks if all elements of a real vector are inside the bounds. If not, elements are set to the respective values of the bounds.")]
     
    6161
    6262    /// <summary>
    63     /// Checks if all elements of the given <paramref name="vector"/> are inside the bounds and if not they are corrected.
     63    /// Checks if all elements of the given <paramref name="vector"/> are inside the bounds and if not, elements are set to the respective values of the bounds.
    6464    /// </summary>
    6565    /// <param name="bounds">The lower and upper bound (1st and 2nd column) of the positions in the vector. If there are less rows than dimensions, the rows are cycled.</param>
     
    7575
    7676    /// <summary>
    77     /// Checks if all elements of the given <paramref name="vector"/> are inside the bounds and if not they are corrected.
     77    /// Checks if all elements of the given <paramref name="vector"/> are inside the bounds and if not, elements are set to the respective values of the bounds.
    7878    /// </summary>
    7979    /// <exception cref="InvalidOperationException">Thrown when either vector or bounds could not be found.</exception>
  • trunk/sources/HeuristicLab.Encodings.RealVectorEncoding/3.3/ReflectiveBoundsChecker.cs

    r5381 r5423  
    3030namespace HeuristicLab.Encodings.RealVectorEncoding {
    3131  /// <summary>
    32   /// Checks if all elements of a real vector are inside the bounds. 
    33   /// If not, the elements are corrected.
     32  /// Checks if all elements of a real vector are inside the bounds.
     33  /// If not, the elements are mirrored at the bounds.
    3434  /// </summary>
    3535  [Item("ReflectiveBoundsChecker", "Checks if all elements of a real vector are inside the bounds. If not, elements are mirrored at the bounds.")]
     
    4747    protected ReflectiveBoundsChecker(ReflectiveBoundsChecker original, Cloner cloner) : base(original, cloner) { }
    4848    /// <summary>
    49     /// Initializes a new instance of <see cref="BoundsChecker"/> with two parameters
     49    /// Initializes a new instance of <see cref="ReflectiveBoundsChecker"/> with two parameters
    5050    /// (<c>RealVector</c>, <c>Bounds</c>).
    5151    /// </summary>
     
    6161
    6262    /// <summary>
    63     /// Checks if all elements of the given <paramref name="vector"/> are inside the bounds and if not they are corrected.
     63    /// Checks if all elements of the given <paramref name="vector"/> are inside the bounds and if not, they are mirrored at the bounds.
    6464    /// </summary>
    6565    /// <param name="bounds">The lower and upper bound (1st and 2nd column) of the positions in the vector. If there are less rows than dimensions, the rows are cycled.</param>
     
    8989
    9090    /// <summary>
    91     /// Checks if all elements of the given <paramref name="vector"/> are inside the bounds and if not they are corrected.
     91    /// Checks if all elements of the given <paramref name="vector"/> are inside the bounds and if not, they are mirrored at the bounds.
    9292    /// </summary>
    9393    /// <exception cref="InvalidOperationException">Thrown when either vector or bounds could not be found.</exception>
Note: See TracChangeset for help on using the changeset viewer.