Free cookie consent management tool by TermsFeed Policy Generator

Ignore:
Timestamp:
06/09/09 00:57:49 (15 years ago)
Author:
swagner
Message:

Refactoring of the operator architecture (#95)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/Operator Architecture Refactoring/HeuristicLab.Core/3.3/Interfaces/IOperator.cs

    r776 r2033  
    2929  /// a basic instruction of an algorithm.
    3030  /// </summary>
    31   public interface IOperator : IConstrainedItem {
     31  public interface IOperator : IItem {
    3232    /// <summary>
    3333    /// Gets or sets the name of the current instance.
     
    6767    void AddSubOperator(IOperator op);
    6868    /// <summary>
    69     /// Adds the given sub operator to the current instance if all constraints can be fulfilled.
    70     /// </summary>
    71     /// <param name="op">The operator to add.</param>
    72     /// <returns><c>true</c> if the operator could be added without violating constraints,
    73     /// <c>false</c> otherwise.</returns>
    74     bool TryAddSubOperator(IOperator op);
    75     /// <summary>
    76     /// Adds the given sub operator to the current instance if all constraints can be fulfilled.
    77     /// </summary>
    78     /// <param name="op">The operator to add.</param>
    79     /// <param name="violatedConstraints">Output parameter; contains all constraints that could not be
    80     /// fulfilled.</param>
    81     /// <returns><c>true</c> if the operator could be added without violating constraints,
    82     /// <c>false</c> otherwise.</returns>
    83     bool TryAddSubOperator(IOperator op, out ICollection<IConstraint> violatedConstraints);
    84     /// <summary>
    8569    /// Adds the given sub operator at a the specified <paramref name="index"/>.
    8670    /// </summary>
     
    8973    void AddSubOperator(IOperator op, int index);
    9074    /// <summary>
    91     /// Adds the given operator at the specified <paramref name="index"/> to the current instance
    92     /// if all constraints can be fulfilled.
    93     /// </summary>
    94     /// <param name="op">The operator to add.</param>
    95     /// <param name="index">The position where to add the operator.</param>
    96     /// <returns><c>true</c> if the operator could be added without violating constraints,
    97     /// <c>false</c> otherwise.</returns>
    98     bool TryAddSubOperator(IOperator op, int index);
    99     /// <summary>
    100     /// Adds the given operator at the specified <paramref name="index"/> to the current instance
    101     /// if all constraints can be fulfilled.
    102     /// </summary>
    103     /// <param name="op">The operator to add.</param>
    104     /// <param name="index">The position where to add the operator.</param>
    105     /// <param name="violatedConstraints">Output parameter; contains all constraints that could not be
    106     /// fulfilled.</param>
    107     /// <returns><c>true</c> if the operator could be added without violating constraints,
    108     /// <c>false</c> otherwise.</returns>
    109     bool TryAddSubOperator(IOperator op, int index, out ICollection<IConstraint> violatedConstraints);
    110     /// <summary>
    11175    /// Removes a sub operator at the specified <paramref name="index"/>.
    11276    /// </summary>
    11377    /// <param name="index">The position where to delete the operator.</param>
    11478    void RemoveSubOperator(int index);
    115     /// <summary>
    116     /// Removes a sub operator at the specified <paramref name="index"/> if all constraint can be fulfilled.
    117     /// </summary>
    118     /// <param name="index">The position where to delete the operator.</param>
    119     /// <returns><c>true</c> if the operator could be deleted without violating constraints,
    120     /// <c>false</c> otherwise.</returns>
    121     bool TryRemoveSubOperator(int index);
    122     /// <summary>
    123     /// Deletes the operator at the specified <paramref name="index"/> 
    124     /// if all constraints can be fulfilled.
    125     /// </summary>
    126     /// <param name="index">The position where to delete the operator.</param>
    127     /// <param name="violatedConstraints">Output parameter; contains all constraints that could not be
    128     /// fulfilled.</param>
    129     /// <returns><c>true</c> if the operator could be deleted without violating constraints,
    130     /// <c>false</c> otherwise.</returns>
    131     bool TryRemoveSubOperator(int index, out ICollection<IConstraint> violatedConstraints);
    13279
    13380    /// <summary>
     
    14390    void AddVariableInfo(IVariableInfo variableInfo);
    14491    /// <summary>
    145     /// Adds the specified variable info to the current instance, if all constraints can be fulfilled.
    146     /// </summary>
    147     /// <param name="variableInfo">The variable info to add.</param>
    148     /// <returns><c>true</c> if the variable info could be added without violating constraints,
    149     /// <c>false</c> otherwise.</returns>
    150     bool TryAddVariableInfo(IVariableInfo variableInfo);
    151     /// <summary>
    152     /// Adds the specified variable info to the current instance, if all constraints can be fulfilled.
    153     /// </summary>
    154     /// <param name="variableInfo">The variable info to add.</param>
    155     /// <param name="violatedConstraints">Output parameter; contains all constraints that could not be
    156     /// fulfilled.</param>
    157     /// <returns><c>true</c> if the variable info could be added without violating constraints,
    158     /// <c>false</c> otherwise.</returns>
    159     bool TryAddVariableInfo(IVariableInfo variableInfo, out ICollection<IConstraint> violatedConstraints);
    160     /// <summary>
    16192    /// Removes the variable info with the given formal name.
    16293    /// </summary>
    16394    /// <param name="formalName">The formal name of the variable info to remove.</param>
    16495    void RemoveVariableInfo(string formalName);
    165     /// <summary>
    166     /// Deletes the variable info with the given formal name,
    167     /// if all constraints can be fulfilled.
    168     /// </summary>
    169     /// <param name="formalName">The formal name of the variable info to remove.</param>
    170     /// <returns><c>true</c> if the variable info could be deleted without violating constraints,
    171     /// <c>false</c> otherwise.</returns>
    172     bool TryRemoveVariableInfo(string formalName);
    173     /// <summary>
    174     /// Deletes the variable info with the given formal name,
    175     /// if all constraints can be fulfilled.
    176     /// </summary>
    177     /// <param name="formalName">The formal name of the variable info to remove.</param>
    178     /// <param name="violatedConstraints">Output parameter; contains all constraints that could not be
    179     /// fulfilled.</param>
    180     /// <returns><c>true</c> if the variable info could be deleted without violating constraints,
    181     /// <c>false</c> otherwise.</returns>
    182     bool TryRemoveVariableInfo(string formalName, out ICollection<IConstraint> violatedConstraints);
    18396
    18497    /// <summary>
     
    194107    void AddVariable(IVariable variable);
    195108    /// <summary>
    196     /// Adds the specified <paramref name="variable"/> to the current instance if all constraints can
    197     /// be fulfilled.
    198     /// </summary>
    199     /// <param name="variable">The variable to add.</param>
    200     /// <returns><c>true</c> if the variable could be added without violating constraints,
    201     /// <c>false</c> otherwise.</returns>
    202     bool TryAddVariable(IVariable variable);
    203     /// <summary>
    204     /// Adds the specified <paramref name="variable"/> to the current instance if all constraints can
    205     /// be fulfilled.
    206     /// </summary>
    207     /// <param name="variable">The variable to add.</param>
    208     /// <param name="violatedConstraints">Output parameter; contains all constraints that could
    209     /// not be fulfillled.</param>
    210     /// <returns><c>true</c> if the variable could be added without violating constraints,
    211     /// <c>false</c> otherwise.</returns>
    212     bool TryAddVariable(IVariable variable, out ICollection<IConstraint> violatedConstraints);
    213     /// <summary>
    214109    /// Deletes the variable with the specified <paramref name="name"/>.
    215110    /// </summary>
    216111    /// <param name="name">The name of the variable to delete.</param>
    217112    void RemoveVariable(string name);
    218     /// <summary>
    219     /// Deletes the variable with the specified <paramref name="name"/> if all constraints can be
    220     /// fulfilled.
    221     /// </summary>
    222     /// <param name="name">The name of the variable to remove.</param>
    223     /// <returns><c>true</c> if the variable could be deleted without violating constraints,
    224     /// <c>false</c> otherwise.</returns>
    225     bool TryRemoveVariable(string name);
    226     /// <summary>
    227     /// Deletes the variable with the specified <paramref name="name"/> if all constraints can be
    228     /// fulfilled.
    229     /// </summary>
    230     /// <param name="name">The name of the variable to remove.</param>
    231     /// <param name="violatedConstraints">Output parameter; contains all constraints that could
    232     /// not be fulfilled.</param>
    233     /// <returns><c>true</c> if the variable could be deleted without violating constraints,
    234     /// <c>false</c> otherwise.</returns>
    235     bool TryRemoveVariable(string name, out ICollection<IConstraint> violatedConstraints);
    236    
     113
    237114    /// <inheritdoc cref="GetVariableValue(string, HeuristicLab.Core.IScope, bool)"/>
    238115    /// <typeparam name="T">The type of the value that is searched.</typeparam>       
Note: See TracChangeset for help on using the changeset viewer.