MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
AbstractLinAlgPack_apply_op_helper.hpp
Go to the documentation of this file.
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
6 // Copyright (2003) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 */
43 
44 // //////////////////////////////////////////////////////////////////////////////
45 // AbstractLinAlgPack_apply_op_helper.hpp
46 
47 #ifndef APPLY_OP_HELPER_H
48 #define APPLY_OP_HELPER_H
49 
51 #include "RTOpPack_RTOpT.hpp"
52 
53 namespace AbstractLinAlgPack {
54 
62  const char func_name[]
63  ,const RTOpPack::RTOp& op
64  ,const size_t num_vecs, const Vector* vecs[]
65  ,const size_t num_targ_vecs, VectorMutable* targ_vecs[]
66  ,RTOpPack::ReductTarget *reduct_obj
67  ,const index_type first_ele, const index_type sub_dim, const index_type global_offset
68  );
69 
78 void apply_op_serial(
79  const RTOpPack::RTOp& op
80  ,const size_t num_vecs, const Vector* vecs[]
81  ,const size_t num_targ_vecs, VectorMutable* targ_vecs[]
82  ,RTOpPack::ReductTarget *reduct_obj
83  ,const index_type first_ele, const index_type sub_dim, const index_type global_offset
84  );
85 
86 } // end namespace AbstractLinAlgPack
87 
88 #endif // APPLY_OP_HELPER_H
Abstract interface for immutable, finite dimensional, coordinate vectors {abstract}.
void apply_op_serial(const RTOpPack::RTOp &op, const size_t num_vecs, const Vector *vecs[], const size_t num_targ_vecs, VectorMutable *targ_vecs[], RTOpPack::ReductTarget *reduct_obj, const index_type first_ele, const index_type sub_dim, const index_type global_offset)
Implements reduction/transformation operators for any serial vectors using just the public vector int...
RTOpT< RTOp_value_type > RTOp
Abstract interface for mutable coordinate vectors {abstract}.
void apply_op_validate_input(const char func_name[], const RTOpPack::RTOp &op, const size_t num_vecs, const Vector *vecs[], const size_t num_targ_vecs, VectorMutable *targ_vecs[], RTOpPack::ReductTarget *reduct_obj, const index_type first_ele, const index_type sub_dim, const index_type global_offset)
Validate the inputs to apply_op().