RTOp Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
RTOpPack_TOpUnaryFuncPtrDecl.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_DECL_HPP
44#define RTOPPACK_UNARY_FUNC_PTR_DECL_HPP
45
46#include "RTOpPack_RTOpT.hpp"
47
48namespace RTOpPack {
49
57template<class Scalar>
58class TOpUnaryFuncPtr : public RTOpT<Scalar> {
59public:
60
62 typedef void (*unary_func_ptr_t) ( const Scalar x[], int x_dim, Scalar out[] );
63
66
69 unary_func_ptr_t unary_func_ptr
70 ,const std::string &op_name
71 );
72
84 void initialize(
85 unary_func_ptr_t unary_func_ptr
86 ,const std::string &op_name
87 );
88
98 void set_initialized(
99 unary_func_ptr_t *unary_func_ptr = NULL
100 ,std::string *op_name = NULL
101 );
102
105
107 const char* op_name() const;
109 void apply_op(
110 const int num_vecs, const ConstSubVectorView<Scalar> sub_vecs[]
111 ,const int num_targ_vecs, const SubVectorView<Scalar> targ_sub_vecs[]
112 ,ReductTarget *reduct_obj
113 ) const;
114
116
117private:
118
119 std::string op_name_;
121
122 // Not defined and not to be called
125
126};
127
128} // end namespace RTOpPack
129
130#endif // RTOPPACK_UNARY_FUNC_PTR_DECL_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(* unary_func_ptr_t)(const Scalar x[], int x_dim, Scalar out[])
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.
TOpUnaryFuncPtr(const TOpUnaryFuncPtr &)
void apply_op(const int num_vecs, const ConstSubVectorView< Scalar > sub_vecs[], const int num_targ_vecs, const SubVectorView< Scalar > targ_sub_vecs[], ReductTarget *reduct_obj) const
TOpUnaryFuncPtr & operator=(const TOpUnaryFuncPtr &)