AtomUtils.h

Go to the documentation of this file.

/*
 * AtomUtils.h
 *
 * Copyright (C) 2014 OpenCog Foundation
 *
 * Author: William Ma <https://github.com/williampma>
 *
 * 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_ATOM_UTILS_H
#define _OPENCOG_ATOM_UTILS_H

#include <opencog/atomspace/atom_types.h>
#include <opencog/atomspace/Atom.h>
#include <opencog/atomspace/Handle.h>
#include <opencog/atomspace/types.h>

namespace opencog
{
const bool NO_SUBCLASSES = false;

HandleSeq get_all_nodes(Handle h);

UnorderedHandleSet get_all_unique_nodes(Handle h);

HandleSeq get_all_atoms(Handle h);

UnorderedHandleSet get_all_unique_atoms(Handle h);

HandleSeq get_neighbors(const Handle&, bool fanin=true, bool fanout=true,
                        Type linkType=LINK, bool subClasses=true);

UnorderedHandleSet get_outgoing_nodes(const Handle& hinput,
                                      const std::vector<Type>& types =
                                      std::vector<Type>());

UnorderedHandleSet get_distant_neighbors(const Handle& h, int dist = 1);

HandleSeq get_predicates(const Handle& target, 
                         Type predicateType=PREDICATE_NODE,
                         bool subClasses=true);

HandleSeq get_predicates_for(const Handle& target, 
                             const Handle& predicate);

}


#endif // _OPENCOG_ATOM_UTILS_H