/usr/include/trilinos/LOCA_Parameter_Entry.H is in libtrilinos-nox-dev 12.10.1-3.
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 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | // $Id$
// $Source$
//@HEADER
// ************************************************************************
//
// LOCA: Library of Continuation Algorithms Package
// Copyright (2005) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "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 SANDIA CORPORATION OR THE
// 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.
//
// Questions? Contact Roger Pawlowski (rppawlo@sandia.gov) or
// Eric Phipps (etphipp@sandia.gov), Sandia National Laboratories.
// ************************************************************************
// CVS Information
// $Source$
// $Author$
// $Date$
// $Revision$
// ************************************************************************
//@HEADER
#ifndef LOCA_PARAMETER_ENTRY_H
#define LOCA_PARAMETER_ENTRY_H
namespace LOCA {
namespace Parameter {
//! Abstract interface for all entries in LOCA::Parameter::Library
/*!
* This class doesn't have much of an interface and really only serves
* the purpose of having a common parent class for parameter entries
* of all value types.
*/
class AbstractEntry {
public:
//! Default contructor
AbstractEntry() {}
//! Destructor
virtual ~AbstractEntry() {}
};
//! Parameter entry interface class templated on \em ValueType
/*!
* This class provides the interface that all parameter entry classes
* should implement. It is templated on the \em ValueType, which is the
* type that the underlying parameter is stored as.
*/
template <class ValueType>
class Entry : public AbstractEntry {
public:
//! Default constructor
Entry() {}
//! Destructor
virtual ~Entry() {}
//! Set parameter this object represents to \em value
virtual void setValue(const ValueType& value) = 0;
//! Get parameter value this object represents
virtual ValueType getValue() const = 0;
//! Informs entry that it is now stored in the library
/*!
* This is used primarily for informing the entry on how to delete
* itself when deleting the library.
*/
virtual void setIsInLibrary() = 0;
};
//! Standard parameter entry class using a function object
/*!
* This is the standard parameter entry class that uses a function object
* to actually set/retrieve parameter values. The nice thing about using
* a function object is it allows one to set parameters that don't actually
* exist in the code, for example, setting a dimensionless group value
* by modifiying a number of physical parameters. By supplying an
* appropriate
* function object, this class should suffice for setting/retrieving
* parameter values in nearly all cases.
*
* The constructor takes a pointer to the supplied function object. It is
* assumed that this class then owns that pointer, and in particular, calls
* delete in the destructor if the entry is successfully added to the
* library. It does not delete the function object otherwise.
*/
template <class FunctorType, class ValueType>
class StandardEntry :
public Entry<ValueType> {
public:
//! Constructor
StandardEntry(FunctorType* fctr) : deleteFctr(false), func(fctr) {}
//! Destructor
virtual ~StandardEntry() { if (deleteFctr) delete func; }
//! Set parameter this object represents to \em value
virtual void setValue(const ValueType& value) { func->set(value); }
//! Get parameter value this object represents
virtual ValueType getValue() const { return func->get(); }
//! Informs entry that it is now stored in the library
/*!
* This is used primarily for informing the entry on how to delete
* itself when deleting the library.
*/
virtual void setIsInLibrary() { deleteFctr = true; }
private:
//! Private to prohibit copying
StandardEntry(const StandardEntry&);
//! Private to prohibit copying
StandardEntry& operator=(const StandardEntry&);
protected:
//! Flag indicating whether to delete function object in destructor
bool deleteFctr;
//! Stores pointer to function object
FunctorType* func;
};
/*!
* \brief Default function object for setting a single parameter in a
* single object using a data member pointer
*/
/*!
* The constructor takes a reference to an object \em object of type\
* \em ObjectType and a pointer \em object_val_ptr to a data member of
* class of \em ObjectType of type \em ValueType. The parameter is set to
* \em value via
* \code
* object.*object_val_ptr = value
* \endcode
*/
template <class ObjectType, class ValueType>
class DefaultFunctor {
public:
//! Constructor
/*!
* \em object is a reference to the object to set the parameter in, and
* \em object_val_ptr is a pointer to a data member of type
* \em ValueType of that class.
*/
DefaultFunctor(ObjectType& object,
ValueType ObjectType::* object_val_ptr) :
obj(object), obj_val_ptr(object_val_ptr) {}
//! Destructor
virtual ~DefaultFunctor() {}
//! Set parameter using object and data member pointer
virtual void set(const ValueType& value) { obj.*obj_val_ptr = value; }
//! Get parameter value this object represents
virtual ValueType get() const { return obj.*obj_val_ptr; }
private:
//! Private to prohibit copying
DefaultFunctor(const DefaultFunctor&);
//! Private to prohibit copying
DefaultFunctor& operator=(const DefaultFunctor&);
protected:
//! Reference to object to set parameter it
ObjectType& obj;
//! Pointer to data member in \em ObjectType of type \em ValueType
ValueType ObjectType::* obj_val_ptr;
};
}
}
#endif
|