fpe.H

Go to the documentation of this file.
00001 /*!@file Util/fpe.H floating-point exceptions */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2001 by the //
00005 // 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@usc.edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Util/fpe.H $
00035 // $Id: fpe.H 4663 2005-06-23 17:47:28Z rjpeters $
00036 //
00037 
00038 #ifndef FPE_H_DEFINED
00039 #define FPE_H_DEFINED
00040 
00041 
00042 /*
00043   Here's a state diagram for turning floating-point exceptions on/off
00044   and locked/unlocked. In this diagram "fpe" is an abbreviation for
00045   "fpExceptions" in the functions declared below.
00046 
00047   *
00048   *                _____ fpeOff()  fpeOff() _____
00049   *               /no-op\ fpeOn()  fpeOn() /no-op\
00050   *              /       \                /       \
00051   * .===============.    /                \    .================.
00052   * | FPE-LOCKED-ON | <-'                  `-> | FPE-LOCKED-OFF |
00053   * '==============='                          '================'
00054   *           ^  |                                        ^  |
00055   * fpeLock() |  |                              fpeLock() |  |
00056   *           |  |                                        |  |
00057   *           |  | fpeUnlock()                            |  | fpeUnlock()
00058   *           |  v                fpeOn()                 |  v
00059   * .===============.  <<-------------------   .================.
00060   * |    FPE-ON     |                          |    FPE-OFF     |
00061   * '==============='   ------------------->>  '================'
00062   *                         fpeOff()
00063 
00064 */
00065 
00066 //! Turn floating-point exceptions on
00067 void fpExceptionsOn();
00068 
00069 //! Turn floating-point exceptions off
00070 void fpExceptionsOff();
00071 
00072 //! Lock floating-point exceptions in their current state.
00073 /*! That is, if FPEs are on now, they will stay locked on even if
00074   someone calls fpExceptionsOff(); likewise, if FPEs are off now,
00075   they will stay locked off even if someone calls
00076   fpExceptionsOn(). */
00077 void fpExceptionsLock();
00078 
00079 //! Unlock floating-point exceptions.
00080 /*! This does not turn FPEs on or off, but does make it possible for
00081   the state to be changed again via fpExceptionsOn() or
00082   fpExceptionsOff(). */
00083 void fpExceptionsUnlock();
00084 
00085 //! Check whether floating-point exceptions are on
00086 bool fpIsEnabled();
00087 
00088 //! Check whether floating-point exceptions are locked in their current state
00089 bool fpIsLocked();
00090 
00091 
00092 // ######################################################################
00093 /* So things look consistent in everyone's emacs... */
00094 /* Local Variables: */
00095 /* indent-tabs-mode: nil */
00096 /* End: */
00097 
00098 #endif // !FPE_H_DEFINED
Generated on Sun May 8 08:06:58 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3