SPAR/AIModule/BWTA/vendors/CGAL/CGAL/Cache.h

Go to the documentation of this file.

// =============================================================================
//
// Copyright (c) 2001-2007 Max-Planck-Institute Saarbruecken (Germany).
// All rights reserved.
//
// This file is part of CGAL (www.cgal.org); you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; version 2.1 of the License.
// See the file LICENSE.LGPL distributed with CGAL.
//
// Licensees holding a valid commercial license may use this file in
// accordance with the commercial license agreement provided with the software.
//
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
//
// $URL: svn+ssh://scm.gforge.inria.fr/svn/cgal/branches/CGAL-3.5-branch/STL_Extension/include/CGAL/Cache.h $
// $Id: Cache.h 37883 2007-04-03 16:07:32Z ameyer $
//
// Author(s)     : Michael Hemmer    <hemmer@mpi-inf.mpg.de>
//
// =============================================================================

#ifndef CGAL_CACHE_H
#define CGAL_CACHE_H 1

#include <CGAL/basic.h>
#include <CGAL/function_objects.h>

#include <map>

CGAL_BEGIN_NAMESPACE

template < class Input_,
           class Output_,
           class Creator_ = Creator_1<Input_, Output_>,
           class Canonicalizer_ = Creator_1<Input_, Input_>,
           class Compare_ = std::less<Input_> >
class Cache{
public:
    typedef Input_ Input;

    typedef Output_ Output;

    typedef Creator_ Creator;

    typedef Canonicalizer_ Canonicalizer;

    typedef Compare_ Compare;

    typedef Cache<Input,Output,Creator,Canonicalizer,Compare> Self;
private:
    typedef std::map<Input,Output,Compare> Map;
    Map map;
public:
    typedef Map _Rep_type;
    typedef typename _Rep_type::iterator Iterator;
    typedef typename _Rep_type::const_iterator Const_iterator;
    typedef typename _Rep_type::reverse_iterator Reverse_iterator;
    typedef typename _Rep_type::const_reverse_iterator Const_reverse_iterator;
    typedef typename _Rep_type::size_type Size_type;
public:
    Cache() : map() {};

    Output operator () (const Input& input) {
        Canonicalizer canonicalize;
        Input key = canonicalize(input);
        typename Map::iterator it = map.find(key);
        if (it == map.end()) {
            Creator create;
            Output out = create(key);
            map.insert(it,typename Map::value_type(key,out));
            return out;
        } else {
            return (*it).second;
        }
    }

    void clear() { map.clear(); }

    bool is_empty() const { return map.empty(); }

    Size_type size() { return map.size(); }

    Size_type max_size() const { return map.max_size(); }

    Iterator begin() { return map.begin(); }

    Iterator end() { return map.end(); }

    Const_iterator begin() const { return map.begin(); }

    Const_iterator end() const { return map.end(); }

    Reverse_iterator rbegin() { return map.rbegin(); }

    Reverse_iterator rend() { return map.rend(); }

    Const_reverse_iterator rbegin() const { return map.rbegin(); }

    Const_reverse_iterator rend() const { return map.rend(); }

};

CGAL_END_NAMESPACE

#endif