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_max_step.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_max_step.h"
45 #include "RTOp_obj_value_vtbl.h"
46 #include "RTOp_obj_free_free.h"
47 #include "RTOp_get_reduct_op.hpp"
48 #include "RTOp_reduct_min_value.h"
49 
50 static int RTOp_ROp_max_step_reduct_obj_reinit(
51  const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
52  , RTOp_ReductTarget reduct_obj )
53 {
54  *((RTOp_value_type*)reduct_obj) = RTOp_ROp_max_step_inf;
55  return 0;
56 }
57 
58 static int ROp_max_step_apply_op(
59  const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
60  , const int num_vecs, const struct RTOp_SubVector vecs[]
61  , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
62  , RTOp_ReductTarget reduct_obj )
63 {
64  /* Declare locals */
65  const RTOp_value_type beta = *(RTOp_value_type*)obj_data;
66  RTOp_value_type *alpha = (RTOp_value_type*)reduct_obj;
67  RTOp_index_type sub_dim = 0;
68  const RTOp_value_type *v0_val = NULL, *v1_val = NULL;
69  ptrdiff_t v0_val_s = 0, v1_val_s = 0;
70  register RTOp_index_type k;
71  RTOp_value_type alpha_tmp;
72  /* Validate the input */
73  if( num_vecs != 2 ) return RTOp_ERR_INVALID_NUM_VECS;
74  if( num_targ_vecs != 0 ) return RTOp_ERR_INVALID_NUM_TARG_VECS;
75  if( vecs[0].sub_dim != vecs[1].sub_dim ) return RTOp_ERR_INCOMPATIBLE_VECS;
76  /* Get local variables to vector data */
77  sub_dim = vecs[0].sub_dim;
78  v0_val = vecs[0].values; v0_val_s = vecs[0].values_stride;
79  v1_val = vecs[1].values; v1_val_s = vecs[1].values_stride;
80  /* Perform the reduction operation: */
81  /* max alpha s.t. v[0] + alpha * v[1] >= beta */
82  for( k = 0; k < sub_dim; ++k, v0_val += v0_val_s, v1_val += v1_val_s ) {
83  alpha_tmp = (beta - (*v0_val))/(*v1_val);
84  *alpha = ( (0 <= alpha_tmp && alpha_tmp < *alpha) ? alpha_tmp : *alpha );
85  }
86  return 0; /* success! */
87 }
88 
89 /* Virtual function table */
90 const struct RTOp_RTOp_vtbl_t RTOp_ROp_max_step_vtbl =
91 {
92  &RTOp_obj_value_vtbl
93  ,&RTOp_obj_value_vtbl
94  ,"ROp_max_step"
95  ,RTOp_ROp_max_step_reduct_obj_reinit
96  ,ROp_max_step_apply_op
97  ,RTOp_reduct_min_value
98  ,RTOp_get_reduct_min_value_op
99 };
100 
101 /* Class specific functions */
102 
103 int RTOp_ROp_max_step_construct( RTOp_value_type beta, struct RTOp_RTOp* op )
104 {
105  op->vtbl = &RTOp_ROp_max_step_vtbl;
106  op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
107  *((RTOp_value_type*)op->obj_data) = beta;
108  return 0; /* success? */
109 }
110 
111 int RTOp_ROp_max_step_destroy( struct RTOp_RTOp* op )
112 {
113  op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
114  op->vtbl = NULL;
115  return 0; /* success? */
116 }
117 
118 int RTOp_ROp_max_step_set_beta( RTOp_value_type beta, struct RTOp_RTOp* op )
119 {
120  *((RTOp_value_type*)op->obj_data) = beta;
121  return 0; /* success? */
122 }
123 
124 RTOp_value_type RTOp_ROp_max_step_inf = +1e+50;
125 
126 RTOp_value_type RTOp_ROp_max_step_val(RTOp_ReductTarget reduct_obj)
127 {
128  return *(RTOp_value_type*)reduct_obj;
129 }
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