Predicate Class Reference

Basic representation of predicates: here just names, ids and arities. More...

#include <Predicate.hpp>

Collaboration diagram for Predicate:

Public Member Functions
	Predicate (const Predicate &)=delete
	Don't allow copies of these to be made.
	Predicate (const Predicate &&)=delete
Predicate &	operator= (const Predicate &)=delete
Predicate &	operator= (const Predicate &&)=delete
ID	get_ID () const
	Basic get method.
string	get_name () const
	Basic get method.
Arity	get_arity () const
	Basic get method.
bool	is_compatible_with (const Predicate &) const
	Do the name and the arity of a pair of Predicates both match?
string	to_string () const
	Converting to a string just gives you the name.
string	make_LaTeX () const
	Make a useable LaTeX version.

Private Member Functions
	Predicate ()
	These should only be constructed by PredicateIndex, which is a friend, and the constructors are therefore private.
	Predicate (ID new_id)
	Predicate (ID new_id, const string &new_name)
	Predicate (ID new_id, const string &new_name, Arity new_arity)

Private Attributes
ID	id
string	name
Arity	arity

Friends
class	PredicateIndex
ostream &	operator<< (ostream &, const Predicate &)
	Only for debugging.

Detailed Description

Basic representation of predicates: here just names, ids and arities.

This really just acts as identification. See the Literal class, which is where Predicate and Term get connected together. (No pun intended.)

Definition at line 51 of file Predicate.hpp.

Constructor & Destructor Documentation

Predicate() [1/5]

Predicate::Predicate ( )

inlineprivate

These should only be constructed by PredicateIndex, which is a friend, and the constructors are therefore private.

Definition at line 61 of file Predicate.hpp.

: id(0), name(), arity(0) {}

Predicate() [2/5]

Predicate::Predicate ( ID new_id )

inlineprivate

Definition at line 62 of file Predicate.hpp.

: id(new_id), name(), arity(0) {}

Predicate() [3/5]

Predicate::Predicate ( ID new_id, const string & new_name )

inlineprivate

Definition at line 63 of file Predicate.hpp.

    : id(new_id), name(new_name), arity(0) {}

Predicate() [4/5]

Predicate::Predicate ( ID new_id, const string & new_name, Arity new_arity )

inlineprivate

Definition at line 65 of file Predicate.hpp.

    : id(new_id), name(new_name), arity(new_arity) {}

Predicate() [5/5]

Predicate::Predicate ( const Predicate & )

delete

Don't allow copies of these to be made.

As usual, let the compiler find any errors because you should never need to make copies this way.

Member Function Documentation

get_arity()

Arity Predicate::get_arity ( ) const

inline

Basic get method.

Definition at line 90 of file Predicate.hpp.

{ return arity; }

get_ID()

ID Predicate::get_ID ( ) const

inline

Basic get method.

Definition at line 82 of file Predicate.hpp.

{ return id; }

get_name()

string Predicate::get_name ( ) const

inline

Basic get method.

Definition at line 86 of file Predicate.hpp.

{ return name; }

is_compatible_with()

bool Predicate::is_compatible_with

(

const Predicate &

p2

)

const

Do the name and the arity of a pair of Predicates both match?

Parameters

p2	Predicate to compare with

Definition at line 39 of file Predicate.cpp.

                                                            {
    return (name == p2.name) && (arity == p2.arity);
}

make_LaTeX()

string Predicate::make_LaTeX

(

)

const

Make a useable LaTeX version.

Assumes you are typesetting in Math Mode.

Definition at line 32 of file Predicate.cpp.

                                   {
  string s ("\\text{");
  s += latex_escape_characters(name);
  s += "}";
  return s;
}

to_string()

string Predicate::to_string

(

)

const

Converting to a string just gives you the name.

Definition at line 27 of file Predicate.cpp.

                                  {
  colour_string::ColourString cs(params::use_colours);
  return cs(name).purple();
}

Friends And Related Symbol Documentation

operator<<

ostream & operator<< ( ostream & out, const Predicate & p )

friend

Only for debugging.

Use Predicate::to_string if you want something pretty.

Definition at line 48 of file Predicate.cpp.

                                                      {
    out << "Predicate: " << setw(params::output_width) << p.id
        << " Name: " << setw(params::output_width + 15) << p.name
        << " Arity: " << setw(params::output_width) << p.arity;
    return out;
}

PredicateIndex

friend class PredicateIndex

friend

Definition at line 68 of file Predicate.hpp.

Member Data Documentation

arity

Arity Predicate::arity

private

Definition at line 55 of file Predicate.hpp.

id

ID Predicate::id

private

Definition at line 53 of file Predicate.hpp.

name

string Predicate::name

private

Definition at line 54 of file Predicate.hpp.

---

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

• /Users/sbh11/Desktop/connection-prover/c++/connect++/source/literal/Predicate.hpp
• /Users/sbh11/Desktop/connection-prover/c++/connect++/source/literal/Predicate.cpp