source: trunk/sources/HeuristicLab.GP.StructureIdentification/3.3/DefaultStructureIdentificationOperators.cs @ 3043

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2008 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 HeuristicLab.DataAnalysis;
using HeuristicLab.GP.Interfaces;
using HeuristicLab.Operators;
using HeuristicLab.Modeling;
using HeuristicLab.Logging;
using HeuristicLab.Selection;
using HeuristicLab.Data;
using System.Collections.Generic;
using System;
using HeuristicLab.GP.Operators;

namespace HeuristicLab.GP.StructureIdentification {
  public static class DefaultStructureIdentificationOperators {
    public static IOperator CreateFunctionLibraryInjector() {
      CombinedOperator op = new CombinedOperator();
      op.Name = "FunctionLibraryInjector";
      SequentialProcessor seq = new SequentialProcessor();
      seq.AddSubOperator(new DefaultFunctionLibraryInjector());
      seq.AddSubOperator(new HL3TreeEvaluatorInjector());
      op.OperatorGraph.AddOperator(seq);
      op.OperatorGraph.InitialOperator = seq;
      return op;
    }

    public static IOperator CreateInitialPopulationEvaluator() {
      CombinedOperator combinedOp = new CombinedOperator();
      combinedOp.Name = "Evaluator";
      SequentialProcessor seq = new SequentialProcessor();

      SimpleEvaluator eval = new SimpleEvaluator();
      eval.GetVariableInfo("Values").ActualName = "TrainingValues";
      eval.GetVariableInfo("SamplesStart").ActualName = "ActualTrainingSamplesStart";
      eval.GetVariableInfo("SamplesEnd").ActualName = "ActualTrainingSamplesEnd";

      LinearScaler scaler = new LinearScaler();
      scaler.GetVariableInfo("Values").ActualName = "TrainingValues";

      SimpleMSEEvaluator mseEval = new SimpleMSEEvaluator();
      mseEval.GetVariableInfo("Values").ActualName = "TrainingValues";
      mseEval.GetVariableInfo("MSE").ActualName = "Quality";

      seq.AddSubOperator(eval);
      seq.AddSubOperator(scaler);
      seq.AddSubOperator(mseEval);
      combinedOp.OperatorGraph.AddOperator(seq);
      combinedOp.OperatorGraph.InitialOperator = seq;
      return combinedOp;
    }

    public static IOperator CreateEvaluator() {
      return CreateInitialPopulationEvaluator();
    }

