#include <Predicate.h>

Inheritance diagram for knowrob::Predicate:

[legend]

Collaboration diagram for knowrob::Predicate:

Public Member Functions
	Predicate (std::string_view functor, const std::vector< TermPtr > &arguments={})

	Predicate (AtomPtr functor, const std::vector< TermPtr > &arguments={})

auto &	functor () const

auto	arity () const

const std::vector< TermPtr > &	arguments () const

const std::set< std::string_view > &	variables ()

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

size_t	hash () const

	Predicate (std::string_view functor, const std::vector< TermPtr > &arguments={})

	Predicate (AtomPtr functor, const std::vector< TermPtr > &arguments={})

auto &	functor () const

auto	arity () const

const std::vector< TermPtr > &	arguments () const

const std::set< std::string_view > &	variables ()

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

size_t	hash () const

Public Member Functions inherited from knowrob::Formula
	Formula (const FormulaType &type)

virtual	~Formula ()=default

bool	operator== (const Formula &other) const

FormulaType	type () const

bool	isAtomic () const

bool	isGround () const

bool	isTop () const

bool	isBottom () const

	Formula (const FormulaType &type)

virtual	~Formula ()=default

bool	operator== (const Formula &other) const

FormulaType	type () const

bool	isAtomic () const

bool	isGround () const

bool	isTop () const

bool	isBottom () const

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

virtual std::string	format () const

virtual	~Printable ()=default

virtual std::string	format () const

Static Public Member Functions
static FunctionPtr	toFunction (const std::shared_ptr< Predicate > &predicate)

static std::shared_ptr< Predicate >	fromFunction (const FunctionPtr &fn)

static FunctionPtr	toFunction (const std::shared_ptr< Predicate > &predicate)

static std::shared_ptr< Predicate >	fromFunction (const FunctionPtr &fn)

Protected Member Functions
std::set< std::string_view >	getVariables1 () const

bool	isEqual (const Formula &other) const override

std::set< std::string_view >	getVariables1 () const

bool	isEqual (const Formula &other) const override

Protected Attributes
const AtomPtr	functor_

const std::vector< TermPtr >	arguments_

const std::set< std::string_view >	variables_

Protected Attributes inherited from knowrob::Formula
const FormulaType	type_

bool	isGround_ = true

Detailed Description

A predicate with a functor and a number of term arguments.

Definition at line 22 of file Predicate.h.

Constructor & Destructor Documentation

◆ Predicate() [1/4]

Predicate::Predicate	(	std::string_view	functor,
		const std::vector< TermPtr > &	arguments = `{}`
	)

explicit

Parameters

functor	the functor name.
arguments	vector of predicate arguments.

Definition at line 14 of file Predicate.cpp.

15 : Predicate(Atom::Tabled(functor), arguments) {

16 }

knowrob::Atom::Tabled

static std::shared_ptr< knowrob::Atom > Tabled(std::string_view stringForm)

Definition: Atom.cpp:40

knowrob::Predicate::arguments

const std::vector< TermPtr > & arguments() const

Definition: Predicate.h:52

knowrob::Predicate::functor

auto & functor() const

Definition: Predicate.h:40

knowrob::Predicate::Predicate

Predicate(std::string_view functor, const std::vector< TermPtr > &arguments={})

Definition: Predicate.cpp:14

◆ Predicate() [2/4]

Predicate::Predicate	(	AtomPtr	functor,
		const std::vector< TermPtr > &	arguments = `{}`
	)

explicit

Parameters

functor	the functor name.
arguments	vector of predicate arguments.

Definition at line 18 of file Predicate.cpp.

         : Formula(FormulaType::PREDICATE),
           functor_(std::move(functor)),
           arguments_(arguments),
           variables_(getVariables1()) {
     isGround_ = variables_.empty();
 }

◆ Predicate() [3/4]

knowrob::Predicate::Predicate	(	std::string_view	functor,
		const std::vector< TermPtr > &	arguments = `{}`
	)

