From e46d3c125e89a16ba6fb4462c747ad423906a4c8 Mon Sep 17 00:00:00 2001
From: Jan Travnicek <Jan.Travnicek@fit.cvut.cz>
Date: Thu, 22 Mar 2018 12:05:18 +0100
Subject: [PATCH] fix documentation of FinalState and InitialStates constraint
---
alib2data/src/automaton/FSM/CompactNFA.h | 4 ++--
alib2data/src/automaton/FSM/DFA.h | 4 ++--
alib2data/src/automaton/FSM/EpsilonNFA.h | 4 ++--
alib2data/src/automaton/FSM/ExtendedNFA.h | 4 ++--
alib2data/src/automaton/FSM/MultiInitialStateNFA.h | 8 ++++----
alib2data/src/automaton/FSM/NFA.h | 4 ++--
alib2data/src/automaton/PDA/DPDA.h | 4 ++--
alib2data/src/automaton/PDA/InputDrivenDPDA.h | 4 ++--
alib2data/src/automaton/PDA/InputDrivenNPDA.h | 4 ++--
alib2data/src/automaton/PDA/NPDA.h | 4 ++--
alib2data/src/automaton/PDA/NPDTA.h | 4 ++--
.../src/automaton/PDA/RealTimeHeightDeterministicDPDA.h | 4 ++--
.../src/automaton/PDA/RealTimeHeightDeterministicNPDA.h | 8 ++++----
alib2data/src/automaton/PDA/SinglePopDPDA.h | 4 ++--
alib2data/src/automaton/PDA/SinglePopNPDA.h | 4 ++--
alib2data/src/automaton/PDA/VisiblyPushdownDPDA.h | 4 ++--
alib2data/src/automaton/PDA/VisiblyPushdownNPDA.h | 8 ++++----
17 files changed, 40 insertions(+), 40 deletions(-)
diff --git a/alib2data/src/automaton/FSM/CompactNFA.h b/alib2data/src/automaton/FSM/CompactNFA.h
index 93b76f523a..085c39ce9c 100644
--- a/alib2data/src/automaton/FSM/CompactNFA.h
+++ b/alib2data/src/automaton/FSM/CompactNFA.h
@@ -842,12 +842,12 @@ template < class SymbolType, class StateType >
class SetConstraint< automaton::CompactNFA < SymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::CompactNFA < SymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/FSM/DFA.h b/alib2data/src/automaton/FSM/DFA.h
index 48fb24540c..3e480e5884 100644
--- a/alib2data/src/automaton/FSM/DFA.h
+++ b/alib2data/src/automaton/FSM/DFA.h
@@ -773,12 +773,12 @@ template<class SymbolType, class StateType >
class SetConstraint< automaton::DFA<SymbolType, StateType>, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::DFA<SymbolType, StateType> &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/FSM/EpsilonNFA.h b/alib2data/src/automaton/FSM/EpsilonNFA.h
index e0a886997a..f7366bf37e 100644
--- a/alib2data/src/automaton/FSM/EpsilonNFA.h
+++ b/alib2data/src/automaton/FSM/EpsilonNFA.h
@@ -1100,12 +1100,12 @@ template<class SymbolType, class EpsilonType, class StateType >
class SetConstraint< automaton::EpsilonNFA < SymbolType, EpsilonType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::EpsilonNFA < SymbolType, EpsilonType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/FSM/ExtendedNFA.h b/alib2data/src/automaton/FSM/ExtendedNFA.h
index 22ec221e50..12c0145c10 100644
--- a/alib2data/src/automaton/FSM/ExtendedNFA.h
+++ b/alib2data/src/automaton/FSM/ExtendedNFA.h
@@ -866,12 +866,12 @@ template<class SymbolType, class StateType >
class SetConstraint< automaton::ExtendedNFA < SymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::ExtendedNFA < SymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/FSM/MultiInitialStateNFA.h b/alib2data/src/automaton/FSM/MultiInitialStateNFA.h
index 430afa95f9..e275fecb5d 100644
--- a/alib2data/src/automaton/FSM/MultiInitialStateNFA.h
+++ b/alib2data/src/automaton/FSM/MultiInitialStateNFA.h
@@ -856,12 +856,12 @@ template < class SymbolType, class StateType >
class SetConstraint< automaton::MultiInitialStateNFA < SymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::MultiInitialStateNFA < SymbolType, StateType > &, const StateType & ) {
return false;
@@ -899,12 +899,12 @@ template < class SymbolType, class StateType >
class SetConstraint< automaton::MultiInitialStateNFA < SymbolType, StateType >, StateType, automaton::InitialStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Initial state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::MultiInitialStateNFA < SymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/FSM/NFA.h b/alib2data/src/automaton/FSM/NFA.h
index 5a7e18fe72..2110f71709 100644
--- a/alib2data/src/automaton/FSM/NFA.h
+++ b/alib2data/src/automaton/FSM/NFA.h
@@ -818,12 +818,12 @@ template<class SymbolType, class StateType >
class SetConstraint< automaton::NFA < SymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::NFA < SymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/PDA/DPDA.h b/alib2data/src/automaton/PDA/DPDA.h
index 719ae02e16..c17d5b77ef 100644
--- a/alib2data/src/automaton/PDA/DPDA.h
+++ b/alib2data/src/automaton/PDA/DPDA.h
@@ -1091,12 +1091,12 @@ template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolTy
class SetConstraint< automaton::DPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::DPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/PDA/InputDrivenDPDA.h b/alib2data/src/automaton/PDA/InputDrivenDPDA.h
index 7d35d56785..95907cc500 100644
--- a/alib2data/src/automaton/PDA/InputDrivenDPDA.h
+++ b/alib2data/src/automaton/PDA/InputDrivenDPDA.h
@@ -1054,12 +1054,12 @@ template < class InputSymbolType, class PushdownStoreSymbolType, class StateType
class SetConstraint< automaton::InputDrivenDPDA < InputSymbolType, PushdownStoreSymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::InputDrivenDPDA < InputSymbolType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/PDA/InputDrivenNPDA.h b/alib2data/src/automaton/PDA/InputDrivenNPDA.h
index 266fb6f54d..69a19fb0ed 100644
--- a/alib2data/src/automaton/PDA/InputDrivenNPDA.h
+++ b/alib2data/src/automaton/PDA/InputDrivenNPDA.h
@@ -1095,12 +1095,12 @@ template < class InputSymbolType, class PushdownStoreSymbolType, class StateType
class SetConstraint< automaton::InputDrivenNPDA < InputSymbolType, PushdownStoreSymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::InputDrivenNPDA < InputSymbolType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/PDA/NPDA.h b/alib2data/src/automaton/PDA/NPDA.h
index ac3e5e2934..cc71c8147b 100644
--- a/alib2data/src/automaton/PDA/NPDA.h
+++ b/alib2data/src/automaton/PDA/NPDA.h
@@ -1066,12 +1066,12 @@ template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolTy
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.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::NPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/PDA/NPDTA.h b/alib2data/src/automaton/PDA/NPDTA.h
index e000a28c83..d050639fcf 100644
--- a/alib2data/src/automaton/PDA/NPDTA.h
+++ b/alib2data/src/automaton/PDA/NPDTA.h
@@ -1240,12 +1240,12 @@ template < class InputSymbolType, class OutputSymbolType, class EpsilonType, cla
class SetConstraint< automaton::NPDTA < InputSymbolType, OutputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::NPDTA < InputSymbolType, OutputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/PDA/RealTimeHeightDeterministicDPDA.h b/alib2data/src/automaton/PDA/RealTimeHeightDeterministicDPDA.h
index 57e3f848ce..48e798a6fe 100644
--- a/alib2data/src/automaton/PDA/RealTimeHeightDeterministicDPDA.h
+++ b/alib2data/src/automaton/PDA/RealTimeHeightDeterministicDPDA.h
@@ -1513,12 +1513,12 @@ template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolTy
class SetConstraint< automaton::RealTimeHeightDeterministicDPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::RealTimeHeightDeterministicDPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/PDA/RealTimeHeightDeterministicNPDA.h b/alib2data/src/automaton/PDA/RealTimeHeightDeterministicNPDA.h
index 6996c9505d..4d1d440123 100644
--- a/alib2data/src/automaton/PDA/RealTimeHeightDeterministicNPDA.h
+++ b/alib2data/src/automaton/PDA/RealTimeHeightDeterministicNPDA.h
@@ -1631,12 +1631,12 @@ template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolTy
class SetConstraint< automaton::RealTimeHeightDeterministicNPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::RealTimeHeightDeterministicNPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
@@ -1676,12 +1676,12 @@ template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolTy
class SetConstraint< automaton::RealTimeHeightDeterministicNPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, StateType, automaton::InitialStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Initial state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::RealTimeHeightDeterministicNPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/PDA/SinglePopDPDA.h b/alib2data/src/automaton/PDA/SinglePopDPDA.h
index b37a6ac702..69afb985d8 100644
--- a/alib2data/src/automaton/PDA/SinglePopDPDA.h
+++ b/alib2data/src/automaton/PDA/SinglePopDPDA.h
@@ -1015,12 +1015,12 @@ template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolTy
class SetConstraint< automaton::SinglePopDPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::SinglePopDPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/PDA/SinglePopNPDA.h b/alib2data/src/automaton/PDA/SinglePopNPDA.h
index bc5a149695..74563f45ea 100644
--- a/alib2data/src/automaton/PDA/SinglePopNPDA.h
+++ b/alib2data/src/automaton/PDA/SinglePopNPDA.h
@@ -1070,12 +1070,12 @@ template < class InputSymbolType, class EpsilonType, class PushdownStoreSymbolTy
class SetConstraint< automaton::SinglePopNPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::SinglePopNPDA < InputSymbolType, EpsilonType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/PDA/VisiblyPushdownDPDA.h b/alib2data/src/automaton/PDA/VisiblyPushdownDPDA.h
index 793440171b..16c2a1859e 100644
--- a/alib2data/src/automaton/PDA/VisiblyPushdownDPDA.h
+++ b/alib2data/src/automaton/PDA/VisiblyPushdownDPDA.h
@@ -1439,12 +1439,12 @@ template < class InputSymbolType, class PushdownStoreSymbolType, class StateType
class SetConstraint< automaton::VisiblyPushdownDPDA < InputSymbolType, PushdownStoreSymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::VisiblyPushdownDPDA < InputSymbolType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
diff --git a/alib2data/src/automaton/PDA/VisiblyPushdownNPDA.h b/alib2data/src/automaton/PDA/VisiblyPushdownNPDA.h
index 58aefaffbc..9532fe5bad 100644
--- a/alib2data/src/automaton/PDA/VisiblyPushdownNPDA.h
+++ b/alib2data/src/automaton/PDA/VisiblyPushdownNPDA.h
@@ -1498,12 +1498,12 @@ template < class InputSymbolType, class PushdownStoreSymbolType, class StateType
class SetConstraint< automaton::VisiblyPushdownNPDA < InputSymbolType, PushdownStoreSymbolType, StateType >, StateType, automaton::FinalStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Final state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::VisiblyPushdownNPDA < InputSymbolType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
@@ -1542,12 +1542,12 @@ template < class InputSymbolType, class PushdownStoreSymbolType, class StateType
class SetConstraint< automaton::VisiblyPushdownNPDA < InputSymbolType, PushdownStoreSymbolType, StateType >, StateType, automaton::InitialStates > {
public:
/**
- * Returns true if the state is still used in some transition of the automaton.
+ * Returns false. Initial state is only a mark that the automaton itself does require further.
*
* \param automaton the tested automaton
* \param state the tested state
*
- * \returns true if the state is used, false othervise
+ * \returns false
*/
static bool used ( const automaton::VisiblyPushdownNPDA < InputSymbolType, PushdownStoreSymbolType, StateType > &, const StateType & ) {
return false;
--
GitLab