source: branches/2971_named_intervals/HeuristicLab.Problems.DataAnalysis/3.4/Implementation/Classification/ClassificationEnsembleModel.cs @ 16628

#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 System.Collections.Generic;
using System.Linq;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using HEAL.Attic;

namespace HeuristicLab.Problems.DataAnalysis {
  /// <summary>
  /// Represents classification solutions that contain an ensemble of multiple classification models
  /// </summary>
  [StorableType("7EA6E802-999D-4432-A13F-0DCBC1A4F8FB")]
  [Item("ClassificationEnsembleModel", "A classification model that contains an ensemble of multiple classification models")]
  public class ClassificationEnsembleModel : ClassificationModel, IClassificationEnsembleModel {
    public override IEnumerable<string> VariablesUsedForPrediction {
      get { return models.SelectMany(x => x.VariablesUsedForPrediction).Distinct().OrderBy(x => x); }
    }

    [Storable]
    private List<IClassificationModel> models;
    public IEnumerable<IClassificationModel> Models {
      get { return new List<IClassificationModel>(models); }
    }

    [StorableConstructor]
    protected ClassificationEnsembleModel(StorableConstructorFlag _) : base(_) { }
    protected ClassificationEnsembleModel(ClassificationEnsembleModel original, Cloner cloner)
      : base(original, cloner) {
      this.models = original.Models.Select(m => cloner.Clone(m)).ToList();
    }

    public ClassificationEnsembleModel() : this(Enumerable.Empty<IClassificationModel>()) { }
    public ClassificationEnsembleModel(IEnumerable<IClassificationModel> models)
      : base(string.Empty) {
      this.name = ItemName;
      this.description = ItemDescription;
      this.models = new List<IClassificationModel>(models);

      if (this.models.Any()) this.TargetVariable = this.models.First().TargetVariable;
    }

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

    public void Add(IClassificationModel model) {
      if (string.IsNullOrEmpty(TargetVariable)) TargetVariable = model.TargetVariable;
      models.Add(model);
    }
    public void Remove(IClassificationModel model) {
      models.Remove(model);
      if (!models.Any()) TargetVariable = string.Empty;
    }

    public IEnumerable<IEnumerable<double>> GetEstimatedClassValueVectors(IDataset dataset, IEnumerable<int> rows) {
      var estimatedValuesEnumerators = (from model in models
                                        select model.GetEstimatedClassValues(dataset, rows).GetEnumerator())
                                       .ToList();

      while (estimatedValuesEnumerators.All(en => en.MoveNext())) {
        yield return from enumerator in estimatedValuesEnumerators
                     select enumerator.Current;
      }
    }


    public override IEnumerable<double> GetEstimatedClassValues(IDataset dataset, IEnumerable<int> rows) {
      foreach (var estimatedValuesVector in GetEstimatedClassValueVectors(dataset, rows)) {
        // return the class which is most often occuring
        yield return
          estimatedValuesVector
          .GroupBy(x => x)
          .OrderBy(g => -g.Count())
          .Select(g => g.Key)
          .First();
      }
    }

    public override IClassificationSolution CreateClassificationSolution(IClassificationProblemData problemData) {
      return new ClassificationEnsembleSolution(models, new ClassificationEnsembleProblemData(problemData));
    }


  }
}