PredicateIndex Class Reference

Management of Predicate objects. More...

#include <PredicateIndex.hpp>

Collaboration diagram for PredicateIndex:

Public Member Functions
	PredicateIndex (const PredicateIndex &)=delete
	Copying these is a terrible idea.
	PredicateIndex (const PredicateIndex &&)=delete
PredicateIndex &	operator= (const PredicateIndex &)=delete
PredicateIndex &	operator= (const PredicateIndex &&)=delete
size_t	get_num_preds () const
	Basic get method.
Predicate *	add_predicate (const string &, Arity)
	Self-explanatory.
Predicate *	find_predicate (const string &, Arity)
	Self-explanatory.
Arity	find_maximum_arity () const
	Find the largest arity appearing in the index.
bool	true_false_added () const
	Sometimes $true and $false appear in the TPTP collection. See if you included them during the parsing.
Predicate *	operator[] (size_t i)
	Access to Predicate pointers, but don't mess with them!
Predicate *	make_definitional_predicate (Arity arity)
	Make a new, unique definitional predicate.

Private Attributes
vector< Predicate * >	preds
	Pointers to all predicates.
unordered_map< PredIndexType, Predicate *, fun_hash >	name_index
	Fast lookup using name and arity.
ID	next_index
	Automatically generate IDs.
ID	next_definitional_id
	Automatically generate IDs for definitional predicates.

Friends
ostream &	operator<< (ostream &, const PredicateIndex &)

Detailed Description

Management of Predicate objects.

Note that the unordered_map can use the hash function from FunctionHash.hpp.

As usual only use this to make Predicates. As long as you do so then it takes care of memory allocation and deallocation.

Definition at line 58 of file PredicateIndex.hpp.

Constructor & Destructor Documentation

PredicateIndex() [1/2]

PredicateIndex::PredicateIndex

(

)

Definition at line 27 of file PredicateIndex.cpp.

: preds()
, name_index()
, next_index(0)
, next_definitional_id(0)
{
}

~PredicateIndex()

PredicateIndex::~PredicateIndex

(

)

Definition at line 35 of file PredicateIndex.cpp.

                                {
    for (size_t i = 0; i < preds.size(); i++)
        delete preds[i];
}

PredicateIndex() [2/2]

PredicateIndex::PredicateIndex ( const PredicateIndex & )

delete

Copying these is a terrible idea.

As usual, let the compiler help you out.

Member Function Documentation

add_predicate()

Predicate * PredicateIndex::add_predicate	(	const string &	name,
		Arity	arity )

Self-explanatory.

Parameters

name	Name of new Predicate.
arity	Arity of new Predicate.

Definition at line 40 of file PredicateIndex.cpp.

                                                      {
    Predicate* new_pred = nullptr;
    auto i = name_index.find(PredIndexType(name, arity));
    if (i == name_index.end()) {
        new_pred = new Predicate(next_index++, name, arity);
        preds.push_back(new_pred);
        name_index.insert(PredMapType(PredIndexType(name, arity), new_pred));
    }
    else {
        new_pred = i->second;
    }
    return new_pred;
}

find_maximum_arity()

Arity PredicateIndex::find_maximum_arity

(

)

const

Find the largest arity appearing in the index.

Definition at line 66 of file PredicateIndex.cpp.

                                               {
  Arity result = 0;
  for (size_t i = 0; i < preds.size(); i++) {
    Arity current = preds[i]->get_arity();
    if (current > result)
      result = current;
  }
  return result;
}

find_predicate()

Predicate * PredicateIndex::find_predicate	(	const string &	fun_name,
		Arity	arity )

Self-explanatory.

Parameters

fun_name	Name of Predicate.
arity	Arity of Predicate.

Definition at line 55 of file PredicateIndex.cpp.

                                                       {
    Predicate* pred = nullptr;
    auto i = name_index.find(PredIndexType(fun_name, arity));
    if (i != name_index.end())
        pred = i->second;
    else
        cerr << "That predicate name doesn't exist" << endl;
    return pred;
}

get_num_preds()

size_t PredicateIndex::get_num_preds ( ) const

inline

Basic get method.

Definition at line 92 of file PredicateIndex.hpp.

{ return preds.size(); }

make_definitional_predicate()

Predicate * PredicateIndex::make_definitional_predicate ( Arity arity )

inline

Make a new, unique definitional predicate.

Parameters

arity

Arity of predicate.

Definition at line 127 of file PredicateIndex.hpp.

                                                        {
        return add_predicate(
            params::definitional_predicate_prefix + std::to_string(next_definitional_id++), 
            arity);
    }

operator[]()

Predicate * PredicateIndex::operator[] ( size_t i )

inline

Access to Predicate pointers, but
don't mess with them!

Definition at line 121 of file PredicateIndex.hpp.

{ return preds[i]; }

true_false_added()

bool PredicateIndex::true_false_added

(

)

const

Sometimes $true and $false appear in the TPTP collection. See if you included them during the parsing.

Definition at line 76 of file PredicateIndex.cpp.

                                            {
    auto i = name_index.find(PredIndexType(string("$true"), 0));
    if (i != name_index.end())
        return true;
    i = name_index.find(PredIndexType(string("$false"), 0));
    if (i != name_index.end())
        return true;
    return false;
}

Friends And Related Symbol Documentation

operator<<

ostream & operator<< ( ostream & out, const PredicateIndex & pi )

friend

Definition at line 86 of file PredicateIndex.cpp.

                                                            {
    out << "Predicate Index" << endl;
    out << "---------------" << endl;
    for (Predicate* p : pi.preds) {
        out << *p << endl;
    }
    return out;
}

Member Data Documentation

name_index

unordered_map<PredIndexType, Predicate*, fun_hash> PredicateIndex::name_index

private

Fast lookup using name and arity.

Definition at line 67 of file PredicateIndex.hpp.

next_definitional_id

ID PredicateIndex::next_definitional_id

private

Automatically generate IDs for definitional predicates.

Definition at line 76 of file PredicateIndex.hpp.

next_index

ID PredicateIndex::next_index

private

Automatically generate IDs.

Definition at line 71 of file PredicateIndex.hpp.

preds

vector<Predicate*> PredicateIndex::preds

private

Pointers to all predicates.

Definition at line 63 of file PredicateIndex.hpp.

---

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

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