Head

GCC Code Coverage Report

Directory:	.		Exec	Total	Coverage
File:	src/prop/minisat/mtl/Vec.h	Lines:	45	47	95.7 %
Date:	2021-05-21	Branches:	222	524	42.4 %


/*******************************************************************************************[Vec.h]
Copyright (c) 2003-2007, Niklas Een, Niklas Sorensson
Copyright (c) 2007-2010, Niklas Sorensson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**************************************************************************************************/

#ifndef Minisat_Vec_h
#define Minisat_Vec_h

#include <new>

#include "base/check.h"
#include "prop/minisat/mtl/IntTypes.h"
#include "prop/minisat/mtl/XAlloc.h"

namespace cvc5 {
namespace Minisat {

//=================================================================================================
// Automatically resizable arrays
//
// NOTE! Don't use this vector on datatypes that cannot be re-located in memory (with realloc)

template<class T>
class vec {
    T*  data;
    int sz;
    int cap;

    // Don't allow copying (error prone):
    vec<T>& operator=(vec<T>& other)
    {
      Assert(0);
      return *this;
    }
    vec(vec<T>& other) { Assert(0); }

    // Helpers for calculating next capacity:
    static inline int  imax   (int x, int y) { int mask = (y-x) >> (sizeof(int)*8-1); return (x&mask) + (y&(~mask)); }
    //static inline void nextCap(int& cap){ cap += ((cap >> 1) + 2) & ~1; }
    static inline void nextCap(int& cap){ cap += ((cap >> 1) + 2) & ~1; }

public:
    // Constructors:
    vec()                       : data(NULL) , sz(0)   , cap(0)    { }
    explicit vec(int size)      : data(NULL) , sz(0)   , cap(0)    { growTo(size); }
    vec(int size, const T& pad) : data(NULL) , sz(0)   , cap(0)    { growTo(size, pad); }
   ~vec()                                                          { clear(true); }

    // Pointer to first element:
    operator T*       (void)           { return data; }

    // Size operations:
    int      size     (void) const     { return sz; }
    void shrink(int nelems)
    {
      Assert(nelems <= sz);
      for (int i = 0; i < nelems; i++) sz--, data[sz].~T();
    }
    void shrink_(int nelems)
    {
      Assert(nelems <= sz);
      sz -= nelems;
    }
    int      capacity (void) const     { return cap; }
    void     capacity (int min_cap);
    void     growTo   (int size);
    void     growTo   (int size, const T& pad);
    void     clear    (bool dealloc = false);

    // Stack interface:
    void     push  (void)              { if (sz == cap) capacity(sz+1); new (&data[sz]) T(); sz++; }
    void     push  (const T& elem)     { if (sz == cap) capacity(sz+1); data[sz++] = elem; }
    void push_(const T& elem)
    {
      Assert(sz < cap);
      data[sz++] = elem;
    }
    void pop(void)
    {
      Assert(sz > 0);
      sz--, data[sz].~T();
    }
    // NOTE: it seems possible that overflow can happen in the 'sz+1' expression of 'push()', but
    // in fact it can not since it requires that 'cap' is equal to INT_MAX. This in turn can not
    // happen given the way capacities are calculated (below). Essentially, all capacities are
    // even, but INT_MAX is odd.

    const T& last  (void) const        { return data[sz-1]; }
    T&       last  (void)              { return data[sz-1]; }

    // Vector interface:
    const T& operator [] (int index) const { return data[index]; }
    T&       operator [] (int index)       { return data[index]; }

    // Duplication (preferred instead):
    void copyTo(vec<T>& copy) const { copy.clear(); copy.growTo(sz); for (int i = 0; i < sz; i++) copy[i] = data[i]; }
    void moveTo(vec<T>& dest) { dest.clear(true); dest.data = data; dest.sz = sz; dest.cap = cap; data = NULL; sz = 0; cap = 0; }
};


template<class T>
void vec<T>::capacity(int min_cap) {
    if (cap >= min_cap) return;
    int add = imax((min_cap - cap + 1) & ~1, ((cap >> 1) + 2) & ~1);   // NOTE: grow by approximately 3/2
    if (add > INT_MAX - cap || (((data = (T*)::realloc(data, (cap += add) * sizeof(T))) == NULL) && errno == ENOMEM))
        throw OutOfMemoryException();
 }


template<class T>
void vec<T>::growTo(int size, const T& pad) {
    if (sz >= size) return;
    capacity(size);
    for (int i = sz; i < size; i++) data[i] = pad;
    sz = size; }


template<class T>
void vec<T>::growTo(int size) {
    if (sz >= size) return;
    capacity(size);
    for (int i = sz; i < size; i++) new (&data[i]) T();
    sz = size; }


template<class T>
void vec<T>::clear(bool dealloc) {
    if (data != NULL){
        for (int i = 0; i < sz; i++) data[i].~T();
        sz = 0;
        if (dealloc) free(data), data = NULL, cap = 0; } }

//=================================================================================================
}
}  // namespace cvc5

#endif


