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_TOp_axpy.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_TOp_axpy.h"
45 #include "RTOp_obj_value_vtbl.h"
46 #include "RTOp_obj_null_vtbl.h"
47 
48 /* Implementation functions for RTOp_RTOp */
49 
50 static int RTOp_TOp_axpy_apply_op(
51  const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
52  , const int num_vecs, const struct RTOp_SubVector vecs[]
53  , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
54  , RTOp_ReductTarget targ_obj )
55 {
56  RTOp_value_type alpha;
57  RTOp_index_type z_sub_dim;
58  RTOp_value_type *z_val;
59  ptrdiff_t z_val_s;
60  RTOp_index_type v0_sub_dim;
61  const RTOp_value_type *v0_val;
62  ptrdiff_t v0_val_s;
63  register RTOp_index_type k;
64  RTOp_value_type *z_val_tmp = NULL;
65 #ifdef RTOp_DEBUG
66  RTOp_index_type i;
67 #endif
68 
69  /* */
70  /* Validate the input */
71  /* */
72  if( num_vecs != 1 || vecs == NULL )
73  return RTOp_ERR_INVALID_NUM_VECS;
74  if( num_targ_vecs != 1 || targ_vecs == NULL )
75  return RTOp_ERR_INVALID_NUM_TARG_VECS;
76  if( targ_vecs[0].sub_dim != vecs[0].sub_dim )
77  return RTOp_ERR_INCOMPATIBLE_VECS;
78 
79  /* */
80  /* Get pointers to data */
81  /* */
82 
83  /* alpha */
84  alpha = *((RTOp_value_type*)obj_data);
85 
86  /* z */
87  z_sub_dim = targ_vecs[0].sub_dim;
88  z_val = targ_vecs[0].values;
89  z_val_s = targ_vecs[0].values_stride;
90 
91  /* v1 */
92  v0_sub_dim = vecs[0].sub_dim;
93  v0_val = vecs[0].values;
94  v0_val_s = vecs[0].values_stride;
95 
96  z_val_tmp = z_val;
97 
98  /* */
99  /* Perform the operation */
100  /* */
101 
102  /* Dense vector v[0] */
103  if( z_val_s == 1 && v0_val_s == 1 ) {
104  /* Slightly faster loop for unit stride vectors */
105  for( k = 0; k < z_sub_dim; ++k )
106  *z_val++ += alpha * (*v0_val++);
107  }
108  else {
109  /* More general implementation for one or both non-unit strides */
110  for( k = 0; k < z_sub_dim; ++k, z_val += z_val_s, v0_val += v0_val_s )
111  *z_val += alpha * (*v0_val);
112  }
113 
114  return 0; /* success? */
115 }
116 
117 /* Virtual function table */
118 const struct RTOp_RTOp_vtbl_t RTOp_TOp_axpy_vtbl =
119 {
120  &RTOp_obj_value_vtbl /* use simple scalar value type for object instance data */
121  ,&RTOp_obj_null_vtbl /* use null type for target object */
122  ,"TOp_axpy"
123  ,NULL /* use default from reduct_vtbl */
124  ,RTOp_TOp_axpy_apply_op
125  ,NULL
126  ,NULL
127 };
128 
129 /* Class specific functions */
130 
131 int RTOp_TOp_axpy_construct( RTOp_value_type alpha, struct RTOp_RTOp* op )
132 {
133  op->vtbl = &RTOp_TOp_axpy_vtbl;
134  op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
135  *((RTOp_value_type*)op->obj_data) = alpha;
136  return 0; /* success? */
137 }
138 
139 int RTOp_TOp_axpy_destroy( struct RTOp_RTOp* op )
140 {
141  op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
142  op->vtbl = NULL;
143  return 0; /* success? */
144 }
145 
146 int RTOp_TOp_axpy_set_alpha( RTOp_value_type alpha, struct RTOp_RTOp* op )
147 {
148  *((RTOp_value_type*)op->obj_data) = alpha;
149  return 0; /* success? */
150 }
int(* obj_create)(const struct RTOp_obj_type_vtbl_t *vtbl, const void *instance_data, void **obj)
Definition: RTOp.h:941
int(* obj_free)(const struct RTOp_obj_type_vtbl_t *vtbl, const void *instance_data, void **obj)
Definition: RTOp.h:1019