    public static IOperator CreateGenerationStepHook() {
      CombinedOperator op = new CombinedOperator();
      SequentialProcessor seq = new SequentialProcessor();

      SymbolFrequencyAnalyser symbolFrequencyAnalyser = new SymbolFrequencyAnalyser();
      seq.AddSubOperator(symbolFrequencyAnalyser);

      VariableFrequencyAnalyser varFrequencyAnalyser = new VariableFrequencyAnalyser();
      seq.AddSubOperator(varFrequencyAnalyser);

      UniformSequentialSubScopesProcessor subScopesProc = new UniformSequentialSubScopesProcessor();
      SequentialProcessor individualProc = new SequentialProcessor();
      SimpleEvaluator validationEvaluator = new SimpleEvaluator();
      validationEvaluator.Name = "ValidationEvaluator";
      validationEvaluator.GetVariableInfo("Values").ActualName = "ValidationValues";
      validationEvaluator.GetVariableInfo("SamplesStart").ActualName = "ValidationSamplesStart";
      validationEvaluator.GetVariableInfo("SamplesEnd").ActualName = "ValidationSamplesEnd";
      LinearScaler validationScaler = new LinearScaler();
      validationScaler.GetVariableInfo("Values").ActualName = "ValidationValues";
      SimpleMSEEvaluator mseEval = new SimpleMSEEvaluator();
      mseEval.GetVariableInfo("Values").ActualName = "ValidationValues";
      mseEval.GetVariableInfo("MSE").ActualName = "ValidationQuality";
      individualProc.AddSubOperator(validationEvaluator);
      individualProc.AddSubOperator(validationScaler);
      individualProc.AddSubOperator(mseEval);

      Counter bestValidationSolutionAgeCounter = new Counter();
      bestValidationSolutionAgeCounter.Name = "BestSolutionAgeCounter";
      bestValidationSolutionAgeCounter.GetVariableInfo("Value").ActualName = "BestValidationSolutionAge";

      BestSolutionStorer solutionStorer = new BestSolutionStorer();
      solutionStorer.GetVariableInfo("BestSolution").ActualName = "BestValidationSolution";
      solutionStorer.GetVariableInfo("Quality").ActualName = "ValidationQuality";

      OperatorExtractor bestSolutionProcessor = new OperatorExtractor();
      bestSolutionProcessor.Name = "BestSolutionProcessor (extr.)";
      bestSolutionProcessor.GetVariableInfo("Operator").ActualName = "BestSolutionProcessor";

      solutionStorer.AddSubOperator(bestSolutionProcessor);

      BestAverageWorstQualityCalculator validationQualityCalculator = new BestAverageWorstQualityCalculator();
      validationQualityCalculator.Name = "BestAverageWorstValidationQualityCalculator";
      validationQualityCalculator.GetVariableInfo("Quality").ActualName = "ValidationQuality";
      validationQualityCalculator.GetVariableInfo("BestQuality").ActualName = "BestValidationQuality";
      validationQualityCalculator.GetVariableInfo("AverageQuality").ActualName = "AverageValidationQuality";
      validationQualityCalculator.GetVariableInfo("WorstQuality").ActualName = "WorstValidationQuality";

      subScopesProc.AddSubOperator(individualProc);

      seq.AddSubOperator(subScopesProc);
      seq.AddSubOperator(bestValidationSolutionAgeCounter);
      seq.AddSubOperator(solutionStorer);
      seq.AddSubOperator(validationQualityCalculator);

      op.OperatorGraph.AddOperator(seq);
      op.OperatorGraph.InitialOperator = seq;
      return op;
    }


    public static IOperator CreatePreparationForPostProcessingOperator() {
      SequentialProcessor seq = new SequentialProcessor();
      LeftReducer cleanUp = new LeftReducer();
      cleanUp.Name = "Reset Population";
      seq.AddSubOperator(cleanUp);

      SolutionExtractor extractor = new SolutionExtractor();
      extractor.GetVariableInfo("Scope").ActualName = "BestValidationSolution";
      SequentialSubScopesProcessor seqSubScopeProc = new SequentialSubScopesProcessor();
      SequentialProcessor solutionProc = new SequentialProcessor();

      seq.AddSubOperator(extractor);
      seq.AddSubOperator(seqSubScopeProc);
      seqSubScopeProc.AddSubOperator(solutionProc);

      #region simple evaluators
      SimpleEvaluator trainingEvaluator = new SimpleEvaluator();
      trainingEvaluator.Name = "TrainingEvaluator";
      trainingEvaluator.GetVariableInfo("SamplesStart").ActualName = "TrainingSamplesStart";
      trainingEvaluator.GetVariableInfo("SamplesEnd").ActualName = "TrainingSamplesEnd";
      trainingEvaluator.GetVariableInfo("Values").ActualName = "TrainingValues";
      SimpleEvaluator validationEvaluator = new SimpleEvaluator();
      validationEvaluator.Name = "ValidationEvaluator";
      validationEvaluator.GetVariableInfo("SamplesStart").ActualName = "ValidationSamplesStart";
      validationEvaluator.GetVariableInfo("SamplesEnd").ActualName = "ValidationSamplesEnd";
      validationEvaluator.GetVariableInfo("Values").ActualName = "ValidationValues";
      SimpleEvaluator testEvaluator = new SimpleEvaluator();
      testEvaluator.Name = "TestEvaluator";
      testEvaluator.GetVariableInfo("SamplesStart").ActualName = "TestSamplesStart";
      testEvaluator.GetVariableInfo("SamplesEnd").ActualName = "TestSamplesEnd";
      testEvaluator.GetVariableInfo("Values").ActualName = "TestValues";

      LinearScaler trainingScaler = new LinearScaler();
      trainingScaler.GetVariableInfo("Values").ActualName = "TrainingValues";

      LinearScaler validationScaler = new LinearScaler();
      validationScaler.GetVariableInfo("Values").ActualName = "ValidationValues";

      LinearScaler testScaler = new LinearScaler();
      testScaler.GetVariableInfo("Values").ActualName = "TestValues";

      solutionProc.AddSubOperator(trainingEvaluator);
      solutionProc.AddSubOperator(validationEvaluator);
      solutionProc.AddSubOperator(testEvaluator);
      solutionProc.AddSubOperator(trainingScaler);
      solutionProc.AddSubOperator(validationScaler);
      solutionProc.AddSubOperator(testScaler);
      #endregion

      #region variable impacts
      // calculate and set variable impacts
      VariableNamesExtractor namesExtractor = new VariableNamesExtractor();
      namesExtractor.GetVariableInfo("VariableNames").ActualName = "InputVariableNames";
      LinearScalingPredictorBuilder predictorBuilder = new LinearScalingPredictorBuilder();

      solutionProc.AddSubOperator(namesExtractor);
      solutionProc.AddSubOperator(predictorBuilder);
      VariableQualityImpactCalculator qualityImpactCalculator = new VariableQualityImpactCalculator();
      qualityImpactCalculator.GetVariableInfo("SamplesStart").ActualName = "ValidationSamplesStart";
      qualityImpactCalculator.GetVariableInfo("SamplesEnd").ActualName = "ValidationSamplesEnd";

      solutionProc.AddSubOperator(qualityImpactCalculator);

      NodeBasedVariableImpactCalculator nodeImpactCalculator = new NodeBasedVariableImpactCalculator();
      nodeImpactCalculator.GetVariableInfo("SamplesStart").ActualName = "ValidationSamplesStart";
      nodeImpactCalculator.GetVariableInfo("SamplesEnd").ActualName = "ValidationSamplesEnd";

      solutionProc.AddSubOperator(nodeImpactCalculator);

      VariableFrequencyBasedImpactCalculator frequencyImpactCalculator = new VariableFrequencyBasedImpactCalculator();
      solutionProc.AddSubOperator(frequencyImpactCalculator);

      #endregion

      return seq;
    }

