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