Generated by: GCOVR (Version 3.2)

Line	Exec	Source
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 Minisat_Vec_h
22		#define Minisat_Vec_h
23
24		#include <new>
25
26		#include "base/check.h"
27		#include "prop/minisat/mtl/IntTypes.h"
28		#include "prop/minisat/mtl/XAlloc.h"
29
30		namespace cvc5 {
31		namespace Minisat {
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)
46		{
47		Assert(0);
48		return *this;
49		}
50		vec(vec<T>& other) { Assert(0); }
51
52		// Helpers for calculating next capacity:
53	10598473	static inline int imax (int x, int y) { int mask = (y-x) >> (sizeof(int)*8-1); return (x&mask) + (y&(~mask)); }
54		//static inline void nextCap(int& cap){ cap += ((cap >> 1) + 2) & ~1; }
55		static inline void nextCap(int& cap){ cap += ((cap >> 1) + 2) & ~1; }
56
57		public:
58		// Constructors:
59	8505866	vec() : data(NULL) , sz(0) , cap(0) { }
60	13008	explicit vec(int size) : data(NULL) , sz(0) , cap(0) { growTo(size); }
61	8988	vec(int size, const T& pad) : data(NULL) , sz(0) , cap(0) { growTo(size, pad); }
62	8527862	~vec() { clear(true); }
63
64		// Pointer to first element:
65	54523462	operator T* (void) { return data; }
66
67		// Size operations:
68	3392827222	int size (void) const { return sz; }
69	71106550	void shrink(int nelems)
70		{
71	71106550	Assert(nelems <= sz);
72	71106550	for (int i = 0; i < nelems; i++) sz--, data[sz].~T();
73	71106550	}
74		void shrink_(int nelems)
75		{
76		Assert(nelems <= sz);
77		sz -= nelems;
78		}
79		int capacity (void) const { return cap; }
80		void capacity (int min_cap);
81		void growTo (int size);
82		void growTo (int size, const T& pad);
83		void clear (bool dealloc = false);
84
85		// Stack interface:
86	1863576	void push (void) { if (sz == cap) capacity(sz+1); new (&data[sz]) T(); sz++; }
87	336755911	void push (const T& elem) { if (sz == cap) capacity(sz+1); data[sz++] = elem; }
88	54126612	void push_(const T& elem)
89		{
90	54126612	Assert(sz < cap);
91	54126612	data[sz++] = elem;
92	54126612	}
93	36929589	void pop(void)
94		{
95	36929589	Assert(sz > 0);
96	36929589	sz--, data[sz].~T();
97	36929589	}
98		// NOTE: it seems possible that overflow can happen in the 'sz+1' expression of 'push()', but
99		// in fact it can not since it requires that 'cap' is equal to INT_MAX. This in turn can not
100		// happen given the way capacities are calculated (below). Essentially, all capacities are
101		// even, but INT_MAX is odd.
102
103		const T& last (void) const { return data[sz-1]; }
104	38015867	T& last (void) { return data[sz-1]; }
105
106		// Vector interface:
107	2754035276	const T& operator [] (int index) const { return data[index]; }
108	2569014227	T& operator [] (int index) { return data[index]; }
109
110		// Duplication (preferred instead):
111	3360247	void copyTo(vec<T>& copy) const { copy.clear(); copy.growTo(sz); for (int i = 0; i < sz; i++) copy[i] = data[i]; }
112	4020	void moveTo(vec<T>& dest) { dest.clear(true); dest.data = data; dest.sz = sz; dest.cap = cap; data = NULL; sz = 0; cap = 0; }
113		};
114
115
116		template<class T>
117	18558884	void vec<T>::capacity(int min_cap) {
118	18558884	if (cap >= min_cap) return;
119	10598473	int add = imax((min_cap - cap + 1) & ~1, ((cap >> 1) + 2) & ~1); // NOTE: grow by approximately 3/2
120	10598473	if (add > INT_MAX - cap \|\| (((data = (T)::realloc(data, (cap += add) sizeof(T))) == NULL) && errno == ENOMEM))
121		throw OutOfMemoryException();
122		}
123
124
125		template<class T>
126	7136551	void vec<T>::growTo(int size, const T& pad) {
127	7136551	if (sz >= size) return;
128	2831095	capacity(size);
129	2831095	for (int i = sz; i < size; i++) data[i] = pad;
130	2831095	sz = size; }
131
132
133		template<class T>
134	5246919	void vec<T>::growTo(int size) {
135	5246919	if (sz >= size) return;
136	5245727	capacity(size);
137	5245727	for (int i = sz; i < size; i++) new (&data[i]) T();
138	5245727	sz = size; }
139
140
141		template<class T>
142	36233179	void vec<T>::clear(bool dealloc) {
143	36233179	if (data != NULL){
144	31858209	for (int i = 0; i < sz; i++) data[i].~T();
145	31858209	sz = 0;
146	31858209	if (dealloc) free(data), data = NULL, cap = 0; } }
147
148		//=================================================================================================
149		}
150		} // namespace cvc5
151
152		#endif