#include <AnswerYes.h>

Inheritance diagram for knowrob::AnswerYes:

[legend]

Collaboration diagram for knowrob::AnswerYes:

[legend]

Public Member Functions
	AnswerYes ()

	AnswerYes (BindingsPtr substitution)

	AnswerYes (const AnswerYes &other)

bool	isRicherThan (const AnswerYes &other) const

bool	isGenericYes () const

auto &	substitution () const

bool	hasGrounding (const Variable &var) const

bool	addGrounding (const std::shared_ptr< Predicate > &predicate, bool isNegated=false, const GraphSelectorPtr &frame=DefaultGraphSelector())

auto &	positiveGroundings () const

auto &	negativeGroundings () const

bool	mergeWith (const AnswerYes &other, bool ignoreInconsistencies=false)

std::string	stringFormOfYes () const

std::string	humanReadableFormOfYes () const

	AnswerYes ()

	AnswerYes (BindingsPtr substitution)

	AnswerYes (const AnswerYes &other)

bool	isRicherThan (const AnswerYes &other) const

bool	isGenericYes () const

auto &	substitution () const

bool	hasGrounding (const Variable &var) const

bool	addGrounding (const std::shared_ptr< Predicate > &predicate, bool isNegated=false, const GraphSelectorPtr &frame=DefaultGraphSelector())

auto &	positiveGroundings () const

auto &	negativeGroundings () const

bool	mergeWith (const AnswerYes &other, bool ignoreInconsistencies=false)

std::string	stringFormOfYes () const

std::string	humanReadableFormOfYes () const

Public Member Functions inherited from knowrob::Answer
	Answer ()

	Answer (const Answer &other)

auto &	frame () const

void	setFrame (const std::shared_ptr< GraphSelector > &frame)

void	applyFrame (const GraphSelector &frame)

bool	isNegative () const

bool	isPositive () const

bool	isUncertain () const

bool	isCertain () const

void	setIsUncertain (bool val, std::optional< double > confidence)

bool	isOccasionallyTrue () const

bool	isAllwaysTrue () const

void	setIsOccasionallyTrue (bool val)

void	setReasonerTerm (const AtomPtr &reasonerTerm)

auto &	reasonerTerm () const

size_t	hashOfAnswer () const

std::string	stringFormOfAnswer () const

std::string	humanReadableForm () const

	Answer ()

	Answer (const Answer &other)

auto &	frame () const

void	setFrame (const std::shared_ptr< GraphSelector > &frame)

void	applyFrame (const GraphSelector &frame)

bool	isNegative () const

bool	isPositive () const

bool	isUncertain () const

bool	isCertain () const

void	setIsUncertain (bool val, std::optional< double > confidence)

bool	isOccasionallyTrue () const

bool	isAllwaysTrue () const

void	setIsOccasionallyTrue (bool val)

void	setReasonerTerm (const AtomPtr &reasonerTerm)

auto &	reasonerTerm () const

size_t	hashOfAnswer () const

std::string	stringFormOfAnswer () const

std::string	humanReadableForm () const

Public Member Functions inherited from knowrob::Token
	Token (TokenType tokenType)

virtual	~Token ()=default

TokenType	tokenType () const

size_t	hash () const

std::string	stringForm () const

bool	isControlToken () const

bool	isAnswerToken () const

bool	indicatesEndOfEvaluation () const

void	write (std::ostream &os) const override

	Token (TokenType tokenType)

virtual	~Token ()=default

TokenType	tokenType () const

size_t	hash () const

std::string	stringForm () const

bool	isControlToken () const

bool	isAnswerToken () const

bool	indicatesEndOfEvaluation () const

void	write (std::ostream &os) const override

Public Member Functions inherited from knowrob::Printable
virtual	~Printable ()=default

virtual std::string	format () const

virtual	~Printable ()=default

virtual std::string	format () const

Protected Attributes
std::vector< FramedPredicate >	positiveGroundings_

std::vector< FramedPredicate >	negativeGroundings_

BindingsPtr	substitution_

Protected Attributes inherited from knowrob::Answer
std::shared_ptr< GraphSelector >	frame_

AtomPtr	reasonerTerm_

bool	isPositive_ = false

bool	isNegative_ = false

Protected Attributes inherited from knowrob::Token
TokenType	tokenType_

bool	isTerminalToken_ = false

Additional Inherited Members
Protected Member Functions inherited from knowrob::Answer
void	setIsPositive (bool val)

