glucose-syrup/mtl/Vec.h

   1 /*******************************************************************************************[Vec.h]
   2 Copyright (c) 2003-2007, Niklas Een, Niklas Sorensson
   3 Copyright (c) 2007-2010, Niklas Sorensson
   4
   5 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
   6 associated documentation files (the "Software"), to deal in the Software without restriction,
   7 including without limitation the rights to use, copy, modify, merge, publish, distribute,
   8 sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
   9 furnished to do so, subject to the following conditions:
  10
  11 The above copyright notice and this permission notice shall be included in all copies or
  12 substantial portions of the Software.
  13
  14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
  15 NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  16 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
  17 DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
  18 OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  19 **************************************************************************************************/
  20
  21 #ifndef Glucose_Vec_h
  22 #define Glucose_Vec_h
  23
  24 #include <assert.h>
  25 #include <new>
  26
  27 #include "mtl/IntTypes.h"
  28 #include "mtl/XAlloc.h"
  29 #include<string.h>
  30
  31 namespace Glucose {
  32
  33 //=================================================================================================
  34 // Automatically resizable arrays
  35 //
  36 // NOTE! Don't use this vector on datatypes that cannot be re-located in memory (with realloc)
  37
  38 template<class T>
  39 class vec {
  40     T*  data;
  41     int sz;
  42     int cap;
  43
  44     // Don't allow copying (error prone):
  45     vec<T>&  operator = (vec<T>& other) { assert(0); return *this; }
  46              vec        (vec<T>& other) { assert(0); }
  47
  48     // Helpers for calculating next capacity:
  49     static inline int  imax   (int x, int y) { int mask = (y-x) >> (sizeof(int)*8-1); return (x&mask) + (y&(~mask)); }
  50     //static inline void nextCap(int& cap){ cap += ((cap >> 1) + 2) & ~1; }
  51     static inline void nextCap(int& cap){ cap += ((cap >> 1) + 2) & ~1; }
  52
  53 public:
  54     // Constructors:
  55     vec()                       : data(NULL) , sz(0)   , cap(0)    { }
  56     explicit vec(int size)      : data(NULL) , sz(0)   , cap(0)    { growTo(size); }
  57     vec(int size, const T& pad) : data(NULL) , sz(0)   , cap(0)    { growTo(size, pad); }
  58    ~vec()                                                          { clear(true); }
  59
  60     // Pointer to first element:
  61     operator T*       (void)           { return data; }
  62
  63     // Size operations:
  64     int      size     (void) const     { return sz; }
  65     void     shrink   (int nelems)     { assert(nelems <= sz); for (int i = 0; i < nelems; i++) sz--, data[sz].~T(); }
  66     void     shrink_  (int nelems)     { assert(nelems <= sz); sz -= nelems; }
  67     int      capacity (void) const     { return cap; }
  68     void     capacity (int min_cap);
  69     void     growTo   (int size);
  70     void     growTo   (int size, const T& pad);
  71     void     clear    (bool dealloc = false);
  72
  73     // Stack interface:
  74     void     push  (void)              { if (sz == cap) capacity(sz+1); new (&data[sz]) T(); sz++; }
  75     void     push  (const T& elem)     { if (sz == cap) capacity(sz+1); data[sz++] = elem; }
  76     void     push_ (const T& elem)     { assert(sz < cap); data[sz++] = elem; }
  77     void     pop   (void)              { assert(sz > 0); sz--, data[sz].~T(); }
  78     // NOTE: it seems possible that overflow can happen in the 'sz+1' expression of 'push()', but
  79     // in fact it can not since it requires that 'cap' is equal to INT_MAX. This in turn can not
  80     // happen given the way capacities are calculated (below). Essentially, all capacities are
  81     // even, but INT_MAX is odd.
  82
  83     const T& last  (void) const        { return data[sz-1]; }
  84     T&       last  (void)              { return data[sz-1]; }
  85
  86     // Vector interface:
  87     const T& operator [] (int index) const { return data[index]; }
  88     T&       operator [] (int index)       { return data[index]; }
  89
  90     // Duplicatation (preferred instead):
  91     void copyTo(vec<T>& copy) const { copy.clear(); copy.growTo(sz); for (int i = 0; i < sz; i++) copy[i] = data[i]; }
  92     void moveTo(vec<T>& dest) { dest.clear(true); dest.data = data; dest.sz = sz; dest.cap = cap; data = NULL; sz = 0; cap = 0; }
  93     void memCopyTo(vec<T>& copy) const{
  94         copy.capacity(cap);
  95         copy.sz = sz;
  96         memcpy(copy.data,data,sizeof(T)*cap);
  97     }
  98
  99 };
 100
 101
 102 template<class T>
 103 void vec<T>::capacity(int min_cap) {
 104     if (cap >= min_cap) return;
 105     int add = imax((min_cap - cap + 1) & ~1, ((cap >> 1) + 2) & ~1);   // NOTE: grow by approximately 3/2
 106     if (add > INT_MAX - cap || ((data = (T*)::realloc(data, (cap += add) * sizeof(T))) == NULL) && errno == ENOMEM)
 107         throw OutOfMemoryException();
 108  }
 109
 110
 111 template<class T>
 112 void vec<T>::growTo(int size, const T& pad) {
 113     if (sz >= size) return;
 114     capacity(size);
 115     for (int i = sz; i < size; i++) data[i] = pad;
 116     sz = size; }
 117
 118
 119 template<class T>
 120 void vec<T>::growTo(int size) {
 121     if (sz >= size) return;
 122     capacity(size);
 123     for (int i = sz; i < size; i++) new (&data[i]) T();
 124     sz = size; }
 125
 126
 127 template<class T>
 128 void vec<T>::clear(bool dealloc) {
 129     if (data != NULL){
 130         for (int i = 0; i < sz; i++) data[i].~T();
 131         sz = 0;
 132         if (dealloc) free(data), data = NULL, cap = 0; } }
 133
 134 //=================================================================================================
 135 }
 136
 137 #endif