org.logicng.formulas.printer.LatexStringRepresentation Maven / Gradle / Ivy

Go to download
///////////////////////////////////////////////////////////////////////////
//                   __                _      _   ________               //
//                  / /   ____  ____ _(_)____/ | / / ____/               //
//                 / /   / __ \/ __ `/ / ___/  |/ / / __                 //
//                / /___/ /_/ / /_/ / / /__/ /|  / /_/ /                 //
//               /_____/\____/\__, /_/\___/_/ |_/\____/                  //
//                           /____/                                      //
//                                                                       //
//               The Next Generation Logic Library                       //
//                                                                       //
///////////////////////////////////////////////////////////////////////////
//                                                                       //
//  Copyright 2015-20xx Christoph Zengler                                //
//                                                                       //
//  Licensed under the Apache License, Version 2.0 (the "License");      //
//  you may not use this file except in compliance with the License.     //
//  You may obtain a copy of the License at                              //
//                                                                       //
//  http://www.apache.org/licenses/LICENSE-2.0                           //
//                                                                       //
//  Unless required by applicable law or agreed to in writing, software  //
//  distributed under the License is distributed on an "AS IS" BASIS,    //
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or      //
//  implied.  See the License for the specific language governing        //
//  permissions and limitations under the License.                       //
//                                                                       //
///////////////////////////////////////////////////////////////////////////

package org.logicng.formulas.printer;

import org.logicng.formulas.CType;
import org.logicng.formulas.FType;
import org.logicng.formulas.Formula;
import org.logicng.formulas.Literal;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * The LaTeX string representation for formulas.
 * @version 1.1
 * @since 1.0
 */
public final class LatexStringRepresentation extends FormulaStringRepresentation {

    private static final Pattern pattern = Pattern.compile("(.*?)(\\d*)");

    /**
     * Returns the latex string for a variable name
     * @param name the name
     * @return the matching UTF8 symbol
     */
    private static String latexName(final String name) {
        final Matcher matcher = pattern.matcher(name);
        if (!matcher.matches()) {
            return name;
        }
        if (matcher.group(2).isEmpty()) {
            return matcher.group(1);
        }
        return matcher.group(1) + "_{" + matcher.group(2) + "}";
    }

    @Override
    public String toInnerString(final Formula formula) {
        if (formula.type() == FType.LITERAL) {
            final Literal lit = (Literal) formula;
            return lit.phase() ? latexName(lit.name()) : this.negation() + " " + latexName(lit.name());
        }
        return super.toInnerString(formula);
    }

    @Override
    protected String falsum() {
        return "\\bottom";
    }

    @Override
    protected String verum() {
        return "\\top";
    }

    @Override
    protected String negation() {
        return "\\lnot";
    }

    @Override
    protected String implication() {
        return " \\rightarrow ";
    }

    @Override
    protected String equivalence() {
        return " \\leftrightarrow ";
    }

    @Override
    protected String and() {
        return " \\land ";
    }

    @Override
    protected String or() {
        return " \\lor ";
    }

    @Override
    protected String pbComparator(CType comparator) {
        switch (comparator) {
            case EQ:
                return " = ";
            case LE:
                return " \\leq ";
            case LT:
                return " < ";
            case GE:
                return " \\geq ";
            case GT:
                return " > ";
            default:
                throw new IllegalArgumentException("Unknown pseudo-Boolean comparison: " + comparator);
        }
    }

    @Override
    protected String pbMul() {
        return "\\cdot ";
    }

    @Override
    protected String pbAdd() {
        return " + ";
    }

    @Override
    protected String lbr() {
        return "\\left(";
    }

    @Override
    protected String rbr() {
        return "\\right)";
    }

    @Override
    public String toString() {
        return this.getClass().getSimpleName();
    }
}