ginac/utils.cpp

   1 /** @file utils.cpp
   2  *
   3  *  Implementation of several small and furry utilities. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #include "utils.h"
  24
  25 namespace GiNaC {
  26
  27 /** Integer binary logarithm */
  28 unsigned log2(unsigned n)
  29 {
  30     unsigned k;
  31     for (k = 0; n > 1; n >>= 1) ++k;
  32     return k;
  33 }
  34
  35 /** Compare two pointers (just to establish some sort of canonical order).
  36  *  @return -1, 0, or 1 */
  37 int compare_pointers(void const * a, void const * b)
  38 {
  39     if (a<b) {
  40         return -1;
  41     } else if (a>b) {
  42         return 1;
  43     }
  44     return 0;
  45 }
  46
  47
  48 // comment skeleton for header files
  49
  50
  51 // member functions
  52
  53     // default constructor, destructor, copy constructor assignment operator and helpers
  54     // none
  55
  56     // other constructors
  57     // none
  58
  59     // functions overriding virtual functions from bases classes
  60     // none
  61
  62     // new virtual functions which can be overridden by derived classes
  63     // none
  64
  65     // non-virtual functions in this class
  66     // none
  67
  68 // member variables
  69 // none
  70
  71
  72
  73 // comment skeleton for implementation files
  74
  75
  76 //////////
  77 // default constructor, destructor, copy constructor assignment operator and helpers
  78 //////////
  79
  80 // public
  81 // protected
  82
  83 //////////
  84 // other constructors
  85 //////////
  86
  87 // public
  88 // none
  89
  90 //////////
  91 // functions overriding virtual functions from bases classes
  92 //////////
  93
  94 // public
  95 // protected
  96 // none
  97
  98 //////////
  99 // new virtual functions which can be overridden by derived classes
 100 //////////
 101
 102 // public
 103 // protected
 104 // none
 105
 106 //////////
 107 // non-virtual functions in this class
 108 //////////
 109
 110 // public
 111 // protected
 112 // none
 113
 114 //////////
 115 // static member variables
 116 //////////
 117
 118 // protected
 119 // private
 120 // none
 121
 122 } // namespace GiNaC