org.logicng.io.writers.FormulaDimacsFileWriter 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.io.writers;

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

import java.io.BufferedWriter;
import java.io.File;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.SortedMap;
import java.util.TreeMap;
import java.util.TreeSet;

/**
 * A dimacs file writer for a formula.  Writes the internal data structure of the formula to a dimacs file.
 * @version 2.4.0
 * @since 1.2
 */
public final class FormulaDimacsFileWriter {

    private static final String CNF_EXTENSION = ".cnf";
    private static final String MAP_EXTENSION = ".map";

    /**
     * Private constructor.
     */
    private FormulaDimacsFileWriter() {
        // Intentionally left empty.
    }

    /**
     * Writes a given formula's internal data structure as a dimacs file.  Must only be called with a formula which is in CNF.
     * @param fileName     the file name of the dimacs file to write, will be extended by suffix {@code .cnf} if not already present
     * @param formula      the formula in CNF
     * @param writeMapping indicates whether an additional file for translating the ids to variable names shall be written
     * @throws IOException              if there was a problem writing the file
     * @throws IllegalArgumentException if the formula was not in CNF
     */
    public static void write(final String fileName, final Formula formula, final boolean writeMapping) throws IOException {
        final File file = new File(fileName.endsWith(CNF_EXTENSION) ? fileName : fileName + CNF_EXTENSION);
        final SortedMap var2id = new TreeMap<>();
        long i = 1;
        for (final Variable var : new TreeSet<>(formula.variables())) {
            var2id.put(var, i++);
        }
        if (!formula.isCNF()) {
            throw new IllegalArgumentException("Cannot write a non-CNF formula to dimacs.  Convert to CNF first.");
        }
        final List parts = new ArrayList<>();
        if (formula.type().equals(FType.LITERAL) || formula.type().equals(FType.OR)) {
            parts.add(formula);
        } else {
            for (final Formula part : formula) {
                parts.add(part);
            }
        }
        final StringBuilder sb = new StringBuilder("p cnf ");
        final int partsSize = formula.type().equals(FType.FALSE) ? 1 : parts.size();
        sb.append(var2id.size()).append(" ").append(partsSize).append(System.lineSeparator());

        for (final Formula part : parts) {
            for (final Literal lit : part.literals()) {
                sb.append(lit.phase() ? "" : "-").append(var2id.get(lit.variable())).append(" ");
            }
            sb.append(String.format(" 0%n"));
        }
        if (formula.type().equals(FType.FALSE)) {
            sb.append(String.format("0%n"));
        }
        try (final BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(Files.newOutputStream(file.toPath()), StandardCharsets.UTF_8))) {
            writer.append(sb);
            writer.flush();
        }
        if (writeMapping) {
            final String mappingFileName = (fileName.endsWith(CNF_EXTENSION) ? fileName.substring(0, fileName.length() - 4) : fileName) + MAP_EXTENSION;
            writeMapping(new File(mappingFileName), var2id);
        }
    }

    private static void writeMapping(final File mappingFile, final SortedMap var2id) throws IOException {
        final StringBuilder sb = new StringBuilder();
        for (final Map.Entry entry : var2id.entrySet()) {
            sb.append(entry.getKey()).append(";").append(entry.getValue()).append(System.lineSeparator());
        }
        try (final BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(Files.newOutputStream(mappingFile.toPath()), StandardCharsets.UTF_8))) {
            writer.append(sb);
            writer.flush();
        }
    }
}