/******************************************************************************
* NOMAD -  Nonlinear Optimization for Mixed vAriables and Derivatives.        *
* Copyright (C) 2001-2004  Gilles Couture - Ecole Polytechnique,              *
*                          Charles Audet - Ecole Polytechnique,               *
*		           John Dennis - Rice University.                     *
*                                                                             *
* Author: Gilles Couture                                                      *
* École Polytechnique de Montréal - GERAD                                     *
* C.P. 6079, Succ. Centre-ville, Montréal (Québec) H3C 3A7 Canada             *
* Tel:  (514) 340-6053 x6928                                                  *
* Email: Gilles.Couture@gerad.ca                                              *
* Fax: (514) 340-5665                                                         *
*                                                                             *
* 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. You can find the              *
* GNU General Public License at:                                              *
*             http://www.gnu.org/copyleft/gpl.html                            *
*                                                                             *
* 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. *
*                                                                             *
* You can find information on the NOMAD software at:                          *
*             http://www.gerad.ca/NOMAD/                                      *
******************************************************************************/

// cachecontrol.h -- class definition for CacheControl. This class manages the
// temporary and permanent caches.

#ifndef _CACHECONTROL_H_
#define _CACHECONTROL_H_

class AugmentedPoint;
class StlCache;

class CacheControl
{
  //
 private:
  int display_factor;
  StlCache * perm_cache;
  StlCache * temp_cache;

// The class methods are described in "cachecontrol.cpp"
 public:
  CacheControl(const int dim, const int out, const char * perm);
  ~CacheControl();
  int find(AugmentedPoint & ap, const double * key) const;
  int getPermCacheHits() const;
  int getTempCacheHits() const;
  void closeCaches();
  void continueRun() const;
  void insert(double * inp, double * utp) const;
  void showOutput(ofstream & fout) const;

  // Inline methods.
  // ---------------

  // The display factor is reset.
  void setDisplay(const int display) {display_factor = display;}
};
#endif
