From 59afd1375a5613dd42a3123a1789862df51dd729 Mon Sep 17 00:00:00 2001 From: Jip Spel Date: Fri, 5 Oct 2018 13:53:06 +0200 Subject: [PATCH] Update documentation --- src/storm-pars/analysis/AssumptionChecker.h | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/src/storm-pars/analysis/AssumptionChecker.h b/src/storm-pars/analysis/AssumptionChecker.h index 059315bfe..9ad2aee08 100644 --- a/src/storm-pars/analysis/AssumptionChecker.h +++ b/src/storm-pars/analysis/AssumptionChecker.h @@ -44,21 +44,28 @@ namespace storm { bool checkOnSamples(std::shared_ptr assumption); /*! - * Checks if an assumption can be validated based on the lattice and underlying transition matrix. + * Tries to validate an assumption based on the lattice and underlying transition matrix. * * @param assumption The assumption to validate. * @param lattice The lattice. - * @return true if the assumption is validated and holds, false otherwise + * @return true if the assumption can be validated and holds, false otherwise */ bool validateAssumption(std::shared_ptr assumption, storm::analysis::Lattice* lattice); /*! - * Looks up if assumption has been validated and holds. + * Looks up if assumption has been validated. * * @param assumption The assumption. - * @return true if the assumption has been validated and holds, false otherwise + * @return true if the assumption has been validated. */ bool validated(std::shared_ptr assumption); + + /*! + * Looks up if assumption is valid. Requires the function to be validated. + * + * @param assumption The assumption. + * @return true if the assumption is valid. + */ bool valid(std::shared_ptr assumption); private: