/usr/include/casacore/casa/Containers/ObjectStack.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 | //# ObjectStack.h: A stack of re-usable objects
//# Copyright (C) 2007
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//# $Id: ObjectStack.h,v 1.1 2007/11/16 04:08:17 wbrouw Exp $
#ifndef CASA_OBJECTSTACK_H
#define CASA_OBJECTSTACK_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/vector.h>
#include <casacore/casa/OS/Mutex.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward declarations
// <summary>
// A stack of re-usable objects
// </summary>
//
// <use visibility=export>
//
// <reviewed reviewer="Ger van Diepen" date="2001/07/03" tests="tObjectStack.cc" demos="">
// </reviewed>
//
// <prerequisite>
// <li>
// </prerequisite>
//
// <synopsis>
// An ObjectStack contains a set of pre-allocated Objects of the type
// <src>T</src>.
// The stack is a very simple stack, without the
// linking/unlinking of a normal Stack implementation.
// This lightweight implementation was especially designed for use
// with the <linkto class=AutoDiff>AutoDiff</linkto>
// classes, but can be used independently. The stack works best with small
// object sizes, or letter/envelope classes.
//
// The class is fully thread-safe, thus the same object can be used safely
// in multiple threads.
//
// </synopsis>
//
// <example>
// <srcblock>
// {
// // Get an element (and create stack!)
// SparseDiff<Double> elem;
// // Use it
// elem.value() = 27;
// // Release it (automatic by dtor on elem)
// }
// </srcblock>
// </example>
//
// <motivation>
// To improve the speed for the auto differentiating classes.
// </motivation>
//
// <templating arg=T>
// <li> the class T must have a <em>constructor(T::FULLREFRESH)</em>
// for creating new entries and destructor;
// and must possess a <em>clear()</em> method to enable element re-use.
// </templating>
//
// <todo asof="2007/11/27">
// </todo>
template <class T> class ObjectStack {
public:
//# Member functions
// Destructor
~ObjectStack();
// Create a singleton stack
static ObjectStack<T> &stack();
// Get a pointer to an object in the stack. The stack will be extended if
// no objects left.
T *get();
// Return an object to the stack for re-use
void put(T *obj) { obj->clear(); stack_p.push_back(obj); };
// Decimate the stack by getting rid of all unused elements in it
void clear();
// Test if stack empty
Bool empty() { return stack_p.empty(); };
// return the stack extend (for debugging use and checking mainly)
uInt nelements() const { return stack_p.size(); };
private:
//# Data
// The Stack
vector<T*> stack_p;
Mutex mutex_p;
//# Constructors
// All ctor and assignment constructors and assignment (not implemented)
// <group>
ObjectStack() : stack_p() {};
ObjectStack(const ObjectStack<T> &other);
ObjectStack<T> &operator=(const ObjectStack<T> &other);
// </group>
//# Member functions
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/casa/Containers/ObjectStack.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|