ImportanceIndex.h

Go to the documentation of this file.

/*
 * opencog/atomspace/ImportanceIndex.h
 *
 * Copyright (C) 2008-2011 OpenCog Foundation
 * All Rights Reserved
 *
 * 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_IMPORTANCEINDEX_H
#define _OPENCOG_IMPORTANCEINDEX_H

#include <opencog/atomspace/AttentionValue.h>
#include <opencog/atomspace/FixedIntegerIndex.h>

namespace opencog
{
class AtomTable;

class ImportanceIndex: public FixedIntegerIndex
{
public:
    ImportanceIndex(void);
    void insertAtom(Atom*);
    void removeAtom(Atom*);

    void updateImportance(Atom*, int);
    
    UnorderedHandleSet getHandleSet(const AtomTable*,
                              AttentionValue::sti_t,
                              AttentionValue::sti_t) const;

    static unsigned int importanceBin(short);
};

} //namespace opencog

#endif // _OPENCOG_IMPORTANCEINDEX_H