MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RTOp_TOp_ele_wise_prod.c
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 #include "RTOp_TOp_ele_wise_prod.h"
45 #include "RTOp_obj_null_vtbl.h"
46 #include "RTOp_obj_value_vtbl.h"
47 
48 /* Implementation functions for RTOp_RTOp */
49 
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 sub_dim;
58  RTOp_value_type *z_val;
59  ptrdiff_t z_val_s;
60  const RTOp_value_type *v0_val;
61  ptrdiff_t v0_val_s;
62  const RTOp_value_type *v1_val;
63  ptrdiff_t v1_val_s;
64  register RTOp_index_type k;
65 
66  /* */
67  /* Validate the input */
68  /* */
69  if( num_vecs != 2 || vecs == NULL )
71  if( num_targ_vecs != 1 || targ_vecs == NULL )
73  if( targ_vecs[0].sub_dim != vecs[0].sub_dim
74  || targ_vecs[0].sub_dim != vecs[1].sub_dim )
76  assert(obj_data);
77 
78 
79  /* */
80  /* Get pointers to data */
81  /* */
82 
83  /* alpha */
84  alpha = *(RTOp_value_type*)obj_data;
85  /* z */
86  sub_dim = targ_vecs[0].sub_dim;
87  z_val = targ_vecs[0].values;
88  z_val_s = targ_vecs[0].values_stride;
89  /* v0 */
90  v0_val = vecs[0].values;
91  v0_val_s = vecs[0].values_stride;
92  /* v1 */
93  v1_val = vecs[1].values;
94  v1_val_s = vecs[1].values_stride;
95 
96  /* */
97  /* Element-wise product */
98  /* */
99 
100  if( z_val_s == 1 && v0_val_s == 1 && v1_val_s == 1 ) {
101  /* Slightly faster loop for unit stride vectors */
102  for( k = 0; k < sub_dim; ++k )
103  *z_val++ += alpha*(*v0_val++)*(*v1_val++);
104  }
105  else {
106  /* More general implementation for non-unit strides */
107  for( k = 0; k < sub_dim; ++k, z_val+=z_val_s, v0_val+=v0_val_s, v1_val+=v1_val_s )
108  *z_val += alpha*(*v0_val)*(*v1_val);
109  }
110 
111  return 0; /* success? */
112 }
113 
114 /* Virtual function table */
116 {
117  &RTOp_obj_value_vtbl /* alpha */
118  ,&RTOp_obj_null_vtbl /* use null type for target object */
119  ,"TOp_ele_wise_prod"
120  ,NULL /* use default from reduct_vtbl */
122  ,NULL
123  ,NULL
124 };
125 
126 /* Class specific functions */
127 
129 {
130 #ifdef RTOp_DEBUG
131  assert(op);
132 #endif
133  op->obj_data = NULL;
135  op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
136  return RTOp_TOp_ele_wise_prod_set_alpha(alpha,op);
137 }
138 
140 {
141 #ifdef RTOp_DEBUG
142  assert(op);
143  assert(op->obj_data);
144 #endif
145  *(RTOp_value_type*)op->obj_data = alpha;
146  return 0;
147 }
148 
150 {
151  op->obj_data = NULL;
152  op->vtbl = NULL;
153  return 0; /* success? */
154 }
ptrdiff_t values_stride
Definition: RTOp.h:305
double RTOp_value_type
Definition: RTOp.h:69
ptrdiff_t values_stride
Definition: RTOp.h:338
void * RTOp_ReductTarget
Definition: RTOp.h:191
int(* obj_create)(const struct RTOp_obj_type_vtbl_t *vtbl, const void *instance_data, void **obj)
Definition: RTOp.h:941
const struct RTOp_obj_type_vtbl_t * obj_data_vtbl
Definition: RTOp.h:819
int RTOp_TOp_ele_wise_prod_construct(RTOp_value_type alpha, struct RTOp_RTOp *op)
#define RTOp_ERR_INCOMPATIBLE_VECS
Definition: RTOp.h:270
const RTOp_value_type * values
Definition: RTOp.h:303
const struct RTOp_RTOp_vtbl_t RTOp_TOp_ele_wise_prod_vtbl
RTOp_index_type sub_dim
Definition: RTOp.h:334
#define RTOp_ERR_INVALID_NUM_VECS
Definition: RTOp.h:266
RTOp_value_type * values
Definition: RTOp.h:336
const struct RTOp_obj_type_vtbl_t RTOp_obj_null_vtbl
int RTOp_TOp_ele_wise_prod_destroy(struct RTOp_RTOp *op)
int RTOp_TOp_ele_wise_prod_set_alpha(RTOp_value_type alpha, struct RTOp_RTOp *op)
void * obj_data
Definition: RTOp.h:800
const struct RTOp_RTOp_vtbl_t * vtbl
Definition: RTOp.h:802
static int RTOp_TOp_ele_wise_prod_apply_op(const struct RTOp_RTOp_vtbl_t *vtbl, const void *obj_data, const int num_vecs, const struct RTOp_SubVector vecs[], const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[], RTOp_ReductTarget targ_obj)
#define RTOp_ERR_INVALID_NUM_TARG_VECS
Definition: RTOp.h:268
const struct RTOp_obj_type_vtbl_t RTOp_obj_value_vtbl
Teuchos_Ordinal RTOp_index_type
Definition: RTOp.h:68