source: branches/2817-BinPackingSpeedup/HeuristicLab.Problems.BinPacking/3.3/3D/Evaluators/IEvaluator.cs @ 15838

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2018 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using HeuristicLab.Core;
using System;

namespace HeuristicLab.Problems.BinPacking3D {
  /// <summary>
  /// Evaluator for evaluating a Solution
  /// </summary>
  public interface IEvaluator : IItem {

    /// <summary>
    /// Evaluates a given solution and returns the calculated value.
    /// </summary>
    /// <param name="solution">Solution which sould be evaluated</param>
    /// <returns>Returns the value of the evaluated solution depending on the implementation</returns>
    double Evaluate(Solution solution);

    /// <summary>
    /// Returns a tuple of (number of bins, bin utilization, number of residual spaces)
    /// </summary>
    /// <param name="solution"></param>
    /// <returns></returns>
    Tuple<int, double, int, int> EvaluateBinPacking(Solution solution);
  }
}