ROL
ROL_SampledVector.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_SAMPLEDVECTOR_H
46#define ROL_SAMPLEDVECTOR_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<ROL::Ptr<Vector<Real>>> vectors_;
58
59 // Update flags
61
62 void reset(const bool flag = true) {
63 if ( flag ) {
64 flags_.assign(flags_.size(),false);
65// typename std::map<Key, int>::iterator it;
66// for (it = indices_.begin(); it != indices_.end(); ++it) {
67// flags_[it->second] = false;
68// }
69 }
70 }
71
72public:
76 : maxIndex_(0), updated_(false) {
77 indices_.clear();
78 flags_.clear();
79 vectors_.clear();
80 }
81
84 void update(const bool flag = true) {
85 updated_ = flag;
86 reset(flag);
87 }
88
91 bool get(Vector<Real> &x, const Key &param) {
92 int count = indices_.count(param);
93 bool flag = false;
94 int index = maxIndex_;
95 if (count) {
96 typename std::map<Key, int>::iterator it = indices_.find(param);
97 index = it->second;
98 flag = flags_[index];
99 if (flag) {
100 x.set(*vectors_[index]);
101 }
102 }
103 else {
104 indices_.insert(std::pair<Key, int>(param, index));
105 flags_.push_back(false);
106 vectors_.push_back(x.clone());
107 maxIndex_++;
108 }
109 return flag;
110 }
111
114 void set(const Vector<Real> &x, const Key &param) {
115 int count = indices_.count(param);
116 int index = maxIndex_;
117 if (count) {
118 typename std::map<Key, int>::iterator it = indices_.find(param);
119 index = it->second;
120 flags_[index] = true;
121 vectors_[index]->set(x);
122 }
123 else {
124 indices_.insert(std::pair<Key, int>(param, index));
125 flags_.push_back(true);
126 vectors_.push_back(x.clone());
127 vectors_[index]->set(x);
128 maxIndex_++;
129 }
130 }
131}; // class SampledVector
132
133} // namespace ROL
134
135#endif
void update(const bool flag=true)
Update for SampledVector storage.
SampledVector(void)
Constructor.
std::map< Key, int > indices_
void set(const Vector< Real > &x, const Key &param)
Set vector corresponding to input parameter.
std::vector< ROL::Ptr< Vector< Real > > > vectors_
bool get(Vector< Real > &x, const Key &param)
Return vector corresponding to input parameter.
std::vector< bool > flags_
void reset(const bool flag=true)
Defines the linear algebra or vector space interface.
virtual void set(const Vector &x)
Set where .
virtual ROL::Ptr< Vector > clone() const =0
Clone to make a new (uninitialized) vector.