MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RTOp_TOp_multiplier_step.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 /* ///////////////////////////////////////////// */
45 /* RTOp_TOp_multiplier_step.c */
46 
47 /* */
48 /* Note: This file was created automatically by 'new_rtop.pl' */
49 /* on 7/10/2002 at 1:19 */
50 /* */
51 
52 #define max(a,b) ( (a) > (b) ? (a) : (b) )
53 #define min(a,b) ( (a) < (b) ? (a) : (b) )
54 
56 #include "RTOp_obj_value_value_vtbl.h" /* vtbl for operator object instance data */
57 
58 
59 
60 /* Implementation functions for RTOp_RTOp */
61 
63  const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
64  , const int num_vecs, const struct RTOp_SubVector vecs[]
65  , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
66  , RTOp_ReductTarget reduct_obj )
67 {
68  /* */
69  /* Declare local variables */
70  /* */
71 
72  /* Access to the operator object instance data */
73  struct RTOp_value_value_type *data_cntr = (struct RTOp_value_value_type*)obj_data;
74  RTOp_value_type *mu = &data_cntr->value1;
75  RTOp_value_type *alpha = &data_cntr->value2;
76  /* Vector data */
77  RTOp_index_type sub_dim;
78  /* z0 */
79  RTOp_value_type *z0_val;
80  ptrdiff_t z0_val_s;
81  /* v0 */
82  const RTOp_value_type *v0_val;
83  ptrdiff_t v0_val_s;
84  /* v1 */
85  const RTOp_value_type *v1_val;
86  ptrdiff_t v1_val_s;
87  /* v2 */
88  const RTOp_value_type *v2_val;
89  ptrdiff_t v2_val_s;
90 
91  /* Automatic temporary variables */
92  register RTOp_index_type k;
93 
94  /* */
95  /* Validate the input */
96  /* */
97  if( num_vecs != 3 || ( num_vecs && vecs == NULL ) )
99  if( num_targ_vecs != 1 || ( num_targ_vecs && targ_vecs == NULL ) )
101  if( /* Validate sub_dim */
102  vecs[1].sub_dim != vecs[0].sub_dim
103  || vecs[2].sub_dim != vecs[0].sub_dim
104  || targ_vecs[0].sub_dim != vecs[0].sub_dim
105  )
107  assert(obj_data);
108 
109  /* */
110  /* Get pointers to data */
111  /* */
112  sub_dim = vecs[0].sub_dim;
113  /* z0 */
114  z0_val = targ_vecs[0].values;
115  z0_val_s = targ_vecs[0].values_stride;
116  /* v0 */
117  v0_val = vecs[0].values;
118  v0_val_s = vecs[0].values_stride;
119  /* v1 */
120  v1_val = vecs[1].values;
121  v1_val_s = vecs[1].values_stride;
122  /* v2 */
123  v2_val = vecs[2].values;
124  v2_val_s = vecs[2].values_stride;
125 
126  /* */
127  /* Apply the operator: */
128  /* */
129  for( k = 0; k < sub_dim; ++k, v0_val += v0_val_s, v1_val += v1_val_s, v2_val += v2_val_s, z0_val += z0_val_s )
130  {
131  /* Element-wise transformation */
132  (*z0_val) = -(*v1_val) + (*mu)*(*v0_val) + (*alpha)*(*v0_val)*(*v1_val)*(*v2_val);
133  }
134 
135  return 0; /* success? */
136 }
137 
138 /* Virtual function table */
140 {
143  ,"TOp_multiplier_step"
144  ,NULL
146  ,NULL
147  ,NULL
148 };
149 
150 /* Class specific functions */
151 
153 {
154 #ifdef RTOp_DEBUG
155  assert(op);
156 #endif
157  op->obj_data = NULL;
159  op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
160  return RTOp_TOp_multiplier_step_init(mu,alpha,op);
161 }
162 
164 {
165  op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
166  op->obj_data = NULL;
167  op->vtbl = NULL;
168  return 0;
169 }
170 
172 {
173  struct RTOp_value_value_type *ptr_data_cntr = (struct RTOp_value_value_type*)op->obj_data;
174  RTOp_value_type *ptr_mu = &ptr_data_cntr->value1;
175  RTOp_value_type *ptr_alpha = &ptr_data_cntr->value2;
176  *ptr_mu = mu;
177  *ptr_alpha = alpha;
178  return 0;
179 }
180 
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 RTOp_TOp_multiplier_step_init(RTOp_value_type mu, RTOp_value_type alpha, struct RTOp_RTOp *op)
static int RTOp_TOp_multiplier_step_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 reduct_obj)
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 RTOp_obj_value_value_vtbl
const struct RTOp_obj_type_vtbl_t * obj_data_vtbl
Definition: RTOp.h:819
int RTOp_TOp_multiplier_step_destroy(struct RTOp_RTOp *op)
#define RTOp_ERR_INCOMPATIBLE_VECS
Definition: RTOp.h:270
const RTOp_value_type * values
Definition: RTOp.h:303
#define RTOp_ERR_INVALID_NUM_VECS
Definition: RTOp.h:266
int RTOp_TOp_multiplier_step_construct(RTOp_value_type mu, RTOp_value_type alpha, struct RTOp_RTOp *op)
const struct RTOp_RTOp_vtbl_t RTOp_TOp_multiplier_step_vtbl
int(* obj_free)(const struct RTOp_obj_type_vtbl_t *vtbl, const void *instance_data, void **obj)
Definition: RTOp.h:1019
RTOp_value_type * values
Definition: RTOp.h:336
const struct RTOp_obj_type_vtbl_t RTOp_obj_null_vtbl
void * obj_data
Definition: RTOp.h:800
const struct RTOp_RTOp_vtbl_t * vtbl
Definition: RTOp.h:802
RTOp_index_type sub_dim
Definition: RTOp.h:301
#define RTOp_ERR_INVALID_NUM_TARG_VECS
Definition: RTOp.h:268
Teuchos_Ordinal RTOp_index_type
Definition: RTOp.h:68