ROL
ROL_SampleGenerator.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 #ifndef ROL_SAMPLEGENERATOR_HPP
45 #define ROL_SAMPLEGENERATOR_HPP
46 
47 #include "Teuchos_RefCountPtr.hpp"
48 #include "ROL_BatchManager.hpp"
49 #include "ROL_Vector.hpp"
50 
51 namespace ROL {
52 
53 template<class Real>
55 private:
56  int begin_;
57  Teuchos::RCP<BatchManager<Real> > bman_;
58  std::vector<std::vector<Real> > points_;
59  std::vector<Real> weights_;
60 
61 protected:
62  void setPoints(std::vector<std::vector<Real> > &p) {
63  points_.clear();
64  points_.insert(points_.begin(),p.begin(),p.end());
65  }
66  void setWeights(std::vector<Real> &w) {
67  weights_.clear();
68  weights_.insert(weights_.begin(),w.begin(),w.end());
69  }
70 
71 public:
72  virtual ~SampleGenerator() {}
73  SampleGenerator(Teuchos::RCP<BatchManager<Real> > &bman) : begin_(0), bman_(bman) {}
75  : begin_(sampler.begin_), bman_(sampler.bman_), points_(sampler.points_), weights_(sampler.weights_) {}
76 
77  virtual void update(const Vector<Real> &x) {
78  begin_ = 0;
79  }
80 
81  virtual int start(void) {
82  return begin_;
83  }
84 
85  virtual Real computeError(std::vector<Real> &vals) {
86  return 0.0;
87  }
88 
89  virtual Real computeError(std::vector<Teuchos::RCP<Vector<Real> > > &vals, const Vector<Real> &x) {
90  return 0.0;
91  }
92 
93  virtual void refine(void) {
94  begin_ = numMySamples();
95  }
96 
97  virtual void setSamples(bool inConstructor = false) {}
98 
99  virtual int numMySamples(void) const {
100  return weights_.size();
101  }
102 
103  virtual std::vector<Real> getMyPoint(const int i) const {
104  return points_[i];
105  }
106 
107  virtual Real getMyWeight(const int i) const {
108  return weights_[i];
109  }
110 
111  int batchID(void) const {
112  return bman_->batchID();
113  }
114 
115  int numBatches(void) const {
116  return bman_->numBatches();
117  }
118 
119  void sumAll(Real *input, Real *output, int dim) const {
120  bman_->sumAll(input, output, dim);
121  }
122 
123  void sumAll(Vector<Real> &input, Vector<Real> &output) const {
124  bman_->sumAll(input,output);
125  }
126 
127  void barrier(void) const {
128  bman_->barrier();
129  }
130 };
131 
132 }
133 
134 #endif
void sumAll(Vector< Real > &input, Vector< Real > &output) const
virtual void update(const Vector< Real > &x)
Teuchos::RCP< BatchManager< Real > > bman_
SampleGenerator(Teuchos::RCP< BatchManager< Real > > &bman)
virtual void setSamples(bool inConstructor=false)
virtual std::vector< Real > getMyPoint(const int i) const
virtual Real getMyWeight(const int i) const
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:72
virtual int numMySamples(void) const
void sumAll(Real *input, Real *output, int dim) const
virtual void refine(void)
std::vector< Real > weights_
SampleGenerator(const SampleGenerator< Real > &sampler)
std::vector< std::vector< Real > > points_
virtual Real computeError(std::vector< Teuchos::RCP< Vector< Real > > > &vals, const Vector< Real > &x)
virtual Real computeError(std::vector< Real > &vals)
void setPoints(std::vector< std::vector< Real > > &p)
void setWeights(std::vector< Real > &w)