ROL
ROL_BatchStdVector.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_BATCHSTDVECTOR_H
45#define ROL_BATCHSTDVECTOR_H
46
47#include "ROL_StdVector.hpp"
48#include "ROL_BatchManager.hpp"
49
55namespace ROL {
56
57template <class Real>
58class BatchStdVector : public StdVector<Real> {
59 typedef typename std::vector<Real>::size_type uint;
60private:
61 const Ptr<BatchManager<Real>> bman_;
62
63public:
64 BatchStdVector(const Ptr<std::vector<Real>> &vec,
65 const Ptr<BatchManager<Real>> &bman)
66 : StdVector<Real>(vec), bman_(bman) {}
67
68 virtual Real dot(const Vector<Real> &x) const {
69 const std::vector<Real> &xval = *(dynamic_cast<const StdVector<Real>&>(x).getVector());
70 const std::vector<Real> &yval = *(StdVector<Real>::getVector());
71 uint numMySamples = yval.size();
72 ROL_TEST_FOR_EXCEPTION( xval.size() != numMySamples, std::invalid_argument,
73 "Error: Vectors must have the same dimension." );
74 Real val(0), sum_val(0);
75 for (uint i = 0; i < numMySamples; ++i) {
76 val += xval[i] * yval[i];
77 }
78 // Global sum
79 bman_->sumAll(&val,&sum_val,1);
80 return sum_val;
81 }
82
83 virtual Ptr<Vector<Real>> clone(void) const {
84 const std::vector<Real> &yval = *(StdVector<Real>::getVector());
85 uint numMySamples = yval.size();
86 return makePtr<BatchStdVector>(
87 makePtr<std::vector<Real>>(numMySamples),bman_);
88 }
89
90 int dimension(void) const {
91 Real dim = (Real)StdVector<Real>::dimension();
92 Real sum = 0.;
93 bman_->sumAll(&dim,&sum,1);
94 return (int)sum;
95 }
96
97 Real reduce(const Elementwise::ReductionOp<Real> &r) const {
98 const std::vector<Real> &yval = *(StdVector<Real>::getVector());
99 uint numMySamples = yval.size();
100 Real result = r.initialValue();
101 for (uint i = 0; i < numMySamples; i++) {
102 r.reduce(yval[i],result);
103 }
104 // Global sum
105 Real sum = 0.;
106 bman_->reduceAll(&result,&sum,1,r);
107 return sum;
108 }
109
110 const Ptr<BatchManager<Real>> getBatchManager(void) const {
111 return bman_;
112 }
113};
114
115} // namespace ROL
116
117#endif
Provides the std::vector implementation of the ROL::Vector interface.
virtual Real dot(const Vector< Real > &x) const
Compute where .
virtual Ptr< Vector< Real > > clone(void) const
Clone to make a new (uninitialized) vector.
int dimension(void) const
Return dimension of the vector space.
std::vector< Real >::size_type uint
const Ptr< BatchManager< Real > > bman_
Real reduce(const Elementwise::ReductionOp< Real > &r) const
const Ptr< BatchManager< Real > > getBatchManager(void) const
BatchStdVector(const Ptr< std::vector< Real > > &vec, const Ptr< BatchManager< Real > > &bman)
Provides the ROL::Vector interface for scalar values, to be used, for example, with scalar constraint...
Ptr< const std::vector< Element > > getVector() const
Defines the linear algebra or vector space interface.
constexpr auto dim