Browse Source

Code style and fixing errors in doxygen code for model checker class

main
Lanchid 13 years ago
parent
commit
cdc0332fd7
  1. 278
      src/modelChecker/DtmcPrctlModelChecker.h

278
src/modelChecker/DtmcPrctlModelChecker.h

@ -54,145 +54,145 @@ namespace modelChecker {
*/ */
template<class T> template<class T>
class DtmcPrctlModelChecker { class DtmcPrctlModelChecker {
public: public:
/*! /*!
* Constructor * Constructor
* *
* @parameter Dtmc The dtmc model which is checked. * @param Dtmc The dtmc model which is checked.
*/ */
explicit DtmcPrctlModelChecker(mrmc::models::Dtmc<T>* Dtmc); explicit DtmcPrctlModelChecker(mrmc::models::Dtmc<T>* Dtmc);
/*!
/*! * Copy constructor
* Copy constructor *
* * @param modelChecker The model checker that is copied.
* @parameter modelChecker The model checker that is copied. */
*/ explicit DtmcPrctlModelChecker(mrmc::modelChecker::DtmcPrctlModelChecker<T>* modelChecker);
explicit DtmcPrctlModelChecker(mrmc::modelChecker::DtmcPrctlModelChecker<T>* modelChecker); /*!
* Destructor
/*! */
* Destructor virtual ~DtmcPrctlModelChecker();
*/ /*!
virtual ~DtmcPrctlModelChecker(); * @returns A reference to the dtmc of the model checker.
*/
/*! mrmc::models::Dtmc<T>* getDtmc() const {
* @returns A reference to the dtmc of the model checker. return this->dtmc;
*/ }
mrmc::models::Dtmc<T>* getDtmc() const { /*!
return this->dtmc; * Makes all states in a given set absorbing (i.e. adds self loops with probability 1 and removes all
} * other edges from these states)
*
/*! * @param states A bit vector representing a set of states that should become absorbing.
* Makes all states in a given set absorbing (i.e. adds self loops with probability 1 and removes all */
* other edges from these states) virtual void makeAbsorbing(mrmc::storage::BitVector* states) = 0;
* /*!
* @param states A bit vector representing a set of states that should become absorbing. * Returns all states that are labeled with a given atomic proposition.
*/ *
virtual void makeAbsorbing(mrmc::storage::BitVector* states) = 0; * @param ap A string representing an atomic proposition.
* @returns The set of states labeled with the atomic proposition ap.
/*! */
* Returns all states that are labeled with a given atomic proposition. virtual mrmc::storage::BitVector& getStatesLabeledWith(std::string ap) = 0;
* /*!
* @param ap A string representing an atomic proposition. * Multiplies the matrix with a given vector; the result again is a vector.
* @returns The set of states labeled with the atomic proposition ap. *
*/ * @param vector The vector to multiply the matrix with.
virtual mrmc::storage::BitVector& getStatesLabeledWith(std::string ap) = 0; * @returns The result of multiplying the transition probability matrix with vector.
*/
/*! virtual std::vector<T> multiplyMatrixVector(std::vector<T>* vector) = 0;
* Multiplies the matrix with a given vector; the result again is a vector. /*!
* * The check method for a state formula; Will infer the actual type of formula and delegate it
* @param vector The vector to multiply the matrix with. * to the specialized method
* @returns The result of multiplying the transition probability matrix with vector. *
*/ * @param formula The state formula to check
virtual std::vector<T> multiplyMatrixVector(std::vector<T>* vector) = 0; * @returns The set of states satisfying the formula, represented by a bit vector
*/
/*! virtual mrmc::storage::BitVector checkStateFormula(mrmc::formula::PCTLStateFormula<T>* formula) {
* The check method for a state formula; Will infer the actual type of formula and delegate it return formula->check(this);
* to the specialized method }
* /*!
* @param formula The state formula to check * The check method for a state formula with an And node as root in its formula tree
* @returns The set of states satisfying the formula, represented by a bit vector *
*/ * @param formula The And formula to check
virtual mrmc::storage::BitVector checkStateFormula(mrmc::formula::PCTLStateFormula<T>* formula) { * @returns The set of states satisfying the formula, represented by a bit vector
return formula->check(this); */
} virtual mrmc::storage::BitVector checkAnd(mrmc::formula::And<T>* formula) = 0;
/*!
/*! * The check method for a formula with an AP node as root in its formula tree
* The check method for a state formula with an And node as root in its formula tree *
* * @param formula The AP state formula to check
* @param formula The And formula to check * @returns The set of states satisfying the formula, represented by a bit vector
* @returns The set of states satisfying the formula, represented by a bit vector */
*/ virtual mrmc::storage::BitVector checkAP(mrmc::formula::AP<T>* formula) = 0;
virtual mrmc::storage::BitVector checkAnd(mrmc::formula::And<T>* formula) = 0; /*!
* The check method for a formula with a Not node as root in its formula tree
/*! *
* The check method for a formula with an AP node as root in its formula tree * @param formula The Not state formula to check
* * @returns The set of states satisfying the formula, represented by a bit vector
* @param formula The AP state formula to check */
* @returns The set of states satisfying the formula, represented by a bit vector virtual mrmc::storage::BitVector checkNot(mrmc::formula::Not<T>* formula) = 0;
*/ /*!
virtual mrmc::storage::BitVector checkAP(mrmc::formula::AP<T>*) = 0; * The check method for a state formula with an Or node as root in its formula tree
*
/*! * @param formula The Or state formula to check
* The check method for a formula with a Not node as root in its formula tree * @returns The set of states satisfying the formula, represented by a bit vector
* */
* @param formula The Not state formula to check virtual mrmc::storage::BitVector checkOr(mrmc::formula::Or<T>* formula) = 0;
* @returns The set of states satisfying the formula, represented by a bit vector /*!
*/ * The check method for a state formula with a probabilistic operator node as root in its formula tree
virtual mrmc::storage::BitVector checkNot(mrmc::formula::Not<T>*) = 0; *
* @param formula The state formula to check
/*! * @returns The set of states satisfying the formula, represented by a bit vector
* The check method for a state formula with an Or node as root in its formula tree */
* virtual mrmc::storage::BitVector checkProbabilisticOperator(mrmc::formula::ProbabilisticOperator<T>* formula) = 0;
* @param formula The Or state formula to check /*!
* @returns The set of states satisfying the formula, represented by a bit vector * The check method for a path formula; Will infer the actual type of formula and delegate it
*/ * to the specialized method
virtual mrmc::storage::BitVector checkOr(mrmc::formula::Or<T>*) = 0; *
* @param formula The path formula to check
/*! * @returns for each state the probability that the path formula holds.
* The check method for a state formula with a probabilistic operator node as root in its formula tree */
* virtual std::vector<T> checkPathFormula(mrmc::formula::PCTLPathFormula<T>* formula) {
* @param formula The state formula to check return formula->check(this);
* @returns The set of states satisfying the formula, represented by a bit vector }
*/ /*!
virtual mrmc::storage::BitVector checkProbabilisticOperator(mrmc::formula::ProbabilisticOperator<T>*) = 0; * The check method for a path formula with a Bounded Until operator node as root in its formula tree
*
/*! * @param formula The Bounded Until path formula to check
* The check method for a path formula; Will infer the actual type of formula and delegate it * @returns for each state the probability that the path formula holds.
* to the specialized method */
* virtual std::vector<T> checkBoundedUntil(mrmc::formula::BoundedUntil<T>* formula) = 0;
* @param formula The path formula to check /*!
* @returns for each state the probability that the path formula holds. * The check method for a path formula with a Next operator node as root in its formula tree
*/ *
virtual std::vector<T> checkPathFormula(mrmc::formula::PCTLPathFormula<T>* formula) { * @param formula The Next path formula to check
return formula->check(this); * @returns for each state the probability that the path formula holds.
} */
virtual std::vector<T> checkNext(mrmc::formula::Next<T>* formula) = 0;
/*! /*!
* The check method for a path formula with a Bounded Until operator node as root in its formula tree * The check method for a path formula with an Until operator node as root in its formula tree
* *
* @param formula The Bounded Until path formula to check * @param formula The Until path formula to check
* @returns for each state the probability that the path formula holds. * @returns for each state the probability that the path formula holds.
*/ */
virtual std::vector<T> checkBoundedUntil(mrmc::formula::BoundedUntil<T>*) = 0; virtual std::vector<T> checkUntil(mrmc::formula::Until<T>* formula) = 0;
private:
/*! mrmc::models::Dtmc<T>* dtmc;
* The check method for a path formula with a Next operator node as root in its formula tree
*
* @param formula The Next path formula to check
* @returns for each state the probability that the path formula holds.
*/
virtual std::vector<T> checkNext(mrmc::formula::Next<T>*) = 0;
/*!
* The check method for a path formula with an Until operator node as root in its formula tree
*
* @param formula The Until path formula to check
* @returns for each state the probability that the path formula holds.
*/
virtual std::vector<T> checkUntil(mrmc::formula::Until<T>*) = 0;
private:
mrmc::models::Dtmc<T>* dtmc;
}; };
} //namespace modelChecker } //namespace modelChecker

|||||||
100:0
Loading…
Cancel
Save