MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RTOp_ROp_max_rel_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 #include <math.h>
45 
46 /* */
47 /* Note: This file was created automatically by 'new_rtop.pl' */
48 /* on 6/24/2002 at 21:2 */
49 /* */
50 
51 #define max(a,b) ( (a) > (b) ? (a) : (b) )
52 #define min(a,b) ( (a) < (b) ? (a) : (b) )
53 
54 #include "RTOp_ROp_max_rel_step.h"
55 #include "RTOp_obj_null_vtbl.h" /* vtbl for operator object instance data */
56 #include "RTOp_reduct_max_value.h"
57 
58 /* Implementation functions for RTOp_RTOp */
59 
61  const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
62  , const int num_vecs, const struct RTOp_SubVector vecs[]
63  , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
64  , RTOp_ReductTarget reduct_obj )
65 {
66  /* */
67  /* Declare local variables */
68  /* */
69 
70  /* Access to the reduction object data */
71  RTOp_value_type *gamma = (RTOp_value_type*)reduct_obj;
72  /* Vector data */
73  RTOp_index_type sub_dim;
74  /* v0 */
75  const RTOp_value_type *v0_val;
76  ptrdiff_t v0_val_s;
77  /* v1 */
78  const RTOp_value_type *v1_val;
79  ptrdiff_t v1_val_s;
80 
81  register RTOp_index_type k;
82  register RTOp_value_type gamma_i;
83 
84  /* */
85  /* Validate the input */
86  /* */
87  if( num_vecs != 2 || ( num_vecs && vecs == NULL ) )
89  if( num_targ_vecs != 0 || ( num_targ_vecs && targ_vecs == NULL ) )
91  if( /* Validate sub_dim */
92  vecs[1].sub_dim != vecs[0].sub_dim
93  )
95  assert(reduct_obj);
96 
97  /* */
98  /* Get pointers to data */
99  /* */
100  sub_dim = vecs[0].sub_dim;
101  /* v0 */
102  v0_val = vecs[0].values;
103  v0_val_s = vecs[0].values_stride;
104  /* v1 */
105  v1_val = vecs[1].values;
106  v1_val_s = vecs[1].values_stride;
107 
108  /* */
109  /* Apply the operator: */
110  /* */
111  /* element-wise reduction : gamma = max( gamma, fabs(v1) / ( 1.0 + fabs(v0) ) ); */
112  /* */
113  for( k = 0; k < sub_dim; ++k, v0_val += v0_val_s, v1_val += v1_val_s )
114  {
115  /* Element-wise reduction */
116  gamma_i = fabs((*v1_val)) / ( 1.0 + fabs((*v0_val)) );
117  (*gamma) = max( (*gamma), gamma_i );
118  }
119 
120  return 0; /* success? */
121 }
122 
123 /* Virtual function table */
125 {
128  ,"ROp_max_rel_step"
129  ,NULL
133 };
134 
135 /* Class specific functions */
136 
138 {
139 #ifdef RTOp_DEBUG
140  assert(op);
141 #endif
142  op->obj_data = NULL;
144  op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
145  return 0;
146 }
147 
149 {
150  op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
151  op->obj_data = NULL;
152  op->vtbl = NULL;
153  return 0;
154 }
155 
157 {
158  return *((RTOp_value_type*)reduct_obj);
159 }
160 
ptrdiff_t values_stride
Definition: RTOp.h:305
double RTOp_value_type
Definition: RTOp.h:69
void * RTOp_ReductTarget
Definition: RTOp.h:191
const struct RTOp_RTOp_vtbl_t RTOp_ROp_max_rel_step_vtbl
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
#define RTOp_ERR_INCOMPATIBLE_VECS
Definition: RTOp.h:270
const RTOp_value_type * values
Definition: RTOp.h:303
int RTOp_get_reduct_max_value_op(const struct RTOp_RTOp_vtbl_t *vtbl, const void *obj_data, RTOp_reduct_op_func_ptr_t *reduct_op_func_ptr)
#define RTOp_ERR_INVALID_NUM_VECS
Definition: RTOp.h:266
int(* obj_free)(const struct RTOp_obj_type_vtbl_t *vtbl, const void *instance_data, void **obj)
Definition: RTOp.h:1019
const struct RTOp_obj_type_vtbl_t RTOp_obj_null_vtbl
int RTOp_ROp_max_rel_step_construct(struct RTOp_RTOp *op)
void * obj_data
Definition: RTOp.h:800
int RTOp_ROp_max_rel_step_destroy(struct RTOp_RTOp *op)
const struct RTOp_RTOp_vtbl_t * vtbl
Definition: RTOp.h:802
int RTOp_reduct_max_value(const struct RTOp_RTOp_vtbl_t *vtbl, const void *obj_data, RTOp_ReductTarget in_targ_obj, RTOp_ReductTarget inout_targ_obj)
static int RTOp_ROp_max_rel_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)
RTOp_value_type RTOp_ROp_max_rel_step_val(RTOp_ReductTarget reduct_obj)
#define max(a, b)
RTOp_index_type sub_dim
Definition: RTOp.h:301
#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