source: trunk/sources/HeuristicLab.Tests/HeuristicLab.Encodings.SymbolicExpressionTreeEncoding-3.4/Grammars.cs @ 7147

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2011 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.Encodings.SymbolicExpressionTreeEncoding;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using HeuristicLab.Problems.DataAnalysis.Symbolic;

namespace HeuristicLab.Encodings.SymbolicExpressionTreeEncoding_3._4.Tests {
  public static class Grammars {
    [StorableClass]
    private class Addition : Symbol {
      private const int minimumArity = 1;
      private const int maximumArity = byte.MaxValue;

      public override int MinimumArity {
        get { return minimumArity; }
      }
      public override int MaximumArity {
        get { return maximumArity; }
      }

      [StorableConstructor]
      protected Addition(bool deserializing) : base(deserializing) { }
      protected Addition(Addition original, Cloner cloner) : base(original, cloner) { }
      public Addition() : base("Addition", "") { }
      public override IDeepCloneable Clone(Cloner cloner) {
        return new Addition(this, cloner);
      }
    }

    [StorableClass]
    private class Subtraction : Symbol {
      private const int minimumArity = 1;
      private const int maximumArity = byte.MaxValue;

      public override int MinimumArity {
        get { return minimumArity; }
      }
      public override int MaximumArity {
        get { return maximumArity; }
      }

      [StorableConstructor]
      protected Subtraction(bool deserializing) : base(deserializing) { }
      protected Subtraction(Subtraction original, Cloner cloner) : base(original, cloner) { }
      public Subtraction() : base("Subtraction", "") { }
      public override IDeepCloneable Clone(Cloner cloner) {
        return new Subtraction(this, cloner);
      }
    }

    [StorableClass]
    private class Multiplication : Symbol {
      private const int minimumArity = 1;
      private const int maximumArity = byte.MaxValue;

      public override int MinimumArity {
        get { return minimumArity; }
      }
      public override int MaximumArity {
        get { return maximumArity; }
      }

      [StorableConstructor]
      protected Multiplication(bool deserializing) : base(deserializing) { }
      protected Multiplication(Multiplication original, Cloner cloner) : base(original, cloner) { }
      public Multiplication() : base("Multiplication", "") { }
      public override IDeepCloneable Clone(Cloner cloner) {
        return new Multiplication(this, cloner);
      }
    }

    [StorableClass]
    private class Division : Symbol {
      private const int minimumArity = 1;
      private const int maximumArity = byte.MaxValue;

      public override int MinimumArity {
        get { return minimumArity; }
      }
      public override int MaximumArity {
        get { return maximumArity; }
      }

      [StorableConstructor]
      protected Division(bool deserializing) : base(deserializing) { }
      protected Division(Division original, Cloner cloner) : base(original, cloner) { }
      public Division() : base("Division", "") { }
      public override IDeepCloneable Clone(Cloner cloner) {
        return new Division(this, cloner);
      }
    }

    [StorableClass]
    private class Terminal : Symbol {
      private const int minimumArity = 0;
      private const int maximumArity = 0;

      public override int MinimumArity {
        get { return minimumArity; }
      }
      public override int MaximumArity {
        get { return maximumArity; }
      }

      [StorableConstructor]
      protected Terminal(bool deserializing) : base(deserializing) { }
      protected Terminal(Terminal original, Cloner cloner) : base(original, cloner) { }
      public Terminal() : base("Terminal", "") { }
      public override IDeepCloneable Clone(Cloner cloner) {
        return new Terminal(this, cloner);
      }

      public override ISymbolicExpressionTreeNode CreateTreeNode() {
        return new TerminalNode(this);
      }
    }

    [StorableClass]
    private class TerminalNode : SymbolicExpressionTreeTerminalNode {
      public override bool HasLocalParameters { get { return true; } }
      private double value;
      protected TerminalNode(TerminalNode original, Cloner cloner)
        : base(original, cloner) {
        this.value = original.value;
      }
      [StorableConstructor]
      protected TerminalNode(bool deserializing) : base(deserializing) { }
      public TerminalNode(Terminal symbol) : base(symbol) { }

      public override IDeepCloneable Clone(Cloner cloner) {
        return new TerminalNode(this, cloner);
      }
      public override void ResetLocalParameters(Core.IRandom random) {
        base.ResetLocalParameters(random);
        value = random.NextDouble();
      }
      public override void ShakeLocalParameters(Core.IRandom random, double shakingFactor) {
        base.ShakeLocalParameters(random, shakingFactor);
        value = random.NextDouble();
      }
      public override string ToString() {
        return value.ToString("E4");
      }
    }

    [StorableClass]
    private class SimpleArithmeticGrammar : SymbolicExpressionGrammar {
      [StorableConstructor]
      protected SimpleArithmeticGrammar(bool deserializing) : base(deserializing) { }
      protected SimpleArithmeticGrammar(SimpleArithmeticGrammar original, Cloner cloner) : base(original, cloner) { }
      public SimpleArithmeticGrammar()
        : base("Grammar for unit tests", "") {
        Initialize();
      }

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

      private void Initialize() {
        var add = new Addition();
        var sub = new Subtraction();
        var mul = new Multiplication();
        var div = new Division();
        div.InitialFrequency = 0.0; // disable division symbol
        var terminal = new Terminal();

        var allSymbols = new List<Symbol>() { add, sub, mul, div, terminal };
        var functionSymbols = new List<Symbol>() { add, sub, mul, div };
        foreach (var symb in allSymbols)
          AddSymbol(symb);

        foreach (var funSymb in functionSymbols) {
          SetSubtreeCount(funSymb, 1, 3);
        }
        SetSubtreeCount(terminal, 0, 0);

        // allow each symbol as child of the start symbol
        foreach (var symb in allSymbols) {
          AddAllowedChildSymbol(StartSymbol, symb);
          AddAllowedChildSymbol(DefunSymbol, symb);
        }

        // allow each symbol as child of every other symbol (except for terminals that have maxSubtreeCount == 0)
        foreach (var parent in functionSymbols) {
          foreach (var child in allSymbols) {
            AddAllowedChildSymbol(parent, child);
          }
        }
      }
    }

    public static ISymbolicExpressionGrammar CreateSimpleArithmeticGrammar() {
      var g = new TypeCoherentExpressionGrammar();
      g.ConfigureAsDefaultRegressionGrammar();
      g.Symbols.OfType<Variable>().First().Enabled = false;
      //var g = new SimpleArithmeticGrammar();
      g.MaximumFunctionArguments = 0;
      g.MinimumFunctionArguments = 0;
      g.MaximumFunctionDefinitions = 0;
      g.MinimumFunctionDefinitions = 0;
      return g;
    }

    public static ISymbolicExpressionGrammar CreateArithmeticAndAdfGrammar() {
      var g = new TypeCoherentExpressionGrammar();
      g.ConfigureAsDefaultRegressionGrammar();
      g.Symbols.OfType<Variable>().First().Enabled = false;
      g.MaximumFunctionArguments = 3;
      g.MinimumFunctionArguments = 0;
      g.MaximumFunctionDefinitions = 3;
      g.MinimumFunctionDefinitions = 0;
      return g;
    }
  }
}