Implicator.h

Go to the documentation of this file.

/*
 * Implicator.h
 *
 * Copyright (C) 2009, 2014 Linas Vepstas
 *
 * Author: Linas Vepstas <linasvepstas@gmail.com>  January 2009
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License v3 as
 * published by the Free Software Foundation and including the exceptions
 * at http://opencog.org/wiki/Licenses
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, write to:
 * Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _OPENCOG_IMPLICATOR_H
#define _OPENCOG_IMPLICATOR_H

#include <vector>

#include <opencog/atomspace/AtomSpace.h>

#include <opencog/atoms/execution/Instantiator.h>
#include <opencog/query/PatternMatchCallback.h>


namespace opencog {

class Implicator :
    public virtual PatternMatchCallback
{
    protected:
        UnorderedHandleSet _result_set;
        HandleSeq _result_list;
        bool _result_changed;

    public:
        Implicator(AtomSpace* as) : _result_changed(false), inst(as),
                                    max_results(SIZE_MAX) {}
        Instantiator inst;
        Handle implicand;
        size_t max_results;

        virtual bool grounding(const std::map<Handle, Handle> &var_soln,
                               const std::map<Handle, Handle> &term_soln);

        virtual void insert_result(const Handle&);
        virtual UnorderedHandleSet get_result_set() { return _result_set; }
        virtual HandleSeq get_result_list();
};

}; // namespace opencog

#endif // _OPENCOG_IMPLICATOR_H