IncomingIndex.h

Go to the documentation of this file.

/*
 * opencog/atomspace/IncomingIndex.h
 *
 * Copyright (C) 2008,2009,2013 Linas Vepstas <linasvepstas@gmail.com>
 *
 * 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_INCOMING_INDEX_H
#define _OPENCOG_INCOMING_INDEX_H

#include <set>
#include <vector>

#include <opencog/atomspace/HandleSetIndex.h>
#include <opencog/atomspace/types.h>

namespace opencog
{
class IncomingIndex
{
    private:
        HandleSetIndex idx;
    public:
        IncomingIndex(void);
        void insertAtom(const AtomPtr& a);
        void removeAtom(const AtomPtr& a);
        void resize();

        const UnorderedHandleSet& getIncomingSet(Handle) const;

        class iterator
            : public std::iterator<std::forward_iterator_tag, Handle>
        {
            friend class IncomingIndex;
            public:
                iterator(Handle);
                iterator& operator++();
                iterator& operator++(int);
                iterator& operator=(iterator);
                bool operator==(iterator);
                bool operator!=(iterator);
                Handle operator*(void);
            private:
            Handle _h;
            UnorderedHandleSet _iset;
                UnorderedHandleSet::const_iterator _s;
                UnorderedHandleSet::const_iterator _e;
        };

        iterator begin(Handle) const;
        iterator end(void) const;

};

} //namespace opencog

#endif // _OPENCOG_INCOMING_INDEX_H