src/support/lyxlib.h

   1 // -*- C++ -*-
   2 /**
   3  * \file lyxlib.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * A selection of useful system functions made
   8  * handy for C++ usage.
   9  *
  10  * \author Lars Gullik Bjønnes
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef LYX_LIB_H
  16 #define LYX_LIB_H
  17
  18 #include <string>
  19
  20
  21 namespace lyx {
  22 namespace support {
  23
  24 /// FIXME: some point to this hmm ?
  25 int kill(int pid, int sig);
  26 /// FIXME: same here
  27 void abort();
  28
  29
  30 /**
  31  * Returns true if var is approximately equal to number with allowed error
  32  * of 'error'.
  33  *
  34  * Usage: if (float_equal(var, number, 0.0001)) { }
  35  *
  36  * This will check if 'var' is approx. equal to 'number' with error of 1/1000
  37  */
  38 inline bool float_equal(double var, double number, double error)
  39 {
  40         return (number - error <= var && var <= number + error);
  41 }
  42
  43 } // namespace support
  44 } // namespace lyx
  45
  46 #endif /* LYX_LIB_H */