net.automatalib.modelchecker.ltsmin.LTSminAlternating Maven / Gradle / Ivy

/* Copyright (C) 2013-2023 TU Dortmund
 * This file is part of AutomataLib, http://www.automatalib.net/.
 *
 * 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 net.automatalib.modelchecker.ltsmin;

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

import net.automatalib.alphabet.Alphabets;
import net.automatalib.automaton.transducer.CompactMealy;
import net.automatalib.automaton.transducer.MealyMachine;
import net.automatalib.serialization.etf.writer.Mealy2ETFWriterAlternating;
import net.automatalib.serialization.fsm.parser.FSM2MealyParserAlternating;

/**
 * A model checker using LTSmin for Mealy machines using alternating edge semantics.
 * 
 * The implementation uses {@link FSM2MealyParserAlternating}, and {@link Mealy2ETFWriterAlternating}, to read the
 * {@link MealyMachine}, and write the {@link MealyMachine} respectively.
 *
 * @param 
 *         the input type.
 * @param 
 *         the output type.
 * @param 
 *         the type of counterexample
 */
public interface LTSminAlternating extends LTSminMealy {

    /**
     * Whether this model checker requires the original Mealy machine to read the Mealy machines from an FSM.
     *
     * @return whether the original automaton is required.
     */
    boolean requiresOriginalAutomaton();

    @Override
    default CompactMealy fsm2Mealy(File fsm,
                                         MealyMachine originalAutomaton,
                                         Collection inputs) throws IOException {

        // Here we optionally provide the parse method with the original automaton. So that an implementation can
        // decide whether undefined outputs are allowed in the fsm or not.
        // If the original automaton is not required, yet there is an undefined output in the FSM an exception will
        // be thrown.
        return FSM2MealyParserAlternating.getParser(inputs,
                                                    requiresOriginalAutomaton() ? originalAutomaton : null,
                                                    getString2Input(),
                                                    getString2Output()).readModel(fsm);
    }

    @Override
    default void mealy2ETF(MealyMachine automaton, Collection inputs, File etf)
            throws IOException {
        Mealy2ETFWriterAlternating.getInstance().writeModel(etf, automaton, Alphabets.fromCollection(inputs));
    }
}