void	setIsNegative (bool val)

void	setIsPositive (bool val)

void	setIsNegative (bool val)

Detailed Description

A positive answer indicates that a querying component has evidence for the input query being true for some instances of the query.

Definition at line 18 of file AnswerYes.h.

Constructor & Destructor Documentation

◆ AnswerYes() [1/6]

AnswerYes::AnswerYes ( )

Default constructor.

Definition at line 16 of file AnswerYes.cpp.

         : Answer(),
           substitution_(std::make_shared<Bindings>()) {
     setIsPositive(true);
 }

◆ AnswerYes() [2/6]

AnswerYes::AnswerYes ( BindingsPtr substitution )

explicit

Definition at line 22 of file AnswerYes.cpp.

         : Answer(),
           substitution_(std::move(substitution)) {
     setIsPositive(true);
 }

◆ AnswerYes() [3/6]

AnswerYes::AnswerYes ( const AnswerYes & other )

Copy constructor.

Parameters

other another answer.

Definition at line 28 of file AnswerYes.cpp.

         : Answer(other),
           positiveGroundings_(other.positiveGroundings_),
           negativeGroundings_(other.negativeGroundings_),
           substitution_(std::make_shared<Bindings>(*other.substitution_)) {
     setIsPositive(true);
 }

◆ AnswerYes() [4/6]

knowrob::AnswerYes::AnswerYes ( )

Default constructor.

◆ AnswerYes() [5/6]

knowrob::AnswerYes::AnswerYes ( BindingsPtr substitution )

explicit

◆ AnswerYes() [6/6]

knowrob::AnswerYes::AnswerYes ( const AnswerYes & other )

Copy constructor.

Parameters

other another answer.

Member Function Documentation

◆ addGrounding() [1/2]

bool AnswerYes::addGrounding	(	const std::shared_ptr< Predicate > &	predicate,
		bool	isNegated = `false`,
		const GraphSelectorPtr &	frame = `DefaultGraphSelector()`
	)

Add a grounded literal to the answer. Positive literals may not contain variables.t

Parameters

predicate	a predicate.
frame	a graph selector.
isNegated	true if the negation of the predicate is grounded.

Definition at line 58 of file AnswerYes.cpp.

                                                             {
     if (!frame_->mergeWith(*frame)) {
         KB_WARN("Failed to frame \"{}\" with \"{}\".", *frame_, *frame);
         return false;
     }
     if (isNegated) {
         negativeGroundings_.emplace_back(predicate, frame, reasonerTerm_);
     } else {
         positiveGroundings_.emplace_back(predicate, frame, reasonerTerm_);
     }
     return true;
 }

◆ addGrounding() [2/2]

bool knowrob::AnswerYes::addGrounding	(	const std::shared_ptr< Predicate > &	predicate,
		bool	isNegated = `false`,
		const GraphSelectorPtr &	frame = `DefaultGraphSelector()`
	)

Add a grounded literal to the answer. Positive literals may not contain variables.t

Parameters

predicate	a predicate.
frame	a graph selector.
isNegated	true if the negation of the predicate is grounded.

◆ hasGrounding() [1/2]

bool knowrob::AnswerYes::hasGrounding ( const Variable & var ) const

inline

Parameters

var	a variable.

Returns: true if the variable is mapped to a term.

Definition at line 56 of file AnswerYes.h.

56 { return substitution_->contains(var.name()); }

knowrob::parsers::terms::var

VariableRule & var()

Definition: terms.cpp:91

◆ hasGrounding() [2/2]

bool knowrob::AnswerYes::hasGrounding ( const Variable & var ) const

inline

Parameters

var	a variable.

Returns: true if the variable is mapped to a term.

Definition at line 56 of file AnswerYes.h.

56 { return substitution_->contains(var.name()); }

◆ humanReadableFormOfYes() [1/2]

std::string AnswerYes::humanReadableFormOfYes ( ) const

Returns: the human readable form of this answer.

Definition at line 133 of file AnswerYes.cpp.

                                                   {
     std::stringstream os;
     os << std::setprecision(4);
     os << "the query is ";
     if (isUncertain()) {
         if (frame_->confidence.has_value()) {
             os << "true with a confidence of " << std::setprecision(4) << frame_->confidence.value();
         } else {
             os << "probably true";
         }
     } else {
         os << "true";
     }
     if (frame_->occasional) {
         os << " at some time ";
     }
     if (frame_->begin.has_value() && frame_->end.has_value()) {
         os << " during the time points " << frame_->begin.value() << " and " << frame_->end.value();
     } else if (frame_->begin.has_value()) {
         os << " since " << frame_->begin.value();
     } else if (frame_->end.has_value()) {
         os << " until " << frame_->end.value();
     }
     os << ".";
     return os.str();
 }

