ROL
ROL_VectorController.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 #include "ROL_UpdateType.hpp"
50 
51 namespace ROL {
52 
53 template <class Real, class Key=std::vector<Real>>
55 private:
56  // Storage
57  std::map<Key,int> indices_, indices_trial_, indices_temp_;
58  std::vector<bool> flags_, flags_trial_, flags_temp_;
59  std::vector<Ptr<Vector<Real>>> vectors_, vectors_trial_, vectors_temp_;
61 
62  // Update flags
63  bool trial_, temp_;
65 
66 public:
69  VectorController(void);
70 
71  void reset(bool flag = true);
72 
75  void objectiveUpdate(bool flag = true);
76 
79  void constraintUpdate(bool flag = true);
80 
83  void objectiveUpdate(UpdateType type);
84 
87  void constraintUpdate(UpdateType type);
88 
91  bool isNull(const Key &param) const;
92 
95  bool isComputed(const Key &param) const;
96 
99  void allocate(const Vector<Real> &x, const Key &param);
100 
104  const Ptr<Vector<Real>> set(const Key &param);
105 
108  const Ptr<const Vector<Real>> get(const Key &param) const;
109 
112  bool get(Vector<Real> &x, const Key &param);
113 
116  void set(const Vector<Real> &x, const Key &param);
117 
120  void push(VectorController<Real,Key> &to) const;
121 
122 private:
123 
124  void resetTrial(void);
125 
126  void resetTemp(void);
127 
128  bool isNull(const Key &param, const std::map<Key,int> &indices) const;
129 
130  bool isComputed(const Key &param, const std::map<Key,int> &indices,
131  const std::vector<bool> &flags) const;
132 
133  void allocate(const Vector<Real> &x, const Key &param,
134  std::map<Key,int> &indices, std::vector<bool> &flags,
135  std::vector<Ptr<Vector<Real>>> &vectors, int &maxIndex) const;
136 
137  const Ptr<const Vector<Real>> get(const Key &param,
138  const std::map<Key,int> &indices, const std::vector<bool> &flags,
139  const std::vector<Ptr<Vector<Real>>> &vectors, const int &maxIndex) const;
140 
141  const Ptr<Vector<Real>> set(const Key &param,
142  std::map<Key,int> &indices, std::vector<bool> &flags,
143  std::vector<Ptr<Vector<Real>>> &vectors, int &maxIndex) const;
144 
145  bool get(Vector<Real> &x, const Key &param,
146  std::map<Key,int> &indices, std::vector<bool> &flags,
147  std::vector<Ptr<Vector<Real>>> &vectors, int &maxIndex) const;
148 
149  void set(const Vector<Real> &x, const Key &param,
150  std::map<Key,int> &indices, std::vector<bool> &flags,
151  std::vector<Ptr<Vector<Real>>> &vectors, int &maxIndex) const;
152 
153  void accept(void);
154 }; // class VectorController
155 
156 } // namespace ROL
157 
159 
160 #endif
std::map< Key, int > indices_temp_
std::vector< bool > flags_
void constraintUpdate(bool flag=true)
Equality constraint update for VectorController storage.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
std::map< Key, int > indices_
VectorController(void)
Constructor.
bool isComputed(const Key &param) const
Check if vector has been computed.
void push(VectorController< Real, Key > &to) const
Push the contents of *this into another VectorController.
void allocate(const Vector< Real > &x, const Key &param)
Allocate the vector associated with provided key.
std::map< Key, int > indices_trial_
void objectiveUpdate(bool flag=true)
Objective function update for VectorController storage.
std::vector< Ptr< Vector< Real > > > vectors_trial_
std::vector< Ptr< Vector< Real > > > vectors_temp_
std::vector< bool > flags_temp_
std::vector< bool > flags_trial_
bool isNull(const Key &param) const
Check if vector associated with provided key is allocated.
std::vector< Ptr< Vector< Real > > > vectors_