source: trunk/sources/HeuristicLab.Problems.DataAnalysis/3.4/Implementation/Regression/RegressionProblemData.cs @ 14429

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2016 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.Linq;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;

namespace HeuristicLab.Problems.DataAnalysis {
  [StorableClass]
  [Item("RegressionProblemData", "Represents an item containing all data defining a regression problem.")]
  public class RegressionProblemData : DataAnalysisProblemData, IRegressionProblemData, IStorableContent {
    protected const string TargetVariableParameterName = "TargetVariable";
    public string Filename { get; set; }

    #region default data
    private static double[,] kozaF1 = new double[,] {
          {2.017885919, -1.449165046},
          {1.30060506,  -1.344523885},
          {1.147134798, -1.317989331},
          {0.877182504, -1.266142284},
          {0.852562452, -1.261020794},
          {0.431095788, -1.158793317},
          {0.112586002, -1.050908405},
          {0.04594507,  -1.021989402},
          {0.042572879, -1.020438113},
          {-0.074027291,  -0.959859562},
          {-0.109178553,  -0.938094706},
          {-0.259721109,  -0.803635355},
          {-0.272991057,  -0.387519561},
          {-0.161978191,  -0.193611001},
          {-0.102489983,  -0.114215349},
          {-0.01469968, -0.014918985},
          {-0.008863365,  -0.008942626},
          {0.026751057, 0.026054094},
          {0.166922436, 0.14309643},
          {0.176953808, 0.1504144},
          {0.190233418, 0.159916534},
          {0.199800708, 0.166635331},
          {0.261502822, 0.207600348},
          {0.30182879,  0.232370249},
          {0.83763905,  0.468046718}
    };
    private static readonly Dataset defaultDataset;
    private static readonly IEnumerable<string> defaultAllowedInputVariables;
    private static readonly string defaultTargetVariable;

    private static readonly RegressionProblemData emptyProblemData;
    public static RegressionProblemData EmptyProblemData {
      get { return emptyProblemData; }
    }

    static RegressionProblemData() {
      defaultDataset = new Dataset(new string[] { "y", "x" }, kozaF1);
      defaultDataset.Name = "Fourth-order Polynomial Function Benchmark Dataset";
      defaultDataset.Description = "f(x) = x^4 + x^3 + x^2 + x^1";
      defaultAllowedInputVariables = new List<string>() { "x" };
      defaultTargetVariable = "y";

      var problemData = new RegressionProblemData();
      problemData.Parameters.Clear();
      problemData.Name = "Empty Regression ProblemData";
      problemData.Description = "This ProblemData acts as place holder before the correct problem data is loaded.";
      problemData.isEmpty = true;

      problemData.Parameters.Add(new FixedValueParameter<Dataset>(DatasetParameterName, "", new Dataset()));
      problemData.Parameters.Add(new FixedValueParameter<ReadOnlyCheckedItemList<StringValue>>(InputVariablesParameterName, ""));
      problemData.Parameters.Add(new FixedValueParameter<IntRange>(TrainingPartitionParameterName, "", (IntRange)new IntRange(0, 0).AsReadOnly()));
      problemData.Parameters.Add(new FixedValueParameter<IntRange>(TestPartitionParameterName, "", (IntRange)new IntRange(0, 0).AsReadOnly()));
      problemData.Parameters.Add(new ConstrainedValueParameter<StringValue>(TargetVariableParameterName, new ItemSet<StringValue>()));
      emptyProblemData = problemData;
    }
    #endregion

    public IConstrainedValueParameter<StringValue> TargetVariableParameter {
      get { return (IConstrainedValueParameter<StringValue>)Parameters[TargetVariableParameterName]; }
    }
    public string TargetVariable {
      get { return TargetVariableParameter.Value.Value; }
      set {
        if (value == null) throw new ArgumentNullException("targetVariable", "The provided value for the targetVariable is null.");
        if (value == TargetVariable) return;

        var matchingParameterValue = TargetVariableParameter.ValidValues.FirstOrDefault(v => v.Value == value);
        if (matchingParameterValue == null) throw new ArgumentException("The provided value is not valid as the targetVariable.", "targetVariable");
        TargetVariableParameter.Value = matchingParameterValue;
      }
    }