◆ humanReadableFormOfYes() [2/2]

std::string knowrob::AnswerYes::humanReadableFormOfYes ( ) const

Returns: the human readable form of this answer.

◆ isGenericYes() [1/2]

bool AnswerYes::isGenericYes ( ) const

Returns: true if this answer is a generic "yes" answer without any groundings.

Definition at line 54 of file AnswerYes.cpp.

                                    {
     return substitution_->empty();
 }

◆ isGenericYes() [2/2]

bool knowrob::AnswerYes::isGenericYes ( ) const

Returns: true if this answer is a generic "yes" answer without any groundings.

◆ isRicherThan() [1/2]

bool AnswerYes::isRicherThan ( const AnswerYes & other ) const

Parameters

other another answer.

Returns: true if this answer has more information than the other answer.

Definition at line 36 of file AnswerYes.cpp.

                                                          {
     if (isUncertain() != other.isUncertain()) {
         // certain answer is richer than uncertain answer
         return isUncertain() < other.isUncertain();
     } else if (substitution_->size() != other.substitution_->size()) {
         // answer with more substitutions is richer
         return substitution_->size() > other.substitution_->size();
     } else if (positiveGroundings_.size() != other.positiveGroundings_.size()) {
         // answer with more positive groundings is richer
         return positiveGroundings_.size() > other.positiveGroundings_.size();
     } else if (negativeGroundings_.size() != other.negativeGroundings_.size()) {
         // answer with more negative groundings is richer
         return negativeGroundings_.size() > other.negativeGroundings_.size();
     } else {
         return false;
     }
 }

◆ isRicherThan() [2/2]

bool knowrob::AnswerYes::isRicherThan ( const AnswerYes & other ) const

Parameters

other another answer.

Returns: true if this answer has more information than the other answer.

◆ mergeWith() [1/2]

bool AnswerYes::mergeWith	(	const AnswerYes &	other,
		bool	ignoreInconsistencies = `false`
	)

Merge this answer with another answer.

Parameters

other	another answer.
ignoreInconsistencies	if true, inconsistencies are ignored.

Returns: true if the merge was successful.

Definition at line 73 of file AnswerYes.cpp.

                                                                             {
     auto mergedBindings = std::make_shared<Bindings>(*substitution_);
     if (ignoreInconsistencies) {
         // insert all substitutions of other answer, possibly overwriting existing ones
         *mergedBindings += *other.substitution_;
     } else {
         // unify substitutions
         if (!mergedBindings->unifyWith(*other.substitution_)) {
             // unification failed -> results cannot be combined
             return false;
         }
     }
     substitution_ = mergedBindings;
  
     if (!frame_->mergeWith(*other.frame_)) {
         // merging frames failed -> results cannot be combined
         return false;
     }
  
     reasonerTerm_ = {};
     // insert groundings of other answer
     positiveGroundings_.insert(positiveGroundings_.end(),
                                other.positiveGroundings_.begin(), other.positiveGroundings_.end());
     negativeGroundings_.insert(negativeGroundings_.end(),
                                other.negativeGroundings_.begin(), other.negativeGroundings_.end());
  
     return true;
 }

◆ mergeWith() [2/2]

bool knowrob::AnswerYes::mergeWith	(	const AnswerYes &	other,
		bool	ignoreInconsistencies = `false`
	)

Merge this answer with another answer.

Parameters

other	another answer.
ignoreInconsistencies	if true, inconsistencies are ignored.

Returns: true if the merge was successful.

◆ negativeGroundings() [1/2]

auto& knowrob::AnswerYes::negativeGroundings ( ) const

inline

Part of the answer is that certain literals that appear negated in the query are not true. This is a list of such literals.

Returns: a list of negative groundings.

Definition at line 81 of file AnswerYes.h.

81 { return negativeGroundings_; }

◆ negativeGroundings() [2/2]

auto& knowrob::AnswerYes::negativeGroundings ( ) const

inline

Part of the answer is that certain literals that appear negated in the query are not true. This is a list of such literals.

Returns: a list of negative groundings.

Definition at line 81 of file AnswerYes.h.

81 { return negativeGroundings_; }

