source: branches/ProgrammableProblem/HeuristicLab.Problems.Programmable/3.3/SingleObjectiveProblemDefinition.cs @ 11405

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2014 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 System;
using System.Collections.Generic;
using System.Drawing;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Optimization;

namespace HeuristicLab.Problems.Programmable {
  [Item("Single-objective Problem Definition", "This definition can be dynamically created through code and assigned to the problem.")]
  public class SingleObjectiveProblemDefinition : ISingleObjectiveProblemDefinitionHost, ISingleObjectiveProblemDefinition {
    private bool isMaximizationProblem;
    public bool IsMaximizationProblem {
      get { return isMaximizationProblem; }
      set {
        isMaximizationProblem = value;
        OnInstanceChanged();
      }
    }

    private Func<Configuration> configuration;
    public Func<Configuration> Configuration {
      get { return configuration; }
      set {
        configuration = value;
        OnInstanceChanged();
      }
    }

    private Func<IRandom, ParameterVector, double> evaluate;
    public Func<IRandom, ParameterVector, double> Evaluate {
      get { return evaluate; }
      set {
        evaluate = value;
        OnInstanceChanged();
      }
    }

    private Action<ParameterVector[], double[], ResultCollection> analyze;
    public Action<ParameterVector[], double[], ResultCollection> Analyze {
      get { return analyze; }
      set {
        analyze = value;
        OnInstanceChanged();
      }
    }

    private Func<IRandom, ParameterVector, IEnumerable<ParameterVector>> neighbors;
    public Func<IRandom, ParameterVector, IEnumerable<ParameterVector>> Neighbors {
      get { return neighbors; }
      set {
        neighbors = value;
        OnInstanceChanged();
      }
    }

    protected SingleObjectiveProblemDefinition(SingleObjectiveProblemDefinition original, Cloner cloner) {
      cloner.RegisterClonedObject(original, this);
      name = original.name;
      description = original.description;
      isMaximizationProblem = original.isMaximizationProblem;
      configuration = original.configuration;
      evaluate = original.evaluate;
      analyze = original.analyze;
      neighbors = original.neighbors;
    }

    public SingleObjectiveProblemDefinition() : this((string)null, null) { }
    public SingleObjectiveProblemDefinition(string name) : this(name, null) { }
    public SingleObjectiveProblemDefinition(string name, string description) {
      this.name = name ?? ItemName;
      this.description = description ?? ItemDescription;
      configuration = () => new Configuration();
      evaluate = (random, vector) => 0;
      analyze = (vectors, doubles, results) => { };
      neighbors = (random, vector) => new[] { (ParameterVector)vector.Clone() };
    }


    public IDeepCloneable Clone(Cloner cloner) {
      return new SingleObjectiveProblemDefinition(this, cloner);
    }

    public ISingleObjectiveProblemDefinition Instance {
      get { return this; }
    }

    public event EventHandler InstanceChanged;
    protected void OnInstanceChanged() {
      var handler = InstanceChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }

    #region Problem definition explicit interface implementations
    Configuration IProblemDefinition.GetConfiguration() {
      return Configuration();
    }

    bool ISingleObjectiveProblemDefinition.IsMaximizationProblem {
      get { return IsMaximizationProblem; }
    }

    double ISingleObjectiveProblemDefinition.Evaluate(IRandom random, ParameterVector vector) {
      return Evaluate(random, vector);
    }

    void ISingleObjectiveProblemDefinition.Analyze(ParameterVector[] vectors, double[] qualities, ResultCollection results) {
      Analyze(vectors, qualities, results);
    }

    IEnumerable<ParameterVector> ISingleObjectiveProblemDefinition.GetNeighbors(IRandom random, ParameterVector vector) {
      return Neighbors(random, vector);
    }
    #endregion

    #region INamedItem
    protected string name;
    /// <inheritdoc/>
    /// <remarks>Calls <see cref="OnNameChanging"/> and also <see cref="OnNameChanged"/> 
    /// eventually in the setter.</remarks>
    public string Name {
      get { return name; }
      set {
        if (!CanChangeName) throw new NotSupportedException("Name cannot be changed.");
        if (!(name.Equals(value) || (value == null) && (name == string.Empty))) {
          CancelEventArgs<string> e = value == null ? new CancelEventArgs<string>(string.Empty) : new CancelEventArgs<string>(value);
          OnNameChanging(e);
          if (!e.Cancel) {
            name = value == null ? string.Empty : value;
            OnNameChanged();
          }
        }
      }
    }
    public virtual bool CanChangeName {
      get { return true; }
    }
    protected string description;
    public string Description {
      get { return description; }
      set {
        if (!CanChangeDescription) throw new NotSupportedException("Description cannot be changed.");
        if (!(description.Equals(value) || (value == null) && (description == string.Empty))) {
          description = value == null ? string.Empty : value;
          OnDescriptionChanged();
        }
      }
    }
    public virtual bool CanChangeDescription {
      get { return true; }
    }

    /// <summary>
    /// Gets the string representation of the current instance in the format: <c>Name: [null|Value]</c>.
    /// </summary>
    /// <returns>The current instance as a string.</returns>
    public override string ToString() {
      return Name;
    }

    /// <inheritdoc/>
    public event EventHandler<CancelEventArgs<string>> NameChanging;
    /// <summary>
    /// Fires a new <c>NameChanging</c> event.
    /// </summary>
    /// <param name="e">The event arguments of the changing.</param>
    protected virtual void OnNameChanging(CancelEventArgs<string> e) {
      var handler = NameChanging;
      if (handler != null) handler(this, e);
    }
    /// <inheritdoc/>
    public event EventHandler NameChanged;
    /// <summary>
    /// Fires a new <c>NameChanged</c> event.
    /// </summary>
    /// <remarks>Calls <see cref="ItemBase.OnChanged"/>.</remarks>
    protected virtual void OnNameChanged() {
      var handler = NameChanged;
      if (handler != null) handler(this, EventArgs.Empty);
      OnToStringChanged();
    }
    /// <inheritdoc/>
    public event EventHandler DescriptionChanged;
    /// <summary>
    /// Fires a new <c>DescriptionChanged</c> event.
    /// </summary>
    /// <remarks>Calls <see cref="ItemBase.OnChanged"/>.</remarks>
    protected virtual void OnDescriptionChanged() {
      var handler = DescriptionChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }
    #endregion
    #region IItem
    public virtual string ItemName {
      get { return ItemAttribute.GetName(this.GetType()); }
    }
    public virtual string ItemDescription {
      get { return ItemAttribute.GetDescription(this.GetType()); }
    }
    public Version ItemVersion {
      get { return ItemAttribute.GetVersion(this.GetType()); }
    }
    public static Image StaticItemImage {
      get { return HeuristicLab.Common.Resources.VSImageLibrary.Class; }
    }
    public virtual Image ItemImage {
      get { return ItemAttribute.GetImage(this.GetType()); }
    }
    public object Clone() {
      return Clone(new Cloner());
    }

    public event EventHandler ItemImageChanged;
    protected virtual void OnItemImageChanged() {
      var handler = ItemImageChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }
    public event EventHandler ToStringChanged;
    protected virtual void OnToStringChanged() {
      var handler = ToStringChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }
    #endregion
  }
}