remember.h

Go to the documentation of this file.

/*
 *  GiNaC Copyright (C) 1999-2011 Johannes Gutenberg University Mainz, Germany
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  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 General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef GINAC_REMEMBER_H
#define GINAC_REMEMBER_H

#include <iosfwd>
#include <list>
#include <vector>

namespace GiNaC {

class function;
class ex;
    
class remember_table_entry {
public:
    remember_table_entry(function const & f, ex const & r);
    bool is_equal(function const & f) const;
    ex get_result() const { return result; }
    unsigned long get_last_access() const { return last_access; }
    unsigned long get_successful_hits() const { return successful_hits; };

protected:
    unsigned hashvalue;
    exvector seq;
    ex result;
    mutable unsigned long last_access;
    mutable unsigned successful_hits;
    static unsigned long access_counter;
};    

class remember_table_list : public std::list<remember_table_entry> {
public:
    remember_table_list(unsigned as, unsigned strat);
    void add_entry(function const & f, ex const & result);
    bool lookup_entry(function const & f, ex & result) const;
protected:
    unsigned max_assoc_size;
    unsigned remember_strategy;
};

class remember_table : public std::vector<remember_table_list> {
public:
    remember_table();
    remember_table(unsigned s, unsigned as, unsigned strat);
    bool lookup_entry(function const & f, ex & result) const;
    void add_entry(function const & f, ex const & result);
    void clear_all_entries();
    void show_statistics(std::ostream & os, unsigned level) const;
    static std::vector<remember_table> & remember_tables();
protected:
    void init_table();
    unsigned table_size;
    unsigned max_assoc_size;
    unsigned remember_strategy;
};      

} // namespace GiNaC

#endif // ndef GINAC_REMEMBER_H