Free cookie consent management tool by TermsFeed Policy Generator

source: branches/Operator Architecture Refactoring/HeuristicLab.Operators/GreaterThanComparator.cs @ 1000

Last change on this file since 1000 was 801, checked in by vdorfer, 16 years ago

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

File size: 2.1 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2008 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Text;
25using System.Xml;
26using HeuristicLab.Core;
27using HeuristicLab.Data;
28
29namespace HeuristicLab.Operators {
30  /// <summary>
31  /// Operator to check whether an item is greater than another one.
32  /// </summary>
33  public class GreaterThanComparator : ComparatorBase {
34    /// <inheritdoc select="summary"/>
35    public override string Description {
36      get { return @"TODO\r\nOperator description still missing ..."; }
37    }
38
39    /// <summary>
40    /// Initializes a new instance of <see cref="GreaterThanComparator"/>.
41    /// </summary>
42    public GreaterThanComparator()
43      : base() {
44    }
45
46    /// <summary>
47    /// Checks whether the <paramref name="left"/> item is greater than the <paramref name="right"/>.
48    /// </summary>
49    /// <param name="left">The left side of the comparison.</param>
50    /// <param name="right">The right side of the comparison.</param>
51    /// <returns><c>true</c> if the <paramref name="left"/> item is greater than the
52    /// <paramref name="right"/>, <c>false</c> otherwise.</returns>
53    protected override bool Compare(IComparable left, IItem right) {
54      return left.CompareTo(right) > 0;
55    }
56  }
57}
Note: See TracBrowser for help on using the repository browser.