source: branches/GP-Refactoring-713/sources/HeuristicLab.GP.StructureIdentification/3.3/FunctionLibraryInjector.cs @ 2215

#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 System.Collections.Generic;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.GP.Interfaces;

namespace HeuristicLab.GP.StructureIdentification {
  public class FunctionLibraryInjector : OperatorBase {
    private const string FUNCTIONLIBRARY = "FunctionLibrary";
    private const string TARGETVARIABLE = "TargetVariable";
    private const string MINTIMEOFFSET = "MinTimeOffset";
    private const string MAXTIMEOFFSET = "MaxTimeOffset";

    private const string DIFFERENTIALS_ALLOWED = "Differentials";
    private const string VARIABLES_ALLOWED = "Variables";
    private const string CONSTANTS_ALLOWED = "Constants";
    private const string ADDITION_ALLOWED = "Addition";
    private const string AVERAGE_ALLOWED = "Average";
    private const string AND_ALLOWED = "And";
    private const string COSINUS_ALLOWED = "Cosinus";
    private const string DIVISION_ALLOWED = "Division";
    private const string EQUAL_ALLOWED = "Equal";
    private const string EXPONENTIAL_ALLOWED = "Exponential";
    private const string GREATERTHAN_ALLOWED = "GreaterThan";
    private const string IFTHENELSE_ALLOWED = "IfThenElse";
    private const string LESSTHAN_ALLOWED = "LessThan";
    private const string LOGARTIHM_ALLOWED = "Logarithm";
    private const string MULTIPLICATION_ALLOWED = "Multiplication";
    private const string NOT_ALLOWED = "Not";
    private const string POWER_ALLOWED = "Power";
    private const string OR_ALLOWED = "Or";
    private const string SIGNUM_ALLOWED = "Signum";
    private const string SINUS_ALLOWED = "Sinus";
    private const string SQRT_ALLOWED = "SquareRoot";
    private const string SUBTRACTION_ALLOWED = "Subtraction";
    private const string TANGENS_ALLOWED = "Tangens";
    private const string XOR_ALLOWED = "Xor";


    public override string Description {
      get { return @"Injects a configurable function library for regression and classification problems."; }
    }

    public FunctionLibraryInjector()
      : base() {
      AddVariableInfo(new VariableInfo(TARGETVARIABLE, "The target variable", typeof(IntData), VariableKind.In));
      AddVariableInfo(new VariableInfo(MINTIMEOFFSET, "Minimal time offset for all features", typeof(IntData), VariableKind.In));
      AddVariableInfo(new VariableInfo(MAXTIMEOFFSET, "Maximal time offset for all feature", typeof(IntData), VariableKind.In));
      AddVariableInfo(new VariableInfo(FUNCTIONLIBRARY, "Preconfigured default function library", typeof(FunctionLibrary), VariableKind.New));

      AddVariable(DIFFERENTIALS_ALLOWED, false);
      AddVariable(VARIABLES_ALLOWED, true);
      AddVariable(CONSTANTS_ALLOWED, true);
      AddVariable(ADDITION_ALLOWED, true);
      AddVariable(AVERAGE_ALLOWED, false);
      AddVariable(AND_ALLOWED, true);
      AddVariable(COSINUS_ALLOWED, true);
      AddVariable(DIVISION_ALLOWED, true);
      AddVariable(EQUAL_ALLOWED, true);
      AddVariable(EXPONENTIAL_ALLOWED, true);
      AddVariable(GREATERTHAN_ALLOWED, true);
      AddVariable(IFTHENELSE_ALLOWED, true);
      AddVariable(LESSTHAN_ALLOWED, true);
      AddVariable(LOGARTIHM_ALLOWED, true);
      AddVariable(MULTIPLICATION_ALLOWED, true);
      AddVariable(NOT_ALLOWED, true);
      AddVariable(POWER_ALLOWED, true);
      AddVariable(OR_ALLOWED, true);
      AddVariable(SIGNUM_ALLOWED, true);
      AddVariable(SINUS_ALLOWED, true);
      AddVariable(SQRT_ALLOWED, true);
      AddVariable(SUBTRACTION_ALLOWED, true);
      AddVariable(TANGENS_ALLOWED, true);
      AddVariable(XOR_ALLOWED, false);
    }

    private void AddVariable(string name, bool allowed) {
      AddVariableInfo(new VariableInfo(name, name + " allowed", typeof(BoolData), Core.VariableKind.New));
      GetVariableInfo(name).Local = true;
      AddVariable(new Core.Variable(name, new BoolData(allowed)));
    }

