ROL
ROL_SampledScalar.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_SAMPLEDSCALAR_H
46#define ROL_SAMPLEDSCALAR_H
47
48namespace ROL {
49
50template <class Real, class Key=std::vector<Real>>
52private:
53 // Storage
54 std::map<Key, int> indices_;
55 std::vector<bool> flags_;
56 std::vector<Real> scalars_;
58
59 // Update flags
61
62 void reset(const bool flag = true) {
63 if ( flag ) {
64 typename std::map<Key, int>::iterator it;
65 for (it = indices_.begin(); it != indices_.end(); ++it) {
66 flags_[it->second] = false;
67 }
68 }
69 }
70
71public:
75 : maxIndex_(0), updated_(false) {
76 indices_.clear();
77 flags_.clear();
78 scalars_.clear();
79 }
80
83 void update(const bool flag = true) {
84 updated_ = flag;
85 reset(flag);
86 }
87
90 bool get(Real &x, const Key &param) {
91 int count = indices_.count(param);
92 bool flag = false;
93 int index = maxIndex_;
94 if (count) {
95 typename std::map<Key, int>::iterator it = indices_.find(param);
96 index = it->second;
97 flag = flags_[index];
98 if (flag) {
99 x = scalars_[index];
100 }
101 }
102 else {
103 indices_.insert(std::pair<Key, int>(param, index));
104 flags_.push_back(false);
105 scalars_.push_back(static_cast<Real>(0));
106 maxIndex_++;
107 }
108 return flag;
109 }
110
113 void set(const Real &x, const Key &param) {
114 int count = indices_.count(param);
115 int index = maxIndex_;
116 if (count) {
117 typename std::map<Key, int>::iterator it = indices_.find(param);
118 index = it->second;
119 flags_[index] = true;
120 scalars_[index] = x;
121 }
122 else {
123 indices_.insert(std::pair<Key, int>(param, index));
124 flags_.push_back(true);
125 scalars_.push_back(x);
126 maxIndex_++;
127 }
128 }
129}; // class SampledScalar
130
131} // namespace ROL
132
133#endif
std::vector< bool > flags_
void reset(const bool flag=true)
std::vector< Real > scalars_
SampledScalar(void)
Constructor.
std::map< Key, int > indices_
bool get(Real &x, const Key &param)
Return vector corresponding to input parameter.
void set(const Real &x, const Key &param)
Set vector corresponding to input parameter.
void update(const bool flag=true)
Update for SampledScalar storage.