ROL
ROL_BatchManager.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_BATCHMANAGER_HPP
45#define ROL_BATCHMANAGER_HPP
46
47#include "ROL_Vector.hpp"
48#include "ROL_Elementwise_Function.hpp"
49
50namespace ROL {
51
52template<class Real>
54public:
55 virtual ~BatchManager() {}
56
57 virtual int batchID() {
58 return 0;
59 }
60
61 virtual int numBatches() {
62 return 1;
63 }
64
65 virtual void sumAll(Real* input, Real* output, int dim) {
66 for (int i=0; i<dim; ++i) output[i] = input[i];
67 }
68
69 virtual void sumAll(Vector<Real> &input, Vector<Real> &output) {
70 output.set(input);
71 }
72
73 virtual void reduceAll(Real *input, Real* output, int dim,
74 const Elementwise::ReductionOp<Real> &r) {
75 for (int i = 0; i < dim; ++i) output[i] = input[i];
76 }
77
78 virtual void gatherAll(const Real *send, const int ssize, Real *receive, int const rsize) const {
79 for (int i = 0; i < rsize; ++i) receive[i] = send[i];
80 }
81
82 virtual void broadcast(Real *input, int cnt, int root) {}
83
84 virtual void barrier() {}
85};
86
87}
88
89#endif
virtual void sumAll(Real *input, Real *output, int dim)
virtual void sumAll(Vector< Real > &input, Vector< Real > &output)
virtual void broadcast(Real *input, int cnt, int root)
virtual void barrier()
virtual void reduceAll(Real *input, Real *output, int dim, const Elementwise::ReductionOp< Real > &r)
virtual int numBatches()
virtual void gatherAll(const Real *send, const int ssize, Real *receive, int const rsize) const
Defines the linear algebra or vector space interface.
virtual void set(const Vector &x)
Set where .
constexpr auto dim