AllocAux.H

Go to the documentation of this file.
00001 /*!@file Util/AllocAux.H memory allocation routines for 16-byte alignment */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   //
00005 // by the University of Southern California (USC) and the iLab at USC.  //
00006 // See http://iLab.usc.edu for information about this project.          //
00007 // //////////////////////////////////////////////////////////////////// //
00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00010 // in Visual Environments, and Applications'' by Christof Koch and      //
00011 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00012 // pending; application number 09/912,225 filed July 23, 2001; see      //
00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00014 // //////////////////////////////////////////////////////////////////// //
00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00016 //                                                                      //
00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00018 // redistribute it and/or modify it under the terms of the GNU General  //
00019 // Public License as published by the Free Software Foundation; either  //
00020 // version 2 of the License, or (at your option) any later version.     //
00021 //                                                                      //
00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00025 // PURPOSE.  See the GNU General Public License for more details.       //
00026 //                                                                      //
00027 // You should have received a copy of the GNU General Public License    //
00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00030 // Boston, MA 02111-1307 USA.                                           //
00031 // //////////////////////////////////////////////////////////////////// //
00032 //
00033 // Primary maintainer for this file: Rob Peters <rjpeters at usc dot edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Util/AllocAux.H $
00035 // $Id: AllocAux.H 9602 2008-04-10 00:16:46Z rjpeters $
00036 //
00037 
00038 #ifndef UTIL_ALLOCAUX_H_DEFINED
00039 #define UTIL_ALLOCAUX_H_DEFINED
00040 
00041 #include <cstdlib> // for size_t
00042 
00043 /// Allocate nbytes of memory, throwing an exception in case of failure.
00044 void* invt_allocate_aux(size_t nbytes);
00045 
00046 /// Deallocate the given memory region.
00047 void invt_deallocate_aux(void* mem);
00048 
00049 /// Released any cached free memory blocks (e.g. to conserve memory)
00050 void invt_allocation_release_free_mem();
00051 
00052 /// Turn on/off caching of memory blocks of commonly-used sizes
00053 void invt_allocation_allow_caching(bool on);
00054 
00055 /// Turn on/off memory-allocation debugging statements.
00056 /*! If on, each invt_allocate() and invt_deallocate() call will print
00057     some stats about the memory block being currently
00058     allocated/deallocated, as well as some general stats about the
00059     total amount of memory allocated and the amount of memory
00060     currently in use */
00061 void invt_allocation_debug_print(bool print);
00062 
00063 /// Print current stats for whatever memory allocator is in use.
00064 /** @param verbosity If greater than 0, will request additional stats
00065     to be displayed
00066 
00067     @param pfx If non-null, will be printed at the beginning of each
00068     stats line.
00069 
00070     @param units If non-zero, allocated memory blocks will be listed
00071     as multiples of this number of bytes; otherwise memory blocks will
00072     be listed as multiples of the units specified in the most recent
00073     call to invt_allocation_set_stats_units().
00074 */
00075 void invt_allocation_show_stats(int verbosity = 0,
00076                                 const char* pfx = 0,
00077                                 const size_t units = 0);
00078 
00079 /// Set the units to be used by default in invt_allocation_show_stats()
00080 void invt_allocation_set_stats_units(const size_t units);
00081 
00082 // ######################################################################
00083 /* So things look consistent in everyone's emacs... */
00084 /* Local Variables: */
00085 /* indent-tabs-mode: nil */
00086 /* End: */
00087 
00088 #endif // UTIL_ALLOCAUX_H_DEFINED
Generated on Sun May 8 08:42:24 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3