◆ positiveGroundings() [1/2]

auto& knowrob::AnswerYes::positiveGroundings ( ) const

inline

Part of the answer is that certain literals that appear positive in the query are true. This is a list of such literals.

Returns: a list of positive groundings.

Definition at line 74 of file AnswerYes.h.

74 { return positiveGroundings_; }

◆ positiveGroundings() [2/2]

auto& knowrob::AnswerYes::positiveGroundings ( ) const

inline

Part of the answer is that certain literals that appear positive in the query are true. This is a list of such literals.

Returns: a list of positive groundings.

Definition at line 74 of file AnswerYes.h.

74 { return positiveGroundings_; }

◆ stringFormOfYes() [1/2]

std::string AnswerYes::stringFormOfYes ( ) const

Returns: the string form of this answer.

Definition at line 102 of file AnswerYes.cpp.

                                            {
     std::stringstream os;
     if (reasonerTerm_) {
         os << "[" << *reasonerTerm_ << "] ";
     }
     if (isUncertain()) {
         os << "probably ";
     }
     os << "yes";
     if (!positiveGroundings_.empty() || !negativeGroundings_.empty()) {
         os << ", because:\n";
         for (auto &x: positiveGroundings_) {
             os << '\t' << *x.graphSelector() << ' ' << *x.predicate();
             if (x.reasonerTerm() && x.reasonerTerm() != reasonerTerm_) {
                 os << ' ' << '[' << *x.reasonerTerm() << "]";
             }
             os << '\n';
         }
         for (auto &x: negativeGroundings_) {
             os << '\t' << *x.graphSelector() << '~' << *x.predicate();
             if (x.reasonerTerm() && x.reasonerTerm() != reasonerTerm_) {
                 os << ' ' << '[' << *x.reasonerTerm() << "]";
             }
             os << '\n';
         }
     } else {
         os << '\n';
     }
     return os.str();
 }

◆ stringFormOfYes() [2/2]

std::string knowrob::AnswerYes::stringFormOfYes ( ) const

Returns: the string form of this answer.

◆ substitution() [1/2]

auto& knowrob::AnswerYes::substitution ( ) const

inline

Each positive answer is associated with a substitution that maps variables to terms. This substitution can be used to instantiate the query.

Returns: a mapping from variables to terms.

Definition at line 50 of file AnswerYes.h.

50 { return substitution_; }

◆ substitution() [2/2]

auto& knowrob::AnswerYes::substitution ( ) const

inline

Each positive answer is associated with a substitution that maps variables to terms. This substitution can be used to instantiate the query.

Returns: a mapping from variables to terms.

Definition at line 50 of file AnswerYes.h.

50 { return substitution_; }

Member Data Documentation

◆ negativeGroundings_

std::vector< FramedPredicate > knowrob::AnswerYes::negativeGroundings_

protected

Definition at line 103 of file AnswerYes.h.

◆ positiveGroundings_

std::vector< FramedPredicate > knowrob::AnswerYes::positiveGroundings_

protected

Definition at line 102 of file AnswerYes.h.

◆ substitution_

BindingsPtr knowrob::AnswerYes::substitution_

protected

Definition at line 104 of file AnswerYes.h.

The documentation for this class was generated from the following files:

build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/queries/AnswerYes.h
src/queries/AnswerYes.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AnswerYes() [1/6]

◆ AnswerYes() [2/6]

◆ AnswerYes() [3/6]

◆ AnswerYes() [4/6]

◆ AnswerYes() [5/6]

◆ AnswerYes() [6/6]

Member Function Documentation

◆ addGrounding() [1/2]

◆ addGrounding() [2/2]

◆ hasGrounding() [1/2]

◆ hasGrounding() [2/2]

◆ humanReadableFormOfYes() [1/2]

◆ humanReadableFormOfYes() [2/2]

◆ isGenericYes() [1/2]

◆ isGenericYes() [2/2]

◆ isRicherThan() [1/2]

◆ isRicherThan() [2/2]

◆ mergeWith() [1/2]

◆ mergeWith() [2/2]

◆ negativeGroundings() [1/2]

◆ negativeGroundings() [2/2]

◆ positiveGroundings() [1/2]

◆ positiveGroundings() [2/2]

◆ stringFormOfYes() [1/2]

◆ stringFormOfYes() [2/2]

◆ substitution() [1/2]

◆ substitution() [2/2]

Member Data Documentation

◆ negativeGroundings_

◆ positiveGroundings_

◆ substitution_