Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_DependencySheet.cpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 
43 
45 
46 
47 namespace Teuchos{
48 
49 
51  name_("DEP_ANONYMOUS")
52 {}
53 
54 DependencySheet::DependencySheet(const std::string &name):
55  name_(name)
56 {}
57 
59  Dependency::ConstParameterEntryList dependees = dependency->getDependees();
60  for(
61  Dependency::ConstParameterEntryList::iterator it = dependees.begin();
62  it != dependees.end();
63  ++it)
64  {
65  dependenciesMap_[*it].insert(dependency);
66  }
67  dependencies_.insert(dependency);
68 }
69 
71  Dependency::ConstParameterEntryList dependees = dependency->getDependees();
72  for(
73  Dependency::ConstParameterEntryList::iterator it = dependees.begin();
74  it != dependees.end();
75  ++it)
76  {
77  dependenciesMap_[*it].erase(dependency);
78  }
79  dependencies_.erase(dependency);
80 }
81 
83  RCP<const ParameterEntry> dependee) const
84 {
85  if(dependenciesMap_.find(dependee) != dependenciesMap_.end()){
86  return rcpFromRef(dependenciesMap_.find(dependee)->second);
87  }
88  return null;
89 }
90 
91 void DependencySheet::printDeps(std::ostream& out) const {
92  out << "Dependency Sheet: " << name_ << std::endl << std::endl;
93  for(DepSet::const_iterator it = depBegin(); it != depEnd(); ++it){
94  (*it)->print(out);
95  }
96 }
97 
99  for(
100  DepSet::iterator it = otherSheet->depBegin();
101  it != otherSheet->depEnd();
102  ++it
103  )
104  {
105  addDependency(*it);
106  }
107 }
108 
109 
110 } //namespace Teuchos
111 
DepSet dependencies_
A simple set of all the dependencies in this Dependency Sheet.
std::set< RCP< const ParameterEntry >, RCPConstComp > ConstParameterEntryList
A list of dependents.
DepSet::iterator depBegin()
Returns an iterator to the beginning of all the dependees in the sheet.
std::string name_
The Name of the dependency sheet.
void printDeps(std::ostream &out) const
Prints out a list of the dependencies in the DependencySheet.
void addDependency(RCP< Dependency > dependency)
Adds a dependency to the sheet.
void removeDependency(RCP< Dependency > dependency)
Removes a particular dependency between two parameters.
DependencySheet()
Constructs an empty DependencySheet with the name DEP_ANONYMOUS.
void addDependencies(RCP< DependencySheet > otherSheet)
Adds a dependencies from another she to this sheet.
DataStructure keeping track of dependencies.
DepMap dependenciesMap_
A map containing all the depenecies for a list.
Smart reference counting pointer class for automatic garbage collection.
RCP< const DepSet > getDependenciesForParameter(RCP< const ParameterEntry > dependee) const
Returns a set of all the dependencies associated with a particular dependee. If no dependencies with ...