ROL
ROL_SimController.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ************************************************************************
3 //
4 // Rapid Optimization Library (ROL) Package
5 // Copyright (2014) 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 lead developers:
38 // Drew Kouri (dpkouri@sandia.gov) and
39 // Denis Ridzal (dridzal@sandia.gov)
40 //
41 // ************************************************************************
42 // @HEADER
43 
44 
45 #ifndef ROL_SIMCONTROLLER_H
46 #define ROL_SIMCONTROLLER_H
47 
48 #include "ROL_Vector.hpp"
49 
50 namespace ROL {
51 
52 template <class Real>
54 private:
55  // Storage
56  std::map<std::vector<Real>,int> indices_;
57  std::vector<bool> flags_;
58  std::vector<Ptr<Vector<Real>>> vectors_;
59  int maxIndex_;
60 
61  // Update flags
63 
64  void reset(const bool flag = true) {
65  if ( flag ) {
66  typename std::map<std::vector<Real>,int>::iterator it;
67  for (it = indices_.begin(); it != indices_.end(); ++it) {
68  flags_[it->second] = false;
69  }
70  }
71  }
72 
73 public:
77  : maxIndex_(0), objUpdated_(false), conUpdated_(false) {
78  indices_.clear();
79  flags_.clear();
80  vectors_.clear();
81  }
82 
85  void objectiveUpdate(const bool flag = true) {
86  if (!conUpdated_) {
87  reset(flag);
88  }
89  objUpdated_ = true;
90  if (conUpdated_ && objUpdated_) {
91  objUpdated_ = false;
92  conUpdated_ = false;
93  }
94  }
95 
98  void equalityConstraintUpdate(const bool flag = true) {
99  if (!objUpdated_) {
100  reset(flag);
101  }
102  conUpdated_ = true;
103  if (conUpdated_ && objUpdated_) {
104  objUpdated_ = false;
105  conUpdated_ = false;
106  }
107  }
108 
111  bool get(Vector<Real> &x,
112  const std::vector<Real> &param) {
113  int count = indices_.count(param);
114  bool flag = false;
115  int index = maxIndex_;
116  if (count) {
117  typename std::map<std::vector<Real>,int>::iterator it
118  = indices_.find(param);
119  index = it->second;
120  flag = flags_[index];
121  if (flag) {
122  x.set(*vectors_[index]);
123  }
124  }
125  else {
126  indices_.insert(
127  std::pair<std::vector<Real>,int>(param, index));
128  flags_.push_back(false);
129  vectors_.push_back(x.clone());
130  maxIndex_++;
131  }
132  return flag;
133  }
134 
137  void set(const Vector<Real> &x,
138  const std::vector<Real> &param) {
139  int count = indices_.count(param);
140  int index = maxIndex_;
141  if (count) {
142  typename std::map<std::vector<Real>,int>::iterator it
143  = indices_.find(param);
144  index = it->second;
145  flags_[index] = true;
146  vectors_[index]->set(x);
147  }
148  else {
149  indices_.insert(
150  std::pair<std::vector<Real>,int>(param, index));
151  flags_.push_back(true);
152  vectors_.push_back(x.clone());
153  vectors_[index]->set(x);
154  maxIndex_++;
155  }
156  }
157 }; // class SimController
158 
159 } // namespace ROL
160 
161 #endif
void reset(const bool flag=true)
virtual ROL::Ptr< Vector > clone() const =0
Clone to make a new (uninitialized) vector.
void equalityConstraintUpdate(const bool flag=true)
Equality constraint update for SimController storage.
SimController(void)
Constructor.
void objectiveUpdate(const bool flag=true)
Objective function update for SimController storage.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
std::map< std::vector< Real >, int > indices_
void set(const Vector< Real > &x, const std::vector< Real > &param)
Set vector corresponding to input parameter.
std::vector< Ptr< Vector< Real > > > vectors_
std::vector< bool > flags_