memory_limiter.h

Go to the documentation of this file.

#ifndef MEMORY_LIMITER_CLASS
#define MEMORY_LIMITER_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : memory_limiter                                                    *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2001-$now By Author.  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 is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include <basis/astring.h>
#include <basis/contracts.h>
#include <structures/set.h>
 
namespace structures {
 
// forward.
class ml_memory_record;
class ml_memory_state_meter;
 
 
class memory_limiter
{
public:
  memory_limiter(int overall_limit, int individual_limit);
 
  virtual ~memory_limiter();
 
  DEFINE_CLASS_NAME("memory_limiter");
 
  int overall_limit() const { return _overall_limit; }
  int individual_limit() const { return _individual_limit; }
 
  int overall_usage() const { return _overall_size; }
 
  int overall_space_left() const { return overall_limit() - overall_usage(); }
 
  int individual_usage(int individual) const;
 
  int individual_space_left(int individual) const;
 
  basis::astring text_form(int indent = 0) const;
 
  bool okay_allocation(int individual, int memory_desired);
 
  bool record_deletion(int individual, int memory_deleted);
 
  void reset();
 
  const structures::int_set &individuals_listed() const;
 
private:
  int _overall_limit;  
  int _individual_limit;  
  int _overall_size;  
  ml_memory_state_meter *_individual_sizes;  
 
  ml_memory_record *find_individual(int individual) const;
};
 
} //namespace.
 
#endif