diff --git a/alib2data/src/automaton/PDA/DPDA.h b/alib2data/src/automaton/PDA/DPDA.h
index ef71e34129e12837e2b88c8f44d75c4841050f71..f71340af57b2b5a03e0624a43f759c98b08b2c47 100644
--- a/alib2data/src/automaton/PDA/DPDA.h
+++ b/alib2data/src/automaton/PDA/DPDA.h
@@ -54,33 +54,28 @@ class States;
class FinalStates;
class InitialState;
-/**
- * Push Down Automaton
- *
- * $|\delta (q, a, \gamma)| \leq 1$, $\forall q, a, \gamma, q \in Q, a \in (T \cup \{\varepsilon\}), \gamma \in G^*.$
- * if $\delta (q, a, \alpha) \neq \emptyset$, $\delta (q, a, \beta) \neq \emptyset$ and $\alpha \neq \beta$, then $\alpha$ is not suffix of $\beta$ and $\beta$ is not suffix of $\alpha$ (formally $\gamma \alpha \neq \beta and \alpha \neq \gamma \beta$).
- * if $\delta(q, a, \alpha) \neq \emptyset$, $\delta (q, \varepsilon, \beta) \neq \emptyset$, then $\alpha$ is not suffix of $\beta$ and $\beta$ is not suffix of $\alpha$ (fornally $\gamma \alpha \neq \beta and \alpha \neq \gamma \beta$).
- */
/**
* \brief
* Deterministic pushdown automaton. Accepts subset of context free languages.
* \details
* Definition
- * A = (Q, T, G, I, \delta, \zeta, F),
+ * A = (Q, T, G, I, Z, \delta, F),
* Q (States) = nonempty finite set of states,
* T (TerminalAlphabet) = finite set of terminal symbols - having this empty won't let automaton do much though,
* G (PushdownStoreAlphabet) = finite set of pushdown store symbol - having this empty makes the automaton equivalent to DFA
* I (InitialState) = initial state,
* Z (InitialPushdownStoreSymbol) = initial pushdown store symbol
- * \delta = transition function of the form A \times a -> B, where A, B \in Q and a \in T,
- * \zeta = mapping function of the form a -> ( \alpha, \beta ) where a \in T and \alpha, \beta \in G*
+ * \delta = transition function of the form A \times a \times \alpha -> B \times \beta, where A, B \in Q, a \in T \cup { \eps }, and \alpha, beta \in G*,
* F (FinalStates) = set of final states
*
- * Note that target state of a transition is required.
- * This class is used to store minimal, total, ... variants of deterministic finite automata.
+ * The transition functions must meet following criteria. Othervise adding conflicting transition will cause exception.
+ * $|\delta (q, a, \gamma)| \leq 1$, $\forall q, a, \gamma, q \in Q, a \in (T \cup \{\varepsilon\}), \gamma \in G^*.$
+ * if $\delta (q, a, \alpha) \neq \emptyset$, $\delta (q, a, \beta) \neq \emptyset$ and $\alpha \neq \beta$, then $\alpha$ is not suffix of $\beta$ and $\beta$ is not suffix of $\alpha$ (formally $\gamma \alpha \neq \beta and \alpha \neq \gamma \beta$).
+ * if $\delta(q, a, \alpha) \neq \emptyset$, $\delta (q, \varepsilon, \beta) \neq \emptyset$, then $\alpha$ is not suffix of $\beta$ and $\beta$ is not suffix of $\alpha$ (fornally $\gamma \alpha \neq \beta and \alpha \neq \gamma \beta$).
*
* \tparam SymbolType used for the terminal alphabet
+ * \tparam EpsilonSymbolType used for the epsilon in the automaton
* \tparam PushdownSymbolType used for the pushdown store alphabet
* \tparam StateType used to the states, and the initial state of the automaton.
*/
@@ -398,7 +393,7 @@ public:
/**
* \brief Adds a transition to the automaton.
*
- * \details The transition is in a form A times a times \alpha -> B times \beta, where A, B \in Q and a \in T \cup { \eps }
+ * \details The transition is in a form A times a times \alpha -> B times \beta, where A, B \in Q, a \in T \cup { \eps }, and \alpha, \beta \in G*
*
* \param from the source state (A)
* \param input the input symbol or epsilon (a)
@@ -415,7 +410,7 @@ public:
/**
* \brief Adds a transition to the automaton.
*
- * \details The transition is in a form A times a times \alpha -> B times \beta, where A, B \in Q and a \in T
+ * \details The transition is in a form A times a times \alpha -> B times \beta, where A, B \in Q, a \in T, and \alpha, \beta \in G*
*
* \param from the source state (A)
* \param input the input symbol (a)
@@ -432,7 +427,7 @@ public:
/**
* \brief Adds a transition to the automaton.
*
- * \details The transition is in a form A times \eps times \alpha -> B times \beta, where A, B \in Q
+ * \details The transition is in a form A times \eps times \alpha -> B times \beta, where A, B \in Q and \alpha, \beta \in G*
*
* \param from the source state (A)
* \param pop symbols to be poped from pushdown store on the transition use (\alpha)
@@ -448,7 +443,7 @@ public:
/**
* \brief Removes a transition from the automaton.
*
- * \details The transition is in a form A times a times \alpha -> B times \beta, where A, B \in Q and a \in T \cup { \eps }
+ * \details The transition is in a form A times a times \alpha -> B times \beta, where A, B \in Q, a \in T \cup { \eps }, and \alpha, \beta \in G*
*
* \param from the source state (A)
* \param input the input symbol or epsilon (a)
@@ -465,7 +460,7 @@ public:
/**
* \brief Removes a transition from the automaton.
*
- * \details The transition is in a form A times a times \alpha -> B times \beta, where A, B \in Q and a \in T
+ * \details The transition is in a form A times a times \alpha -> B times \beta, where A, B \in Q, a \in T, and \alpha, \beta \in G*
*
* \param from the source state (A)
* \param input the input symbol (a)
@@ -482,7 +477,7 @@ public:
/**
* \brief Removes a transition from the automaton.
*
- * \details The transition is in a form A times \eps times \alpha -> B times \beta, where A, B \in Q
+ * \details The transition is in a form A times \eps times \alpha -> B times \beta, where A, B \in Q and \alpha, \beta \in G*
*
* \param from the source state (A)
* \param pop symbols poped from pushdown store on the transition use (\alpha)
diff --git a/alib2data/src/automaton/PDA/NPDA.h b/alib2data/src/automaton/PDA/NPDA.h
index d5e491cb3143e5cfca73eba7f67e95450a93cca9..9ef1a1f48fed22cf8d4c75430e7fd73182f09219 100644
--- a/alib2data/src/automaton/PDA/NPDA.h
+++ b/alib2data/src/automaton/PDA/NPDA.h
@@ -1,6 +1,22 @@
/*
* NPDA.h
*
+ * This file is part of Algorithms library toolkit.
+ * Copyright (C) 2017 Jan Travnicek (jan.travnicek@fit.cvut.cz)
+
+ * Algorithms library toolkit 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.
+
+ * Algorithms library toolkit 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 Algorithms library toolkit. If not, see <http://www.gnu.org/licenses/>.
+ *
* Created on: Apr 10, 2013
* Author: Jan Travnicek
*/
@@ -39,204 +55,572 @@ class FinalStates;
class InitialState;
/**
- * Push Down Automaton
+ * Nondeterministic Pushdown Automaton. Accepts context free languages.
+ *
+ * \details
+ * Definition
+ * A = (Q, T, G, I, Z, \delta, F),
+ * Q (States) = nonempty finite set of states,
+ * T (TerminalAlphabet) = finite set of terminal symbols - having this empty won't let automaton do much though,
+ * G (PushdownStoreAlphabet) = finite set of pushdown store symbol - having this empty makes the automaton equivalent to DFA
+ * I (InitialState) = initial state,
+ * Z (InitialPushdownStoreSymbol) = initial pushdown store symbol
+ * \delta = transition function of the form A \times a \times \alpha -> B \times \beta, where A, B \in Q, a \in T \cup { \eps }, and \alpha, beta \in G*,
+ * F (FinalStates) = set of final states
+ *
+ * \tparam SymbolType used for the terminal alphabet
+ * \tparam EpsilonSymbolType used for the epsilon in the automaton
+ * \tparam PushdownSymbolType used for the pushdown store alphabet
+ * \tparam StateType used to the states, and the initial state of the automaton.
*/
template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolType, class StateType >
class NPDA final : public AutomatonBase, public core::Components < NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, ext::set < InputSymbolType >, component::Set, InputAlphabet, ext::set < PushdownStoreSymbolType >, component::Set, PushdownStoreAlphabet, PushdownStoreSymbolType, component::Value, InitialSymbol, ext::set < StateType >, component::Set, std::tuple < States, FinalStates >, StateType, component::Value, InitialState > {
protected:
+ /**
+ * Transition function as mapping from a state times an input symbol or epsilon times string of pushdown store symbols on the left hand side to a state time string of pushdown store symbols.
+ */
ext::map < ext::tuple < StateType, ext::variant < EpsilonType, InputSymbolType >, ext::vector < PushdownStoreSymbolType > >, ext::set < ext::pair < StateType, ext::vector < PushdownStoreSymbolType > > > > transitions;
public:
+ /**
+ * \brief Creates a new instance of the automaton with a concrete set of states, input alphabet, pushdown store alphabet, initial state, initial pushdown symbol and a set of final states.
+ *
+ * \param states the initial set of states of the automaton
+ * \param inputAlphabet the initial input alphabet
+ * \param pushdownStoreAlphabet the initial set of symbols used in the pushdown store by the automaton
+ * \param initialState the initial state of the automaton
+ * \param initialPushdownSymbol the initial pushdown symbol of the automaton
+ * \param finalStates the initial set of final states of the automaton
+ */
explicit NPDA ( ext::set < StateType > states, ext::set < InputSymbolType > inputAlphabet, ext::set < PushdownStoreSymbolType > pushdownStoreSymbol, StateType initialState, PushdownStoreSymbolType initialPushdownSymbol, ext::set < StateType > finalStates );
+
+ /**
+ * \brief Creates a new instance of the automaton with a concrete initial state and initial pushdown store symbol.
+ *
+ * \param initialState the initial state of the automaton
+ * \param initialPushdownSymbol the initial pushdown symbol of the automaton
+ */
explicit NPDA ( StateType initialState, PushdownStoreSymbolType initialPushdownSymbol );
- virtual AutomatonBase * clone ( ) const;
+ /**
+ * @copydoc automaton::AutomatonBase::clone()
+ */
+ virtual AutomatonBase * clone ( ) const override;
- virtual AutomatonBase * plunder ( ) &&;
+ /**
+ * @copydoc automaton::AutomatonBase::plunder()
+ */
+ virtual AutomatonBase * plunder ( ) && override;
+ /**
+ * Getter of the initial state.
+ *
+ * \returns the initial state of the automaton
+ */
const StateType & getInitialState ( ) const & {
- return this->template accessComponent < InitialState > ( ).get ( );
+ return this-> template accessComponent < InitialState > ( ).get ( );
}
+ /**
+ * Getter of the initial state.
+ *
+ * \returns the initial state of the automaton
+ */
StateType && getInitialState ( ) && {
- return std::move ( this->template accessComponent < InitialState > ( ).get ( ) );
+ return std::move ( this-> template accessComponent < InitialState > ( ).get ( ) );
}
+ /**
+ * Setter of the initial state.
+ *
+ * \param state new initial state of the automaton
+ *
+ * \returns true if the initial state was indeed changed
+ */
bool setInitialState ( StateType state ) {
- return this->template accessComponent < InitialState > ( ).set ( std::move ( state ) );
+ return this-> template accessComponent < InitialState > ( ).set ( std::move ( state ) );
}
+ /**
+ * Getter of states.
+ *
+ * \returns the states of the automaton
+ */
const ext::set < StateType > & getStates ( ) const & {
- return this->template accessComponent < States > ( ).get ( );
+ return this-> template accessComponent < States > ( ).get ( );
}
+ /**
+ * Getter of states.
+ *
+ * \returns the states of the automaton
+ */
ext::set < StateType > && getStates ( ) && {
- return std::move ( this->template accessComponent < States > ( ).get ( ) );
+ return std::move ( this-> template accessComponent < States > ( ).get ( ) );
}
+ /**
+ * Adder of a state.
+ *
+ * \param state the new state to be added to a set of states
+ *
+ * \returns true if the state was indeed added
+ */
bool addState ( StateType state ) {
- return this->template accessComponent < States > ( ).add ( std::move ( state ) );
+ return this-> template accessComponent < States > ( ).add ( std::move ( state ) );
}
+ /**
+ * Setter of states.
+ *
+ * \param states completely new set of states
+ */
void setStates ( ext::set < StateType > states ) {
- this->template accessComponent < States > ( ).set ( std::move ( states ) );
+ this-> template accessComponent < States > ( ).set ( std::move ( states ) );
}
+ /**
+ * Remover of a state.
+ *
+ * \param state a state to be removed from a set of states
+ *
+ * \returns true if the state was indeed removed
+ */
void removeState ( const StateType & state ) {
- this->template accessComponent < States > ( ).remove ( state );
+ this-> template accessComponent < States > ( ).remove ( state );
}
+ /**
+ * Getter of final states.
+ *
+ * \returns the final states of the automaton
+ */
const ext::set < StateType > & getFinalStates ( ) const & {
- return this->template accessComponent < FinalStates > ( ).get ( );
+ return this-> template accessComponent < FinalStates > ( ).get ( );
}
+ /**
+ * Getter of final states.
+ *
+ * \returns the final states of the automaton
+ */
ext::set < StateType > && getFinalStates ( ) && {
- return std::move ( this->template accessComponent < FinalStates > ( ).get ( ) );
+ return std::move ( this-> template accessComponent < FinalStates > ( ).get ( ) );
}
+ /**
+ * Adder of a final state.
+ *
+ * \param state the new state to be added to a set of final states
+ *
+ * \returns true if the state was indeed added
+ */
bool addFinalState ( StateType state ) {
- return this->template accessComponent < FinalStates > ( ).add ( std::move ( state ) );
+ return this-> template accessComponent < FinalStates > ( ).add ( std::move ( state ) );
}
+ /**
+ * Setter of final states.
+ *
+ * \param states completely new set of final states
+ */
void setFinalStates ( ext::set < StateType > states ) {
- this->template accessComponent < FinalStates > ( ).set ( std::move ( states ) );
+ this-> template accessComponent < FinalStates > ( ).set ( std::move ( states ) );
}
+ /**
+ * Remover of a final state.
+ *
+ * \param state a state to be removed from a set of final states
+ *
+ * \returns true if the state was indeed removed
+ */
void removeFinalState ( const StateType & state ) {
- this->template accessComponent < FinalStates > ( ).remove ( state );
+ this-> template accessComponent < FinalStates > ( ).remove ( state );
}
+ /**
+ * Getter of the pushdown store alphabet.
+ *
+ * \returns the pushdown store alphabet of the automaton
+ */
const ext::set < PushdownStoreSymbolType > & getPushdownStoreAlphabet ( ) const & {
return this->template accessComponent < PushdownStoreAlphabet > ( ).get ( );
}
+ /**
+ * Getter of the pushdown store alphabet.
+ *
+ * \returns the pushdown store alphabet of the automaton
+ */
ext::set < PushdownStoreSymbolType > && getPushdownStoreAlphabet ( ) && {
return std::move ( this->template accessComponent < PushdownStoreAlphabet > ( ).get ( ) );
}
+ /**
+ * Adder of a pushdown store symbol.
+ *
+ * \param symbol the new symbol to be added to a pushdown store alphabet
+ *
+ * \returns true if the symbol was indeed added
+ */
bool addPushdownStoreSymbol ( PushdownStoreSymbolType symbol ) {
return this->template accessComponent < PushdownStoreAlphabet > ( ).add ( std::move ( symbol ) );
}
+ /**
+ * Adder of pushdown store symbols.
+ *
+ * \param symbols new symbols to be added to a pushdown store alphabet
+ */
void addPushdownStoreSymbols ( ext::set < PushdownStoreSymbolType > symbols ) {
this->template accessComponent < PushdownStoreAlphabet > ( ).add ( std::move ( symbols ) );
}
+ /**
+ * Setter of a pushdown store alphabet.
+ *
+ * \param symbols completely new pushdown store alphabet
+ */
void setPushdownStoreAlphabet ( ext::set < PushdownStoreSymbolType > symbols ) {
this->template accessComponent < PushdownStoreAlphabet > ( ).set ( std::move ( symbols ) );
}
+ /**
+ * Remover of an pushdown store symbol.
+ *
+ * \param symbol a symbol to be removed from a pushdown store alphabet
+ *
+ * \returns true if the symbol was indeed removed
+ */
void removePushdownStoreSymbol ( const PushdownStoreSymbolType & symbol ) {
this->template accessComponent < PushdownStoreAlphabet > ( ).remove ( symbol );
}
+ /**
+ * Getter of the initial pushdown store symbol.
+ *
+ * \returns the initial pushdown store symbol of the automaton
+ */
const PushdownStoreSymbolType & getInitialSymbol ( ) const & {
return this->template accessComponent < InitialSymbol > ( ).get ( );
}
+ /**
+ * Getter of the initial pushdown store symbol.
+ *
+ * \returns the initial pushdown store symbol of the automaton
+ */
PushdownStoreSymbolType && getInitialSymbol ( ) && {
return std::move ( this->template accessComponent < InitialSymbol > ( ).get ( ) );
}
+ /**
+ * Setter of the initial pushdown store symbol.
+ *
+ * \param symbol new initial pushdown store symbol of the automaton
+ *
+ * \returns true if the initial pushdown store symbol was indeed changed
+ */
bool setInitialSymbol ( PushdownStoreSymbolType symbol ) {
return this->template accessComponent < InitialSymbol > ( ).set ( std::move ( symbol ) );
}
+ /**
+ * Getter of the input alphabet.
+ *
+ * \returns the input alphabet of the automaton
+ */
const ext::set < InputSymbolType > & getInputAlphabet ( ) const & {
- return this->template accessComponent < InputAlphabet > ( ).get ( );
+ return this-> template accessComponent < InputAlphabet > ( ).get ( );
}
+ /**
+ * Getter of the input alphabet.
+ *
+ * \returns the input alphabet of the automaton
+ */
ext::set < InputSymbolType > && getInputAlphabet ( ) && {
- return std::move ( this->template accessComponent < InputAlphabet > ( ).get ( ) );
+ return std::move ( this-> template accessComponent < InputAlphabet > ( ).get ( ) );
}
+ /**
+ * Adder of a input symbol.
+ *
+ * \param symbol the new symbol to be added to an input alphabet
+ *
+ * \returns true if the symbol was indeed added
+ */
bool addInputSymbol ( InputSymbolType symbol ) {
- return this->template accessComponent < InputAlphabet > ( ).add ( std::move ( symbol ) );
+ return this-> template accessComponent < InputAlphabet > ( ).add ( std::move ( symbol ) );
}
+ /**
+ * Adder of input symbols.
+ *
+ * \param symbols new symbols to be added to an input alphabet
+ */
void addInputSymbols ( ext::set < InputSymbolType > symbols ) {
- this->template accessComponent < InputAlphabet > ( ).add ( std::move ( symbols ) );
+ this-> template accessComponent < InputAlphabet > ( ).add ( std::move ( symbols ) );
}
+ /**
+ * Setter of input alphabet.
+ *
+ * \param symbols completely new input alphabet
+ */
void setInputAlphabet ( ext::set < InputSymbolType > symbols ) {
- this->template accessComponent < InputAlphabet > ( ).set ( std::move ( symbols ) );
+ this-> template accessComponent < InputAlphabet > ( ).set ( std::move ( symbols ) );
}
+ /**
+ * Remover of an input symbol.
+ *
+ * \param symbol a symbol to be removed from an input alphabet
+ *
+ * \returns true if the symbol was indeed removed
+ */
void removeInputSymbol ( const InputSymbolType & symbol ) {
- this->template accessComponent < InputAlphabet > ( ).remove ( symbol );
+ this-> template accessComponent < InputAlphabet > ( ).remove ( symbol );
}
/**
- * Adds transition to the NPDA.
- * @param transition transition to add
- * @throws AutomatonException when some part of the transition is not present
- * in the NPDA (state, input symbol, stack symbol) or when transition already exists
+ * \brief Adds a transition to the automaton.
+ *
+ * \details The transition is in a form A times a times \alpha -> B times \beta, where A, B \in Q, a \in T \cup { \eps }, and \alpha, \beta \in G*
+ *
+ * \param from the source state (A)
+ * \param input the input symbol or epsilon (a)
+ * \param pop symbols to be poped from pushdown store on the transition use (\alpha)
+ * \param to the target state (B)
+ * \param push symbols to be pushed to the pushdown store on the transition use (\beta)
+ *
+ * \throws AutomatonException when transition contains state or symbol not present in the automaton components
+ *
+ * \returns true if the transition was indeed added
*/
bool addTransition ( StateType from, ext::variant < EpsilonType, InputSymbolType > input, ext::vector < PushdownStoreSymbolType > pop, StateType to, ext::vector < PushdownStoreSymbolType > push );
+ /**
+ * \brief Adds a transition to the automaton.
+ *
+ * \details The transition is in a form A times a times \alpha -> B times \beta, where A, B \in Q, a \in T, and \alpha, \beta \in G*
+ *
+ * \param from the source state (A)
+ * \param input the input symbol (a)
+ * \param pop symbols to be poped from pushdown store on the transition use (\alpha)
+ * \param to the target state (B)
+ * \param push symbols to be pushed to the pushdown store on the transition use (\beta)
+ *
+ * \throws AutomatonException when transition contains state or symbol not present in the automaton components
+ *
+ * \returns true if the transition was indeed added
+ */
bool addTransition ( StateType from, InputSymbolType input, ext::vector < PushdownStoreSymbolType > pop, StateType to, ext::vector < PushdownStoreSymbolType > push );
+ /**
+ * \brief Adds a transition to the automaton.
+ *
+ * \details The transition is in a form A times \eps times \alpha -> B times \beta, where A, B \in Q and \alpha, \beta \in G*
+ *
+ * \param from the source state (A)
+ * \param pop symbols to be poped from pushdown store on the transition use (\alpha)
+ * \param to the target state (B)
+ * \param push symbols to be pushed to the pushdown store on the transition use (\beta)
+ *
+ * \throws AutomatonException when transition contains state or symbol not present in the automaton components
+ *
+ * \returns true if the transition was indeed added
+ */
bool addTransition ( StateType from, ext::vector < PushdownStoreSymbolType > pop, StateType to, ext::vector < PushdownStoreSymbolType > push );
/**
- * Adds transition to the NPDA.
- * @param transition transition to add
- * @throws AutomatonException when some part of the transition is not present
- * in the NPDA (state, input symbol, stack symbol) or when transition already exists
+ * \brief Adds transitions to the automaton.
+ *
+ * \details The transitions are in a form A times a times \alpha -> B times \beta | C \gamma | ..., where A, B, C \in Q, a \in T \cup { \eps }, and \alpha, \beta, \gamma \in G*
+ *
+ * \param from the source state (A)
+ * \param input the input symbol or epsilon (a)
+ * \param pop symbols to be poped from pushdown store on the transition use (\alpha)
+ * \param targets the set of target state (B, C ...) and symbols to be pushed to the pushdown store on the transition use (\beta, \gamma, ...)
+ *
+ * \throws AutomatonException when transition contains state or symbol not present in the automaton components
*/
void addTransitions ( StateType from, ext::variant < EpsilonType, InputSymbolType > input, ext::vector < PushdownStoreSymbolType > pop, ext::set < ext::pair < StateType, ext::vector < PushdownStoreSymbolType > > > targets );
+ /**
+ * \brief Adds transitions to the automaton.
+ *
+ * \details The transitions are in a form A times a times \alpha -> B times \beta | C \gamma | ..., where A, B, C \in Q, a \in T, and \alpha, \beta, \gamma \in G*
+ *
+ * \param from the source state (A)
+ * \param input the input symbol (a)
+ * \param pop symbols to be poped from pushdown store on the transition use (\alpha)
+ * \param targets the set of target state (B, C ...) and symbols to be pushed to the pushdown store on the transition use (\beta, \gamma, ...)
+ *
+ * \throws AutomatonException when transition contains state or symbol not present in the automaton components
+ */
void addTransitions ( StateType from, InputSymbolType input, ext::vector < PushdownStoreSymbolType > pop, ext::set < ext::pair < StateType, ext::vector < PushdownStoreSymbolType > > > targets );
+ /**
+ * \brief Adds transitions to the automaton.
+ *
+ * \details The transitions are in a form A times \eps times \alpha -> B times \beta | C \gamma | ..., where A, B, C \in Q and \alpha, \beta, \gamma \in G*
+ *
+ * \param from the source state (A)
+ * \param pop symbols to be poped from pushdown store on the transition use (\alpha)
+ * \param targets the set of target state (B, C ...) and symbols to be pushed to the pushdown store on the transition use (\beta, \gamma, ...)
+ *
+ * \throws AutomatonException when transition contains state or symbol not present in the automaton components
+ */
void addTransitions ( StateType from, ext::vector < PushdownStoreSymbolType > pop, ext::set < ext::pair < StateType, ext::vector < PushdownStoreSymbolType > > > targets );
/**
- * Removes the transition from the NPDA.
- * @param transition transition to remove
- * @throws AutomatonException when transition is not present in the NPDA
+ * \brief Removes a transition from the automaton.
+ *
+ * \details The transition is in a form A times a times \alpha -> B times \beta, where A, B \in Q, a \in T \cup { \eps }, and \alpha, \beta \in G*
+ *
+ * \param from the source state (A)
+ * \param input the input symbol or epsilon (a)
+ * \param pop symbols poped from pushdown store on the transition use (\alpha)
+ * \param to the target state (B)
+ * \param push symbols pushed to the pushdown store on the transition use (\beta)
+ *
+ * \throws AutomatonException when removed transition left hand side was found but the right hand side did not match.
+ *
+ * \returns true if the transition was indeed removed
*/
bool removeTransition ( const StateType & from, const ext::variant < EpsilonType, InputSymbolType > & input, const ext::vector < PushdownStoreSymbolType > & pop, const StateType & to, const ext::vector < PushdownStoreSymbolType > & push );
+ /**
+ * \brief Removes a transition from the automaton.
+ *
+ * \details The transition is in a form A times a times \alpha -> B times \beta, where A, B \in Q, a \in T, and \alpha, \beta \in G*
+ *
+ * \param from the source state (A)
+ * \param input the input symbol (a)
+ * \param pop symbols poped from pushdown store on the transition use (\alpha)
+ * \param to the target state (B)
+ * \param push symbols pushed to the pushdown store on the transition use (\beta)
+ *
+ * \throws AutomatonException when removed transition left hand side was found but the right hand side did not match.
+ *
+ * \returns true if the transition was indeed removed
+ */
bool removeTransition ( const StateType & from, const InputSymbolType & input, const ext::vector < PushdownStoreSymbolType > & pop, const StateType & to, const ext::vector < PushdownStoreSymbolType > & push );
+ /**
+ * \brief Removes a transition from the automaton.
+ *
+ * \details The transition is in a form A times \eps times \alpha -> B times \beta, where A, B \in Q and \alpha, \beta \in G*
+ *
+ * \param from the source state (A)
+ * \param pop symbols poped from pushdown store on the transition use (\alpha)
+ * \param to the target state (B)
+ * \param push symbols pushed to the pushdown store on the transition use (\beta)
+ *
+ * \throws AutomatonException when removed transition left hand side was found but the right hand side did not match.
+ *
+ * \returns true if the transition was indeed removed
+ */
bool removeTransition ( const StateType & from, const ext::vector < PushdownStoreSymbolType > & pop, const StateType & to, const ext::vector < PushdownStoreSymbolType > & push );
/**
- * @return NPDA transitions
+ * Get the transition function of the automaton in its natural form.
+ *
+ * \returns transition function of the automaton
*/
const ext::map < ext::tuple < StateType, ext::variant < EpsilonType, InputSymbolType >, ext::vector < PushdownStoreSymbolType > >, ext::set < ext::pair < StateType, ext::vector < PushdownStoreSymbolType > > > > & getTransitions ( ) const &;
/**
- * @return NPDA transitions
+ * Get the transition function of the automaton in its natural form.
+ *
+ * \returns transition function of the automaton
*/
ext::map < ext::tuple < StateType, ext::variant < EpsilonType, InputSymbolType >, ext::vector < PushdownStoreSymbolType > >, ext::set < ext::pair < StateType, ext::vector < PushdownStoreSymbolType > > > > && getTransitions ( ) &&;
- virtual int compare ( const ObjectBase & other ) const {
+ /**
+ * @copydoc alib::CommonBase<ObjectBase>::compare ( const ObjectBase & )
+ */
+ virtual int compare ( const ObjectBase & other ) const override {
if ( ext::type_index ( typeid ( * this ) ) == ext::type_index ( typeid ( other ) ) ) return this->compare ( ( decltype ( * this ) )other );
return ext::type_index ( typeid ( * this ) ) - ext::type_index ( typeid ( other ) );
}
- virtual int compare ( const NPDA & other ) const;
+ /**
+ * The actual compare method
+ *
+ * \param other the other instance
+ *
+ * \returns the actual relation between two by type same automata instances
+ */
+ int compare ( const NPDA & other ) const;
- virtual void operator >>( std::ostream & os ) const;
+ /**
+ * @copydoc alib::CommonBase<ObjectBase>::operator >> ( std::ostream & )
+ */
+ virtual void operator >>( std::ostream & os ) const override;
- virtual explicit operator std::string ( ) const;
+ /**
+ * @copydoc alib::CommonBase<ObjectBase>::operator std::string ( )
+ */
+ virtual explicit operator std::string ( ) const override;
+ /**
+ * \brief The XML tag name of class.
+ *
+ * \details Intentionaly a static member function to be safe in the initialisation before the main function starts.
+ *
+ * \returns string representing the XML tag name of the class
+ */
static const std::string & getXmlTagName() {
static std::string xmlTagName = "NPDA";
return xmlTagName;
}
+ /**
+ * Parsing from a sequence of xml tokens helper.
+ *
+ * \params input the iterator to sequence of xml tokens to parse from
+ *
+ * \returns the new instance of the automaton
+ */
static NPDA parse ( ext::deque < sax::Token >::iterator & input );
+
+ /**
+ * Helper for parsing of individual transitions of the automaton from a sequence of xml tokens.
+ *
+ * \params input the iterator to sequence of xml tokens to parse from
+ * \params automaton the automaton to add the rule to
+ */
static void parseTransition ( ext::deque < sax::Token >::iterator & input, NPDA & automaton );
+ /**
+ * Composing to a sequence of xml tokens helper.
+ *
+ * \param out the sink for new xml tokens representing the automaton
+ * \param automaton the automaton to compose
+ */
static void compose ( ext::deque < sax::Token > & out, const NPDA & automaton );
+
+ /**
+ * Helper for composing transitions of the automaton to a sequence of xml tokens.
+ *
+ * \param out the sink for xml tokens representing the rules of the automaton
+ * \param automaton the automaton to compose
+ */
static void composeTransitions ( ext::deque < sax::Token > & ou, const NPDA & automatont );
- virtual object::ObjectBase * inc ( ) &&;
+ /**
+ * @copydoc alib::GrammarBase::inc()
+ */
+ virtual object::ObjectBase * inc ( ) && override;
+ /**
+ * Type of normalized automaton.
+ */
typedef NPDA < > normalized_type;
};
@@ -472,9 +856,25 @@ object::ObjectBase* NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType
namespace core {
+/**
+ * Helper class specifying constraints for the automaton's internal input alphabet component.
+ *
+ * \tparam InputSymbolType used for the terminal alphabet of the automaton.
+ * \tparam EpsilonSymbolType used for the epsilon in the automaton
+ * \tparam PushdownSymbolType used for the pushdown store alphabet of the automaton.
+ * \tparam StateType used for the terminal alphabet of the automaton.
+ */
template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolType, class StateType >
class SetConstraint< automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, InputSymbolType, automaton::InputAlphabet > {
public:
+ /**
+ * Returns true if the symbol is still used in some transition of the automaton.
+ *
+ * \param automaton the tested automaton
+ * \param symbol the tested symbol
+ *
+ * \returns true if the symbol is used, false othervise
+ */
static bool used ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > & automaton, const InputSymbolType & symbol ) {
for ( const std::pair<const ext::tuple<StateType, ext::variant < EpsilonType, InputSymbolType >, ext::vector<PushdownStoreSymbolType> >, ext::set<ext::pair<StateType, ext::vector<PushdownStoreSymbolType> > > >& transition : automaton.getTransitions())
if (std::get<1>(transition.first).template is<InputSymbolType>() && symbol == std::get<1>(transition.first).template get<InputSymbolType>())
@@ -483,17 +883,47 @@ public:
return false;
}
+ /**
+ * Returns true as all symbols are possibly available to be elements of the input alphabet.
+ *
+ * \param automaton the tested automaton
+ * \param state the tested state
+ *
+ * \returns true
+ */
static bool available ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const InputSymbolType & ) {
return true;
}
+ /**
+ * All symbols are valid as input symbols.
+ *
+ * \param automaton the tested automaton
+ * \param state the tested state
+ */
static void valid ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const InputSymbolType & ) {
}
};
+/**
+ * Helper class specifying constraints for the automaton's internal pushdown store alphabet component.
+ *
+ * \tparam SymbolType used for the terminal alphabet of the automaton.
+ * \tparam EpsilonSymbolType used for the epsilon in the automaton
+ * \tparam PushdownSymbolType used for the pushdown store alphabet of the automaton.
+ * \tparam StateType used for the terminal alphabet of the automaton.
+ */
template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolType, class StateType >
class SetConstraint< automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, PushdownStoreSymbolType, automaton::PushdownStoreAlphabet > {
public:
+ /**
+ * Returns true if the symbol is still used in some transition of the automaton.
+ *
+ * \param automaton the tested automaton
+ * \param symbol the tested symbol
+ *
+ * \returns true if the symbol is used, false othervise
+ */
static bool used ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > & automaton, const PushdownStoreSymbolType & symbol ) {
if(automaton.getInitialSymbol() == symbol)
return true;
@@ -511,28 +941,80 @@ public:
return false;
}
+ /**
+ * Returns true as all symbols are possibly available to be elements of the input alphabet.
+ *
+ * \param automaton the tested automaton
+ * \param state the tested state
+ *
+ * \returns true
+ */
static bool available ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const PushdownStoreSymbolType & ) {
return true;
}
+ /**
+ * All symbols are valid as input symbols.
+ *
+ * \param automaton the tested automaton
+ * \param state the tested state
+ */
static void valid ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const PushdownStoreSymbolType & ) {
}
};
+/**
+ * Helper class specifying constraints for the automaton's internal pushdown store initial element.
+ *
+ * \tparam SymbolType used for the terminal alphabet of the automaton.
+ * \tparam EpsilonSymbolType used for the epsilon in the automaton
+ * \tparam PushdownSymbolType used for the pushdown store alphabet of the automaton.
+ * \tparam StateType used for the terminal alphabet of the automaton.
+ */
template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolType, class StateType >
class ElementConstraint< automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, PushdownStoreSymbolType, automaton::InitialSymbol > {
public:
+ /**
+ * Determines whether the initial pushdown store symbol is available in the automaton's pushdown store alphabet.
+ *
+ * \param automaton the tested automaton
+ * \param symbol the tested symbol
+ *
+ * \returns true if the pushdown store symbol is already in the pushdown store alphabet of the automaton
+ */
static bool available ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > & automaton, const PushdownStoreSymbolType & symbol ) {
return automaton.template accessComponent < automaton::PushdownStoreAlphabet > ( ).get ( ).count ( symbol );
}
+ /**
+ * All pushdown store symbols are valid as an initial pusdown store symbol of the automaton.
+ *
+ * \param automaton the tested automaton
+ * \param symbol the tested symbol
+ */
static void valid ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const PushdownStoreSymbolType & ) {
}
};
+/**
+ * Helper class specifying constraints for the automaton's internal states component.
+ *
+ * \tparam SymbolType used for the terminal alphabet of the automaton.
+ * \tparam EpsilonSymbolType used for the epsilon in the automaton
+ * \tparam PushdownSymbolType used for the pushdown store alphabet of the automaton.
+ * \tparam StateType used for the terminal alphabet of the automaton.
+ */
template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolType, class StateType >
class SetConstraint< automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, StateType, automaton::States > {
public:
+ /**
+ * Returns true if the state is still used in some transition of the automaton.
+ *
+ * \param automaton the tested automaton
+ * \param state the tested state
+ *
+ * \returns true if the state is used, false othervise
+ */
static bool used ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > & automaton, const StateType & state ) {
if ( automaton.getInitialState ( ) == state )
return true;
@@ -551,36 +1033,102 @@ public:
return false;
}
+ /**
+ * Returns true as all states are possibly available to be elements of the states.
+ *
+ * \param automaton the tested automaton
+ * \param state the tested state
+ *
+ * \returns true
+ */
static bool available ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return true;
}
+ /**
+ * All states are valid as a state of the automaton.
+ *
+ * \param automaton the tested automaton
+ * \param state the tested state
+ */
static void valid ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
}
};
+/**
+ * Helper class specifying constraints for the automaton's internal final states component.
+ *
+ * \tparam SymbolType used for the terminal alphabet of the automaton.
+ * \tparam EpsilonSymbolType used for the epsilon in the automaton
+ * \tparam PushdownSymbolType used for the pushdown store alphabet of the automaton.
+ * \tparam StateType used for the terminal alphabet of the automaton.
+ */
template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolType, class StateType >
class SetConstraint< automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, StateType, automaton::FinalStates > {
public:
+ /**
+ * Returns true if the state is still used in some transition of the automaton.
+ *
+ * \param automaton the tested automaton
+ * \param state the tested state
+ *
+ * \returns true if the state is used, false othervise
+ */
static bool used ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
}
+ /**
+ * Determines whether the state is available in the automaton's states set.
+ *
+ * \param automaton the tested automaton
+ * \param state the tested state
+ *
+ * \returns true if the state is already in the set of states of the automaton
+ */
static bool available ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > & automaton, const StateType & state ) {
return automaton.template accessComponent < automaton::States > ( ).get ( ).count ( state );
}
+ /**
+ * All states are valid as a final state of the automaton.
+ *
+ * \param automaton the tested automaton
+ * \param state the tested state
+ */
static void valid ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
}
};
+/**
+ * Helper class specifying constraints for the automaton's internal initial state element.
+ *
+ * \tparam SymbolType used for the terminal alphabet of the automaton.
+ * \tparam EpsilonSymbolType used for the epsilon in the automaton
+ * \tparam PushdownSymbolType used for the pushdown store alphabet of the automaton.
+ * \tparam StateType used for the terminal alphabet of the automaton.
+ */
template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolType, class StateType >
class ElementConstraint< automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, StateType, automaton::InitialState > {
public:
+ /**
+ * Determines whether the state is available in the automaton's states set.
+ *
+ * \param automaton the tested automaton
+ * \param state the tested state
+ *
+ * \returns true if the state is already in the set of states of the automaton
+ */
static bool available ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > & automaton, const StateType & state ) {
return automaton.template accessComponent < automaton::States > ( ).get ( ).count ( state );
}
+ /**
+ * All states are valid as an initial state of the automaton.
+ *
+ * \param automaton the tested automaton
+ * \param state the tested state
+ */
static void valid ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
}
};