    public IEnumerable<double> TargetVariableValues {
      get { return Dataset.GetDoubleValues(TargetVariable); }
    }
    public IEnumerable<double> TargetVariableTrainingValues {
      get { return Dataset.GetDoubleValues(TargetVariable, TrainingIndices); }
    }
    public IEnumerable<double> TargetVariableTestValues {
      get { return Dataset.GetDoubleValues(TargetVariable, TestIndices); }
    }


    [StorableConstructor]
    protected RegressionProblemData(bool deserializing) : base(deserializing) { }
    [StorableHook(HookType.AfterDeserialization)]
    private void AfterDeserialization() {
      RegisterParameterEvents();
    }

    protected RegressionProblemData(RegressionProblemData original, Cloner cloner)
      : base(original, cloner) {
      RegisterParameterEvents();
    }
    public override IDeepCloneable Clone(Cloner cloner) {
      if (this == emptyProblemData) return emptyProblemData;
      return new RegressionProblemData(this, cloner);
    }

    public RegressionProblemData()
      : this(defaultDataset, defaultAllowedInputVariables, defaultTargetVariable) {
    }
    public RegressionProblemData(IRegressionProblemData regressionProblemData)
      : this(regressionProblemData.Dataset, regressionProblemData.AllowedInputVariables, regressionProblemData.TargetVariable) {
      TrainingPartition.Start = regressionProblemData.TrainingPartition.Start;
      TrainingPartition.End = regressionProblemData.TrainingPartition.End;
      TestPartition.Start = regressionProblemData.TestPartition.Start;
      TestPartition.End = regressionProblemData.TestPartition.End;
    }

    public RegressionProblemData(IDataset dataset, IEnumerable<string> allowedInputVariables, string targetVariable, IEnumerable<ITransformation> transformations = null)
      : base(dataset, allowedInputVariables, transformations ?? Enumerable.Empty<ITransformation>()) {
      var variables = InputVariables.Select(x => x.AsReadOnly()).ToList();
      Parameters.Add(new ConstrainedValueParameter<StringValue>(TargetVariableParameterName, new ItemSet<StringValue>(variables), variables.Where(x => x.Value == targetVariable).First()));
      RegisterParameterEvents();
    }

    private void RegisterParameterEvents() {
      TargetVariableParameter.ValueChanged += new EventHandler(TargetVariableParameter_ValueChanged);
    }
    private void TargetVariableParameter_ValueChanged(object sender, EventArgs e) {
      OnChanged();
    }

    protected override bool IsProblemDataCompatible(IDataAnalysisProblemData problemData, out string errorMessage) {
      if (problemData == null) throw new ArgumentNullException("problemData", "The provided problemData is null.");
      IRegressionProblemData regressionProblemData = problemData as IRegressionProblemData;
      if (regressionProblemData == null)
        throw new ArgumentException("The problem data is not a regression problem data. Instead a " + problemData.GetType().GetPrettyName() + " was provided.", "problemData");

      var returnValue = base.IsProblemDataCompatible(problemData, out errorMessage);
      //check targetVariable
      if (problemData.InputVariables.All(var => var.Value != TargetVariable)) {
        errorMessage = string.Format("The target variable {0} is not present in the new problem data.", TargetVariable)
                       + Environment.NewLine + errorMessage;
        return false;
      }
      return returnValue;
    }

    public override void AdjustProblemDataProperties(IDataAnalysisProblemData problemData) {
      if (problemData == null) throw new ArgumentNullException("problemData", "The provided problemData is null.");
      RegressionProblemData regressionProblemData = problemData as RegressionProblemData;
      if (regressionProblemData == null)
        throw new ArgumentException("The problem data is not a regression problem data. Instead a " + problemData.GetType().GetPrettyName() + " was provided.", "problemData");

      base.AdjustProblemDataProperties(problemData);
      TargetVariable = regressionProblemData.TargetVariable;
    }
  }
}