explicit

Parameters

functor	the functor name.
arguments	vector of predicate arguments.

◆ Predicate() [4/4]

knowrob::Predicate::Predicate	(	AtomPtr	functor,
		const std::vector< TermPtr > &	arguments = `{}`
	)

explicit

Parameters

functor	the functor name.
arguments	vector of predicate arguments.

Member Function Documentation

◆ arguments() [1/2]

const std::vector<TermPtr>& knowrob::Predicate::arguments ( ) const

inline

Get the arguments of this predicate.

Returns: a vector of predicate arguments.

Definition at line 52 of file Predicate.h.

52 { return arguments_; }

◆ arguments() [2/2]

const std::vector<TermPtr>& knowrob::Predicate::arguments ( ) const

inline

Get the arguments of this predicate.

Returns: a vector of predicate arguments.

Definition at line 52 of file Predicate.h.

52 { return arguments_; }

◆ arity() [1/2]

auto knowrob::Predicate::arity ( ) const

inline

Get the arity of this predicate.

Returns: the arity.

Definition at line 46 of file Predicate.h.

46 { return arguments().size(); }

◆ arity() [2/2]

auto knowrob::Predicate::arity ( ) const

inline

Get the arity of this predicate.

Returns: the arity.

Definition at line 46 of file Predicate.h.

46 { return arguments().size(); }

◆ fromFunction() [1/2]

std::shared_ptr< Predicate > Predicate::fromFunction ( const FunctionPtr & fn )

static

Definition at line 89 of file Predicate.cpp.

                                                                       {
     return std::make_shared<Predicate>(fn->functor(), fn->arguments());
 }

◆ fromFunction() [2/2]

static std::shared_ptr<Predicate> knowrob::Predicate::fromFunction ( const FunctionPtr & fn )

static

◆ functor() [1/2]

auto& knowrob::Predicate::functor ( ) const

inline

Get the functor of this predicate.

Returns: the functor.

Definition at line 40 of file Predicate.h.

40 { return functor_; }

◆ functor() [2/2]

auto& knowrob::Predicate::functor ( ) const

inline

Get the functor of this predicate.

Returns: the functor.

Definition at line 40 of file Predicate.h.

40 { return functor_; }

◆ getVariables1() [1/2]

std::set< std::string_view > Predicate::getVariables1 ( ) const

protected

Definition at line 38 of file Predicate.cpp.

                                                       {
     std::set<std::string_view> out;
     for (auto &arg: arguments_) {
         out.insert(arg->variables().begin(), arg->variables().end());
     }
     return out;
 }

◆ getVariables1() [2/2]

std::set<std::string_view> knowrob::Predicate::getVariables1 ( ) const

protected

◆ hash() [1/2]

size_t Predicate::hash ( ) const

Definition at line 46 of file Predicate.cpp.

                              {
     static const auto GOLDEN_RATIO_HASH = static_cast<size_t>(0x9e3779b9);
     auto seed = static_cast<size_t>(0);
  
     // Combine the hashes.
     // The function (a ^ (b + GOLDEN_RATIO_HASH + (a << 6) + (a >> 2))) is known to
     // give a good distribution of hash values across the range of size_t.
     //
     seed ^= std::hash<std::string_view>{}(functor_->stringForm()) + GOLDEN_RATIO_HASH + (seed << 6) + (seed >> 2);
     for (auto &arg: arguments_) {
         seed ^= arg->hash() + GOLDEN_RATIO_HASH + (seed << 6) + (seed >> 2);
     }
  
     return seed;
 }

◆ hash() [2/2]

size_t knowrob::Predicate::hash ( ) const

◆ isEqual() [1/2]

bool Predicate::isEqual ( const Formula & other ) const

overrideprotectedvirtual

Implements knowrob::Formula.

Reimplemented in knowrob::Top, knowrob::Bottom, and knowrob::Top.

