nl.uu.cs.ape.models.sltlxStruc.SLTLxFormula Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of APE Show documentation

APE is a command line tool and an API for the automated exploration of possible computational pipelines (workflows) from large collections of computational tools.

There is a newer version: 2.3.0

Show newest version

package nl.uu.cs.ape.models.sltlxStruc;

import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;

import nl.uu.cs.ape.utils.APEFiles;
import nl.uu.cs.ape.solver.minisat.SATSynthesisEngine;

/**
 * Abstract class that represents any SLTLx formula.
 * 
 * @author Vedran Kasalica
 *
 */
public abstract class SLTLxFormula implements SLTLxElem {

	protected SLTLxFormula() {
	}

	/**
	 * Encode a collection of SLTLx formulas to CNF and append it to the existing
	 * CNF file. It adds the encoding at the end of the content of the file.
	 * 
	 * @param file            - existing cnf file
	 * @param synthesisEngine synthesis engine used for encoding
	 * @param formulas        - collection of formulas that should be encoded
	 * @throws IOException Thrown in case of an I/O error.
	 */
	public static void appendCNFToFile(File file, SATSynthesisEngine synthesisEngine, Collection formulas)
			throws IOException {
		StringBuilder cnf = new StringBuilder();
		createCNFEncoding(formulas, 0, synthesisEngine)
				.forEach(clause -> cnf.append(clause));
		APEFiles.appendToFile(file, cnf.toString());
	}

	/**
	 * Create the CNF encoding of the facts and return the set of corresponding
	 * clauses in String format.
	 * 
	 * @param facts           - all facts that should be encoded
	 * @param synthesisEngine - synthesis engine used for encoding
	 * @return Set of clauses in String format that encode the given collector of
	 *         formulas.
	 */
	private static Set createCNFEncoding(Collection facts, int stateNo,
			SATSynthesisEngine synthesisEngine) {
		Set clauses = new HashSet<>();
		facts.forEach(fact -> clauses
				.addAll(fact.getCNFEncoding(stateNo, new SLTLxVariableSubstitutionCollection(), synthesisEngine)));
		return clauses;
	}

	/**
	 * Get string that represents the CNF encoding of the constraint. The encoding
	 * assumes that the constraint should be valid for the whole workflow.
	 * 
	 * @param synthesisEngine
	 * @return
	 */
	public Set getConstraintCNFEncoding(SATSynthesisEngine synthesisEngine) {
		return this.getCNFEncoding(0, new SLTLxVariableSubstitutionCollection(), synthesisEngine);
	}

}