RTOp Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
RTOpPack_TOpUnaryFuncPtr.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// RTOp: Interfaces and Support Software for Vector Reduction Transformation
5// Operations
6// Copyright (2006) 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#ifndef RTOPPACK_UNARY_FUNC_PTR_HPP
44#define RTOPPACK_UNARY_FUNC_PTR_HPP
45
47
48namespace RTOpPack {
49
50template<class Scalar>
52 :RTOpT<Scalar>("TOpUnaryFuncPtr")
53{
55}
56
57template<class Scalar>
59 unary_func_ptr_t unary_func_ptr
60 ,const std::string &op_name
61 )
62 :RTOpT<Scalar>("TOpUnaryFuncPtr")
63{
64 initialize(unary_func_ptr,op_name);
65}
66
67template<class Scalar>
69 unary_func_ptr_t unary_func_ptr
70 ,const std::string &op_name
71 )
72{
73 TEUCHOS_TEST_FOR_EXCEPTION( unary_func_ptr==NULL, std::invalid_argument, "Error!" );
74 unary_func_ptr_ = unary_func_ptr;
75 op_name_ = op_name;
76}
77
78template<class Scalar>
80 unary_func_ptr_t *unary_func_ptr
81 ,std::string *op_name
82 )
83{
84 if(unary_func_ptr) *unary_func_ptr = unary_func_ptr_;
85 if(op_name) *op_name = op_name_;
86
87 unary_func_ptr_ = NULL;
88 op_name_ = "uninitialized()";
89}
90
91// Overridden from RTOpT
92
93template<class Scalar>
95{
96 return op_name_.c_str();
97}
98
99template<class Scalar>
101 const int num_vecs, const ConstSubVectorView<Scalar> sub_vecs[]
102 ,const int num_targ_vecs, const SubVectorView<Scalar> targ_sub_vecs[]
103 ,ReductTarget *reduct_obj
104 ) const
105{
106 TEUCHOS_TEST_FOR_EXCEPTION( num_vecs != 1 || sub_vecs == NULL, std::invalid_argument, "Error!" );
107 TEUCHOS_TEST_FOR_EXCEPTION( num_targ_vecs != 1 || targ_sub_vecs == NULL, std::invalid_argument, "Error!" );
108 TEUCHOS_TEST_FOR_EXCEPTION( reduct_obj != NULL, std::invalid_argument, "Error!" );
109 TEUCHOS_TEST_FOR_EXCEPTION( sub_vecs[0].stride() != 1, std::invalid_argument, "Error, can't handle non-unit strides here!" );
110 TEUCHOS_TEST_FOR_EXCEPTION( targ_sub_vecs[0].stride() != 1, std::invalid_argument, "Error, can't handle non-unit strides here!" );
111 TEUCHOS_TEST_FOR_EXCEPTION( sub_vecs[0].subDim() != targ_sub_vecs[0].subDim(), std::invalid_argument, "Error!" );
112 TEUCHOS_TEST_FOR_EXCEPTION( sub_vecs[0].globalOffset() != targ_sub_vecs[0].globalOffset(), std::invalid_argument, "Error!" );
113
114 unary_func_ptr_( sub_vecs[0].values(), sub_vecs[0].subDim(), targ_sub_vecs[0].values() );
115
116}
117
118} // end namespace RTOpPack
119
120#endif // RTOPPACK_UNARY_FUNC_PTR_HPP
Templated interface to vector reduction/transformation operators {abstract}.
Abstract base class for all reduction objects.
RTOpT subclass for unary transformation functions using a function pointer.
TOpUnaryFuncPtr()
Construct to uninitialized.
void set_initialized(unary_func_ptr_t *unary_func_ptr=NULL, std::string *op_name=NULL)
Set uninitialized.
void initialize(unary_func_ptr_t unary_func_ptr, const std::string &op_name)
Initialize.