Definition at line 26 of file Predicate.cpp.

                                                   {
     const auto &x = static_cast<const Predicate &>(other); // NOLINT
     if (*functor() == *x.functor() && arguments_.size() == x.arguments_.size()) {
         for (std::size_t i = 0; i < arguments_.size(); ++i) {
             if (!(*(arguments_[i]) == *(x.arguments_[i]))) return false;
         }
         return true;
     } else {
         return false;
     }
 }

◆ isEqual() [2/2]

bool knowrob::Predicate::isEqual ( const Formula & other ) const

overrideprotectedvirtual

Implements knowrob::Formula.

Reimplemented in knowrob::Top.

◆ toFunction() [1/2]

FunctionPtr Predicate::toFunction ( const std::shared_ptr< Predicate > & predicate )

static

Definition at line 85 of file Predicate.cpp.

                                                                            {
     return std::make_shared<Function>(predicate->functor(), predicate->arguments());
 }

◆ toFunction() [2/2]

static FunctionPtr knowrob::Predicate::toFunction ( const std::shared_ptr< Predicate > & predicate )

static

◆ variables() [1/2]

const std::set<std::string_view>& knowrob::Predicate::variables ( )

inline

Definition at line 55 of file Predicate.h.

55 { return variables_; }

◆ variables() [2/2]

const std::set<std::string_view>& knowrob::Predicate::variables ( )

inline

Definition at line 55 of file Predicate.h.

55 { return variables_; }

◆ write() [1/2]

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

overridevirtual

Print this object to a stream.

Parameters

os	the stream to print to.

Implements knowrob::Printable.

Reimplemented in knowrob::Top, knowrob::Bottom, and knowrob::Top.

Definition at line 62 of file Predicate.cpp.

                                           {
     static const auto a_triple = Atom::Tabled("triple");
  
     if (arity() == 3 &&
         arguments_[1]->termType() != TermType::VARIABLE &&
         *functor_ == *a_triple) {
         os << *arguments_[1] << '(' << *arguments_[0] << ',' << *arguments_[2] << ')';
     } else {
         os << *functor_;
         if (!arguments_.empty()) {
             os << '(';
             for (uint32_t i = 0; i < arguments_.size(); i++) {
                 Term *t = arguments_[i].get();
                 os << (*t);
                 if (i + 1 < arguments_.size()) {
                     os << ',' << ' ';
                 }
             }
             os << ')';
         }
     }
 }

◆ write() [2/2]

void knowrob::Predicate::write ( std::ostream & os ) const

overridevirtual

Print this object to a stream.

Parameters

os	the stream to print to.

Implements knowrob::Printable.

Reimplemented in knowrob::Top.

Member Data Documentation

◆ arguments_

const std::vector< TermPtr > knowrob::Predicate::arguments_

protected

Definition at line 69 of file Predicate.h.

◆ functor_

const AtomPtr knowrob::Predicate::functor_

protected

Definition at line 68 of file Predicate.h.

◆ variables_

const std::set< std::string_view > knowrob::Predicate::variables_

protected

Definition at line 70 of file Predicate.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/formulas/Predicate.h
src/formulas/Predicate.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Predicate() [1/4]

◆ Predicate() [2/4]

◆ Predicate() [3/4]

◆ Predicate() [4/4]

Member Function Documentation

◆ arguments() [1/2]

◆ arguments() [2/2]

◆ arity() [1/2]

◆ arity() [2/2]

◆ fromFunction() [1/2]

◆ fromFunction() [2/2]

◆ functor() [1/2]

◆ functor() [2/2]

◆ getVariables1() [1/2]

◆ getVariables1() [2/2]

◆ hash() [1/2]

◆ hash() [2/2]

◆ isEqual() [1/2]

◆ isEqual() [2/2]

◆ toFunction() [1/2]

◆ toFunction() [2/2]

◆ variables() [1/2]

◆ variables() [2/2]

◆ write() [1/2]

◆ write() [2/2]

Member Data Documentation

◆ arguments_

◆ functor_

◆ variables_