RTOpPack: Extra C/C++ Code for Vector Reduction/Transformation Operators  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
RTOp_ROp_sum.c
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 #include "RTOp_ROp_sum.h"
45 #include "RTOp_obj_null_vtbl.h"
46 #include "RTOp_obj_value_vtbl.h"
47 #include "RTOp_reduct_sum_value.h"
48 
49 /* Implementation functions */
50 
51 static int RTOp_ROp_sum_apply_op(
52  const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
53  , const int num_vecs, const struct RTOp_SubVector vecs[]
54  , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
55  , RTOp_ReductTarget targ_obj )
56 {
57  RTOp_index_type v0_sub_dim;
58  const RTOp_value_type *v0_val;
59  ptrdiff_t v0_val_s;
60  register RTOp_index_type k;
61  RTOp_value_type sum = 0.0;
62 
63  /* */
64  /* Validate the input */
65  /* */
66  if( num_vecs != 1 )
67  return RTOp_ERR_INVALID_NUM_VECS;
68  if( num_targ_vecs != 0 )
69  return RTOp_ERR_INVALID_NUM_TARG_VECS;
70 
71  /* */
72  /* Get pointers to data */
73  /* */
74 
75  /* v0 */
76  v0_sub_dim = vecs[0].sub_dim;
77  v0_val = vecs[0].values;
78  v0_val_s = vecs[0].values_stride;
79 
80  /* */
81  /* Sum the vector elements! */
82  /* */
83 
84  for( k = 0; k < v0_sub_dim; ++k, v0_val += v0_val_s )
85  sum += *v0_val;
86 
87  /* */
88  /* Add this to the result */
89  /* */
90  *((RTOp_value_type*)targ_obj) += sum;
91 
92  return 0; /* success? */
93 }
94 
95 /* Virtual function table */
96 const struct RTOp_RTOp_vtbl_t RTOp_ROp_sum_vtbl =
97 {
98  &RTOp_obj_null_vtbl /* use null type for instance data */
99  ,&RTOp_obj_value_vtbl /* use simple scalar type for target object */
100  ,"ROp_sum"
101  ,NULL
102  ,RTOp_ROp_sum_apply_op
103  ,RTOp_reduct_sum_value
104  ,RTOp_get_reduct_sum_value_op
105 };
106 
107 /* Class specific functions */
108 
109 int RTOp_ROp_sum_construct( struct RTOp_RTOp* op )
110 {
111  op->obj_data = NULL;
112  op->vtbl = &RTOp_ROp_sum_vtbl;
113  return 0;
114 }
115 
116 int RTOp_ROp_sum_destroy( struct RTOp_RTOp* op )
117 {
118  op->obj_data = NULL;
119  op->vtbl = NULL;
120  return 0;
121 }
122 
123 RTOp_value_type RTOp_ROp_sum_val(RTOp_ReductTarget targ_obj)
124 {
125  return *((RTOp_value_type*)targ_obj);
126 }