source: branches/3073_IA_constraint_splitting_reintegration/HeuristicLab.Problems.DataAnalysis.Views/3.4/Regression/ShapeConstraintsView.cs @ 17894

#region License Information

/* HeuristicLab
 * Copyright (C) 2002-2019 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.Drawing;
using System.Text;
using System.Windows.Forms;
using HeuristicLab.Collections;
using HeuristicLab.MainForm;
using HeuristicLab.MainForm.WindowsForms;

namespace HeuristicLab.Problems.DataAnalysis.Views {
  [View("ShapeConstraints View")]
  [Content(typeof(ShapeConstraints), true)]
  public partial class ShapeConstraintsView : AsynchronousContentView {
    public new ShapeConstraints Content {
      get => (ShapeConstraints)base.Content;
      set => base.Content = value;
    }

    public bool suspendUpdates = false;

    public ShapeConstraintsView() {
      InitializeComponent();
      errorOutput.Text = "";
    }

    protected override void OnContentChanged() {
      base.OnContentChanged();
      this.intervalConstraintsView.Content = Content;
      UpdateControl();
    }

    protected override void RegisterContentEvents() {
      base.RegisterContentEvents();
      Content.ItemsAdded += constraints_Added;
      Content.ItemsRemoved += constraint_Removed;
      Content.Changed += Content_Changed;
      Content.CollectionReset += constraints_Reset;
      Content.ItemsMoved += constraints_Moved;
      Content.ItemsReplaced += Content_ItemsReplaced;
      Content.CheckedItemsChanged += Content_CheckedItemsChanged;
    }


    protected override void DeregisterContentEvents() {
      Content.ItemsAdded -= constraints_Added;
      Content.ItemsRemoved -= constraint_Removed;
      Content.Changed -= Content_Changed;
      Content.CollectionReset -= constraints_Reset;
      Content.ItemsMoved -= constraints_Moved;
      Content.ItemsReplaced -= Content_ItemsReplaced;
      Content.CheckedItemsChanged -= Content_CheckedItemsChanged;
      base.DeregisterContentEvents();
    }

    protected override void SetEnabledStateOfControls() {
      constraintsInput.Enabled = Content != null && !Locked && !ReadOnly;
    }


    private void parseBtn_Click(object sender, EventArgs e) {
      if (constraintsInput.Text != null) {
        suspendUpdates = true;
        Content.Clear();
        try {
          var parsedConstraints = ShapeConstraintsParser.ParseConstraints(constraintsInput.Text);
          Content = parsedConstraints;
          errorOutput.Text = "Constraints successfully parsed.";
          errorOutput.ForeColor = Color.DarkGreen;
          //Catch the exception from the constraints parser and show it in the error dialog
        } catch (ArgumentException ex) {
          Content.Clear();
          errorOutput.Text = ex.Message.Replace("Parameter name", "@Line");
          errorOutput.ForeColor = Color.DarkRed;
        }
        suspendUpdates = false;
        UpdateControl();
      } else {
        errorOutput.Text = "No constraints were found!";
      }
    }

    private void UpdateControl() {
      if (suspendUpdates) return;
      if (Content == null) {
        constraintsInput.Text = string.Empty;
      } else {
        this.intervalConstraintsView.Content = Content;
        constraintsInput.Text = ToString(Content);
      }
    }

    private string ToString(ShapeConstraints constraints) {
      var sb = new StringBuilder();
      foreach (var constraint in constraints) {
        if (!constraints.ItemChecked(constraint)) {
          sb.Append("# ").AppendLine(constraint.ToString());
        } else {
          sb.AppendLine(constraint.ToString());
        }
      }
      return sb.ToString();
    }

    private void constraint_Changed(object sender, EventArgs e) {
      UpdateControl();
    }

    private void constraints_Added(object sender,
                                     CollectionItemsChangedEventArgs<IndexedItem<ShapeConstraint>> e) {
      foreach (var addedItem in e.Items) addedItem.Value.Changed += constraint_Changed;
      UpdateControl();
    }

    private void constraint_Removed(object sender, CollectionItemsChangedEventArgs<IndexedItem<ShapeConstraint>> e) {
      foreach (var removedItem in e.Items) removedItem.Value.Changed -= constraint_Changed;
      UpdateControl();
    }

    private void constraints_Moved(object sender, CollectionItemsChangedEventArgs<IndexedItem<ShapeConstraint>> e) {
      UpdateControl();
    }

    private void constraints_Reset(object sender, CollectionItemsChangedEventArgs<IndexedItem<ShapeConstraint>> e) {
      foreach (var addedItem in e.Items) addedItem.Value.Changed += constraint_Changed;
      foreach (var removedItem in e.OldItems) removedItem.Value.Changed -= constraint_Changed;
      UpdateControl();
    }

    private void Content_CheckedItemsChanged(object sender, CollectionItemsChangedEventArgs<IndexedItem<ShapeConstraint>> e) {
      UpdateControl();
    }

    private void Content_ItemsReplaced(object sender, CollectionItemsChangedEventArgs<IndexedItem<ShapeConstraint>> e) {
      foreach (var addedItem in e.Items) addedItem.Value.Changed += constraint_Changed;
      foreach (var removedItem in e.OldItems) removedItem.Value.Changed -= constraint_Changed;
      UpdateControl();
    }

    private void constraintsInput_TextChanged(object sender, EventArgs e) {
      errorOutput.Text = "Unparsed changes! Press parse button to save changes.";
      errorOutput.ForeColor = Color.DarkOrange;
    }

    private void Content_Changed(object sender, EventArgs e) {
      UpdateControl();
    }

    private void label1_DoubleClick(object sender, EventArgs e) {
      var infoText =
        "Within the text field you can define different types of shape constraints e.g. range constraints, monotonicity constraints, ..." +
        System.Environment.NewLine +
        "To define a model constraint: f in [0 .. 100], f is used for the selected target, the 'in' key word specifies the target in which the constraint should be, the interval is defined between square bracket." +
        System.Environment.NewLine +
        "The interval contains two bounds (lower and upper) this bounds are given as double values, to seperate both bounds from each other you can use (.., ;, ' ')" +
        System.Environment.NewLine +
        "To define monotonic or concave constraints you need to define the partial derivatives:" +
        System.Environment.NewLine +
        "∂f/∂x in [0 .. 1], therefore you have to define the partial fraction first, which can be done by using the \\partial symbol or 'd' followed by the target and the variable in the numerator and denominator respectively, after defining the fraction the interval is defined like in the model constraint." +
        System.Environment.NewLine +
        "To define constraints only on a specific range of the function you can define interval ranges" +
        System.Environment.NewLine +
        "f in [0 .. 100], x in [0 .. 1] the ranges are separated by commas and follow the same rules as before (giving the variable with the interval definition)" +
        System.Environment.NewLine + "To specify different weights on the constraints:" +
        System.Environment.NewLine + "f in [0 .. 100], x in [0 .. 1] weight: 2.0, you can add the keyword 'weight:' followed by a double value.";

      MessageBox.Show(infoText,"How to define shape constraints", MessageBoxButtons.OKCancel);
    }
  }
}