    public static void PopulateAnalyzerModel(IScope bestModelScope, IAnalyzerModel model) {
      model.SetMetaData("EvaluatedSolutions", bestModelScope.GetVariableValue<IntData>("EvaluatedSolutions", false).Data);
      IGeneticProgrammingModel gpModel = bestModelScope.GetVariableValue<IGeneticProgrammingModel>("FunctionTree", false);
      model.SetMetaData("TreeSize", gpModel.Size);
      model.SetMetaData("TreeHeight", gpModel.Height);
      double treeComplexity = TreeComplexityEvaluator.Calculate(gpModel.FunctionTree);
      model.SetMetaData("TreeComplexity", treeComplexity);
      model.SetMetaData("AverageNodeComplexity", treeComplexity / gpModel.Size);
      #region variable impacts
      ItemList qualityImpacts = bestModelScope.GetVariableValue<ItemList>(ModelingResult.VariableQualityImpact.ToString(), false);
      foreach (ItemList row in qualityImpacts) {
        string variableName = ((StringData)row[0]).Data;
        double impact = ((DoubleData)row[1]).Data;
        model.SetVariableResult(ModelingResult.VariableQualityImpact, variableName, impact);
        model.AddInputVariable(variableName);
      }
      ItemList nodeImpacts = bestModelScope.GetVariableValue<ItemList>(ModelingResult.VariableNodeImpact.ToString(), false);
      foreach (ItemList row in nodeImpacts) {
        string variableName = ((StringData)row[0]).Data;
        double impact = ((DoubleData)row[1]).Data;
        model.SetVariableResult(ModelingResult.VariableNodeImpact, variableName, impact);
        model.AddInputVariable(variableName);
      }
      ItemList frequencyImpacts = bestModelScope.GetVariableValue<ItemList>(ModelingResult.RelativeFrequencyVariableImpact.ToString(), false);
      foreach (ItemList row in frequencyImpacts) {
        string variableName = ((StringData)row[0]).Data;
        double impact = ((DoubleData)row[1]).Data;
        model.SetVariableResult(ModelingResult.RelativeFrequencyVariableImpact, variableName, impact);
        model.AddInputVariable(variableName);
      }

      #endregion

    }

  }
}