/usr/include/trilinos/Teuchos_DependencySheet.hpp is in libtrilinos-teuchos-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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 | // @HEADER
// ***********************************************************************
//
// Teuchos: Common Tools Package
// Copyright (2004) 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 Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER
#ifndef TEUCHOS_DEPENDENCYSHEET_HPP_
#define TEUCHOS_DEPENDENCYSHEET_HPP_
/*! \file Teuchos_DependencySheet.hpp
\brief DataStructure keeping track of dependencies.
*/
#include "Teuchos_Dependency.hpp"
namespace Teuchos{
/**
* \brief A Dependency sheet keeps track of dependencies between various
* ParameterEntries
*/
class TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT DependencySheet{
public:
/** \name Public types */
//@{
/**
* \brief Convience typedef representing a set of dependencies.
*/
typedef std::set<RCP<Dependency>, RCPComp > DepSet;
/**
* \brief Convience typedef. Maps dependee parameter entries to a set of their corresponding
* dependencies.
*/
typedef map<RCP<const ParameterEntry>, DepSet, RCPConstComp > DepMap;
//@}
/** \name Constructors/Destructor */
//@{
/**
* \brief Constructs an empty DependencySheet with the name DEP_ANONYMOUS.
*/
DependencySheet();
/**
* \brief Constructs a DependencySheet.
*
* @param name Name of the Dependency Sheet.
*/
DependencySheet(const std::string &name);
//@}
/** \name Add/Remove Functions */
//@{
/**
* \brief Adds a dependency to the sheet.
*
* @param dependency The dependency to be added.
*/
void addDependency(RCP<Dependency> dependency);
/**
* \brief Adds a dependencies from another she
* to this sheet.
*
* @param otherSheet The other sheet from which
* to add dependencies.
*/
void addDependencies(RCP<DependencySheet> otherSheet);
/**
* \brief Removes a particular dependency between two parameters.
*
* @param dependency The dependency to be removed.
* @return True if the removal was sucessfull, false otherwise.
*/
void removeDependency(RCP<Dependency> dependency);
/**
* \brief sets the name of the dependency sheet
*/
void setName(const std::string newName){
name_ = newName;
}
//@}
//! \name Attribute/Query Functions
//@{
/**
* \brief Determines whether or not a parameter is depended upon by any another
* parameters or parameter lists.
*
* @param name The paramteter to be checked for dependents.
* @return True if the parameter you're checking has other dependents, false otherwise.
*/
inline bool hasDependents(RCP<const ParameterEntry> dependee) const{
return (dependenciesMap_.find(dependee) != dependenciesMap_.end()
&& dependenciesMap_.find(dependee)->second.size() > 0);
}
/**
* \brief Returns a set of all the dependencies associated with a
* particular dependee. If no dependencies with the given dependee have
* ever been enetered into the sheet then a null reference is returned.
*
* @param dependee The parameter whose dependencies are sought.
* @return A set of all dependencies associated with the dependee parameter.
* */
RCP<const DepSet> getDependenciesForParameter(
RCP<const ParameterEntry> dependee) const;
/**
* \brief Gets the name of the dependency sheet.
*/
inline const std::string& getName() const{
return name_;
}
/**
* \brief Determines whether or not this dependency sheet has any dependencies.
*/
inline bool empty() const{
return dependencies_.empty();
}
//@}
/** \name Iterator Functions */
//@{
/**
* \brief Returns an iterator to the beginning of all
* the dependees in the sheet.
*/
inline DepSet::iterator depBegin(){
return dependencies_.begin();
}
/**
* Returns an iterator to the end of all of the dependees in the sheet.
*
* @return An iterator to the end of all of the dependees in the sheet.
*/
inline DepSet::iterator depEnd(){
return dependencies_.end();
}
/**
* \brief Returns a const iterator to the beginning of all the dependees in the sheet.
*/
inline DepSet::const_iterator depBegin() const{
return dependencies_.begin();
}
/**
* \brief Returns a const iterator to the end of all of the dependees in the sheet.
*/
inline DepSet::const_iterator depEnd() const{
return dependencies_.end();
}
/**
* \brief Returns the number of Dependencies in this
* DependencySheet.
*
* @return The number of Depenedencies in this
* DependencySheet.
*/
inline DepSet::size_type size(){
return dependencies_.size();
}
//@}
/** \name I/O Functions */
//@{
/**
* \brief Prints out a list of the dependencies in the DependencySheet
*/
void printDeps(std::ostream& out) const;
/** \brief When serializing to XML, this string should be used as the name
* of the name attribute */
static const std::string& getNameAttributeName(){
static const std::string NAME_ATTRIBUTE_NAME="name";
return NAME_ATTRIBUTE_NAME;
}
//@}
private:
/** \name Private Members */
//@{
/**
* \brief A map containing all the depenecies for a list.
*
* Dependencies with multiple dependees will be found in multiple
* places within the map. Essentially, for each dependee, there will
* be a pointer to each dependency of which it is a part.
*/
DepMap dependenciesMap_;
/**
*\brief A simple set of all the dependencies in this Dependency Sheet.
*/
DepSet dependencies_;
/**
* \brief The Name of the dependency sheet.
*/
std::string name_;
//@}
};
}
#endif //TEUCHOS_DEPENDENCYSHEET_HPP_
|