    public override IOperation Apply(IScope scope) {
      FunctionLibrary functionLibrary = new FunctionLibrary();
      int targetVariable = GetVariableValue<IntData>(TARGETVARIABLE, scope, true).Data;

      // try to get minTimeOffset (use 0 as default if not available)
      IItem minTimeOffsetItem = GetVariableValue(MINTIMEOFFSET, scope, true, false);
      int minTimeOffset = minTimeOffsetItem == null ? 0 : ((IntData)minTimeOffsetItem).Data;
      // try to get maxTimeOffset (use 0 as default if not available)
      IItem maxTimeOffsetItem = GetVariableValue(MAXTIMEOFFSET, scope, true, false);
      int maxTimeOffset = maxTimeOffsetItem == null ? 0 : ((IntData)maxTimeOffsetItem).Data;

      Variable variable = new Variable();
      Constant constant = new Constant();
      Differential differential = new Differential();
      Addition addition = new Addition();
      And and = new And();
      Average average = new Average();
      Cosinus cosinus = new Cosinus();
      Division division = new Division();
      Equal equal = new Equal();
      Exponential exponential = new Exponential();
      GreaterThan greaterThan = new GreaterThan();
      IfThenElse ifThenElse = new IfThenElse();
      LessThan lessThan = new LessThan();
      Logarithm logarithm = new Logarithm();
      Multiplication multiplication = new Multiplication();
      Not not = new Not();
      Or or = new Or();
      Power power = new Power();
      Signum signum = new Signum();
      Sinus sinus = new Sinus();
      Sqrt sqrt = new Sqrt();
      Subtraction subtraction = new Subtraction();
      Tangens tangens = new Tangens();
      Xor xor = new Xor();


      List<IFunction> booleanFunctions = new List<IFunction>();
      ConditionalAddFunction(AND_ALLOWED, and, booleanFunctions);
      ConditionalAddFunction(EQUAL_ALLOWED, equal, booleanFunctions);
      ConditionalAddFunction(GREATERTHAN_ALLOWED, greaterThan, booleanFunctions);
      ConditionalAddFunction(LESSTHAN_ALLOWED, lessThan, booleanFunctions);
      ConditionalAddFunction(NOT_ALLOWED, not, booleanFunctions);
      ConditionalAddFunction(OR_ALLOWED, or, booleanFunctions);
      ConditionalAddFunction(XOR_ALLOWED, xor, booleanFunctions);

      List<IFunction> doubleFunctions = new List<IFunction>();
      ConditionalAddFunction(DIFFERENTIALS_ALLOWED, differential, doubleFunctions);
      ConditionalAddFunction(VARIABLES_ALLOWED, variable, doubleFunctions);
      ConditionalAddFunction(CONSTANTS_ALLOWED, constant, doubleFunctions);
      ConditionalAddFunction(ADDITION_ALLOWED, addition, doubleFunctions);
      ConditionalAddFunction(AVERAGE_ALLOWED, average, doubleFunctions);
      ConditionalAddFunction(COSINUS_ALLOWED, cosinus, doubleFunctions);
      ConditionalAddFunction(DIVISION_ALLOWED, division, doubleFunctions);
      ConditionalAddFunction(EXPONENTIAL_ALLOWED, exponential, doubleFunctions);
      ConditionalAddFunction(IFTHENELSE_ALLOWED, ifThenElse, doubleFunctions);
      ConditionalAddFunction(LOGARTIHM_ALLOWED, logarithm, doubleFunctions);
      ConditionalAddFunction(MULTIPLICATION_ALLOWED, multiplication, doubleFunctions);
      ConditionalAddFunction(POWER_ALLOWED, power, doubleFunctions);
      ConditionalAddFunction(SIGNUM_ALLOWED, signum, doubleFunctions);
      ConditionalAddFunction(SINUS_ALLOWED, sinus, doubleFunctions);
      ConditionalAddFunction(SQRT_ALLOWED, sqrt, doubleFunctions);
      ConditionalAddFunction(SUBTRACTION_ALLOWED, subtraction, doubleFunctions);
      ConditionalAddFunction(TANGENS_ALLOWED, tangens, doubleFunctions);

      SetAllowedSubOperators(and, booleanFunctions);
      SetAllowedSubOperators(equal, doubleFunctions);
      SetAllowedSubOperators(greaterThan, doubleFunctions);
      SetAllowedSubOperators(lessThan, doubleFunctions);
      SetAllowedSubOperators(not, booleanFunctions);
      SetAllowedSubOperators(or, booleanFunctions);
      SetAllowedSubOperators(xor, booleanFunctions);
      SetAllowedSubOperators(addition, doubleFunctions);
      SetAllowedSubOperators(average, doubleFunctions);
      SetAllowedSubOperators(cosinus, doubleFunctions);
      SetAllowedSubOperators(division, doubleFunctions);
      SetAllowedSubOperators(exponential, doubleFunctions);
      SetAllowedSubOperators(ifThenElse, 0, booleanFunctions);
      SetAllowedSubOperators(ifThenElse, 1, doubleFunctions);
      SetAllowedSubOperators(ifThenElse, 2, doubleFunctions);
      SetAllowedSubOperators(logarithm, doubleFunctions);
      SetAllowedSubOperators(multiplication, doubleFunctions);
      SetAllowedSubOperators(power, doubleFunctions);
      SetAllowedSubOperators(signum, doubleFunctions);
      SetAllowedSubOperators(sinus, doubleFunctions);
      SetAllowedSubOperators(sqrt, doubleFunctions);
      SetAllowedSubOperators(subtraction, doubleFunctions);
      SetAllowedSubOperators(tangens, doubleFunctions);

      ConditionalAddOperator(DIFFERENTIALS_ALLOWED, functionLibrary, differential);
      ConditionalAddOperator(VARIABLES_ALLOWED, functionLibrary, variable);
      ConditionalAddOperator(CONSTANTS_ALLOWED, functionLibrary, constant);
      ConditionalAddOperator(ADDITION_ALLOWED, functionLibrary, addition);
      ConditionalAddOperator(AVERAGE_ALLOWED, functionLibrary, average);
      ConditionalAddOperator(AND_ALLOWED, functionLibrary, and);
      ConditionalAddOperator(COSINUS_ALLOWED, functionLibrary, cosinus);
      ConditionalAddOperator(DIVISION_ALLOWED, functionLibrary, division);
      ConditionalAddOperator(EQUAL_ALLOWED, functionLibrary, equal);
      ConditionalAddOperator(EXPONENTIAL_ALLOWED, functionLibrary, exponential);
      ConditionalAddOperator(GREATERTHAN_ALLOWED, functionLibrary, greaterThan);
      ConditionalAddOperator(IFTHENELSE_ALLOWED, functionLibrary, ifThenElse);
      ConditionalAddOperator(LESSTHAN_ALLOWED, functionLibrary, lessThan);
      ConditionalAddOperator(LOGARTIHM_ALLOWED, functionLibrary, logarithm);
      ConditionalAddOperator(MULTIPLICATION_ALLOWED, functionLibrary, multiplication);
      ConditionalAddOperator(NOT_ALLOWED, functionLibrary, not);
      ConditionalAddOperator(POWER_ALLOWED, functionLibrary, power);
      ConditionalAddOperator(OR_ALLOWED, functionLibrary, or);
      ConditionalAddOperator(SIGNUM_ALLOWED, functionLibrary, signum);
      ConditionalAddOperator(SINUS_ALLOWED, functionLibrary, sinus);
      ConditionalAddOperator(SQRT_ALLOWED, functionLibrary, sqrt);
      ConditionalAddOperator(SUBTRACTION_ALLOWED, functionLibrary, subtraction);
      ConditionalAddOperator(TANGENS_ALLOWED, functionLibrary, tangens);
      ConditionalAddOperator(XOR_ALLOWED, functionLibrary, xor);

      variable.SetConstraints(minTimeOffset, maxTimeOffset);
      differential.SetConstraints(minTimeOffset, maxTimeOffset);

      scope.AddVariable(new HeuristicLab.Core.Variable(scope.TranslateName(FUNCTIONLIBRARY), functionLibrary));

      return null;
    }

    private void ConditionalAddFunction(string condName, IFunction fun, List<IFunction> list) {
      if (GetVariableValue<BoolData>(condName, null, false).Data) list.Add(fun);
    }

    private void ConditionalAddOperator(string condName, FunctionLibrary functionLib, IFunction op) {
      if (GetVariableValue<BoolData>(condName, null, false).Data) functionLib.AddFunction(op);
    }

    private void SetAllowedSubOperators(IFunction f, List<IFunction> gs) {
      for (int i = 0; i < f.MaxSubTrees; i++) {
        SetAllowedSubOperators(f, i, gs);
      }
    }

    private void SetAllowedSubOperators(IFunction f, int i, List<IFunction> gs) {
      gs.ForEach((g) => f.AddAllowedSubFunction(g, i));
    }
  }
}