source: trunk/sources/HeuristicLab.Problems.ExternalEvaluation.GP/3.4/ExternalEvaluationSymbolicExpressionTreeStringFormatter.cs @ 6452

#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.Text;
using System.Linq;
using HeuristicLab.Core;
using HeuristicLab.Common;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using HeuristicLab.Encodings.SymbolicExpressionTreeEncoding;
using HeuristicLab.Problems.DataAnalysis.Symbolic;
using System;

namespace HeuristicLab.Problems.ExternalEvaluation.GP {

  [Item("ExternalEvaluationSymbolicExpressionTreeStringFormatter", "A string formatter for symbolic expression trees for external evaluation.")]
  [StorableClass]
  public class ExternalEvaluationSymbolicExpressionTreeStringFormatter : NamedItem, ISymbolicExpressionTreeStringFormatter {

    public bool Indent { get; set; }

    [StorableConstructor]
    protected ExternalEvaluationSymbolicExpressionTreeStringFormatter(bool deserializing) : base(deserializing) { }
    protected ExternalEvaluationSymbolicExpressionTreeStringFormatter(ExternalEvaluationSymbolicExpressionTreeStringFormatter original, Cloner cloner)
      : base(original, cloner) {
      Indent = original.Indent;
    }
    public ExternalEvaluationSymbolicExpressionTreeStringFormatter()
      : base() {
      Name = "External Evaluation Symbolic Expression Tree Formatter";
      Indent = true;
    }

    public string Format(ISymbolicExpressionTree symbolicExpressionTree) {
      // skip root and start symbols
      return FormatRecursively(symbolicExpressionTree.Root.GetSubtree(0).GetSubtree(0), 0);
    }

    private string FormatRecursively(ISymbolicExpressionTreeNode node, int indentLength) {
      StringBuilder strBuilder = new StringBuilder();
      if (Indent) strBuilder.Append(' ', indentLength);
      strBuilder.Append("(");
      // internal nodes or leaf nodes?
      if (node.Subtrees.Count() > 0) {
        // symbol on same line as '('
        if (node.Symbol is Addition) {
          strBuilder.AppendLine("+");
        } else if (node.Symbol is And) {
          strBuilder.AppendLine("&&");
        } else if (node.Symbol is Average) {
          strBuilder.AppendLine("avg");
        } else if (node.Symbol is Cosine) {
          strBuilder.AppendLine("cos");
        } else if (node.Symbol is Division) {
          strBuilder.AppendLine("/");
        } else if (node.Symbol is Exponential) {
          strBuilder.AppendLine("exp");
        } else if (node.Symbol is GreaterThan) {
          strBuilder.AppendLine(">");
        } else if (node.Symbol is IfThenElse) {
          strBuilder.AppendLine("if");
        } else if (node.Symbol is LessThan) {
          strBuilder.AppendLine("<");
        } else if (node.Symbol is Logarithm) {
          strBuilder.AppendLine("ln");
        } else if (node.Symbol is Multiplication) {
          strBuilder.AppendLine("*");
        } else if (node.Symbol is Not) {
          strBuilder.AppendLine("!");
        } else if (node.Symbol is Or) {
          strBuilder.AppendLine("||");
        } else if (node.Symbol is Sine) {
          strBuilder.AppendLine("sin");
        } else if (node.Symbol is Subtraction) {
          strBuilder.AppendLine("-");
        } else if (node.Symbol is Tangent) {
          strBuilder.AppendLine("tan");
        } else {
          throw new NotSupportedException("Formatting of symbol: " + node.Symbol + " not supported for external evaluation.");
        }
        // each subtree expression on a new line
        // and closing ')' also on new line

        foreach (var subtree in node.Subtrees) {
          strBuilder.AppendLine(FormatRecursively(subtree, indentLength + 2));
        }
        if (Indent) strBuilder.Append(' ', indentLength);
        strBuilder.Append(")");
      } else {
        if (node is VariableTreeNode) {
          var varNode = node as VariableTreeNode;
          // symbol in the same line with as '(' and ')'
          strBuilder.Append(";" + varNode.VariableName + ";" + varNode.Weight.ToString("E4"));
          strBuilder.Append(")");
        } else if (node is ConstantTreeNode) {
          var constNode = node as ConstantTreeNode;
          // symbol in the same line with as '(' and ')'
          strBuilder.Append(";" + constNode.Value.ToString("E4"));
          strBuilder.Append(")");
        } else {
          throw new NotSupportedException("Formatting of symbol: " + node.Symbol + " not supported for external evaluation.");
        }
      }
      return strBuilder.ToString();
    }

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