ArrayReuse.h

Go to the documentation of this file.

//- ****************************************************************************
//- 
//- Copyright 2009 Sandia Corporation. Under the terms of Contract
//- DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government
//- retains certain rights in this software.
//- 
//- BSD Open Source License.
//- All rights reserved.
//- 
//- Redistribution and use in source and binary forms, with or without
//- modification, are permitted provided that the following conditions are met:
//- 
//-    * Redistributions of source code must retain the above copyright notice,
//-      this list of conditions and the following disclaimer.
//-    * Redistributions in binary form must reproduce the above copyright
//-      notice, this list of conditions and the following disclaimer in the
//-      documentation and/or other materials provided with the distribution.
//-    * Neither the name of Sandia National Laboratories nor the names of its
//-      contributors may be used to endorse or promote products derived from
//-      this software without specific prior written permission.
//- 
//- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
//- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
//- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
//- ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
//- LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
//- SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
//- INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
//- CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
//- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//- POSSIBILITY OF SUCH DAMAGE.
//-
//- ****************************************************************************
 
#ifndef ARRAYREUSE_OBJECT_H
#define ARRAYREUSE_OBJECT_H
 
// **** _SYSTEM INCLUDES_ ******************************************************
 
#include <iostream>
#include <fstream>
#include <vector>
 
// use standard library objects
using namespace std;
 
// **** _LOCAL INCLUDES_ *******************************************************
 
#include "CPPUtils.h"
#include "GeoTessException.h"
 
// **** _BEGIN GEOTESS NAMESPACE_ **********************************************
 
namespace geotess {
 
// **** _FORWARD REFERENCES_ ***************************************************
 
// **** _CLASS DEFINITION_ *****************************************************
 
template<typename T>
class GEOTESS_EXP_IMP ArrayReuse {
private:
 
    int arrayLength;
 
    int arraysAddedPerAlloc;
 
    int initArraysAddedPerAlloc;
 
    int allocArrays;
 
    vector<T*> store;
 
    vector<T*> refStore;
 
    void add(int count) {
        store.push_back(new T[count * arrayLength]);
        for (int i = 0; i < count; ++i)
            refStore.push_back(&store.back()[i * arrayLength]);
 
        allocArrays += count;
    }
 
    void destroy() {
        if ((int)refStore.size() != allocArrays)
        {
            ostringstream os;
            os << endl << "ERROR in ArrayReuse::destroy()" << endl
                    << allocArrays << " arrays have been allocated but "
                    << allocArrays - refStore.size()
                    << " of them have not been returned." << endl;
            throw GeoTessException(os, __FILE__, __LINE__, 23001);
        }
        refStore.clear();
        for (int i = 0; i < (int) store.size(); ++i)
            delete[] store[i];
    }
 
public:
 
    ArrayReuse() :
            arrayLength(1), arraysAddedPerAlloc(1), allocArrays(0) {
    }
    ;
 
    ArrayReuse(int alngth, int acnt) {
        initialize(alngth, acnt, acnt, 8, acnt + acnt);
    }
 
    ArrayReuse(int alngth, int iacnt, int acnt) {
        initialize(alngth, iacnt, acnt, 8, iacnt + acnt);
    }
 
    ArrayReuse(int alngth, int iacnt, int acnt, int rsrvstr, int rsrvrefstr) {
        initialize(alngth, iacnt, acnt, rsrvstr, rsrvrefstr);
    }
 
    virtual ~ArrayReuse() {
        destroy();
    }
 
    T* getArray() {
        if (refStore.size() == 0)
            add(arraysAddedPerAlloc);
 
        T* a = refStore.back();
        refStore.pop_back();
        return a;
    }
 
    void reuseArray(T* a) {
        refStore.push_back(a);
    }
 
    void reset() {
        refStore.clear();
        for (int i = 0; i < (int) store.size(); ++i)
            for (int j = 0;
                    j
                            < ((i == 0) ?
                                    initArraysAddedPerAlloc :
                                    arraysAddedPerAlloc); ++j) {
                refStore.push_back(&store[i][j * arrayLength]);
            }
    }
 
    void resetIfRequired() {
        if ((int) refStore.size() != allocArrays)
            reset();
    }
 
    void initialize(int alngth, int acnt) {
        initialize(alngth, acnt, acnt, 8, acnt + acnt);
    }
 
    void initialize(int alngth, int iacnt, int acnt) {
        initialize(alngth, iacnt, acnt, 8, iacnt + acnt);
    }
 
    void initialize(int alngth, int iacnt, int acnt, int rsrvstr,
            int rsrvrefstr) {
        // first delete any previous allocation
 
        destroy();
 
        // reinitialize
 
        arrayLength = alngth;
        arraysAddedPerAlloc = acnt;
        initArraysAddedPerAlloc = iacnt;
        store.reserve(rsrvstr);
        refStore.reserve(rsrvrefstr);
        add(iacnt);
    }
 
    int getAllocatedArrays() const {
        return allocArrays;
    }
 
    int getUsedArrayCount() const {
        return allocArrays - (int) refStore.size();
    }
 
    int getUnusedArrayCount() const {
        return (int) refStore.size();
    }
 
    int getArrayLength() const {
        return arrayLength;
    }
 
};
// end class ArrayReuse
 
}// end namespace geotess
 
#endif  // ARRAYREUSE_OBJECT_H