MOOCHO (Single Doxygen Collection) Version of the Day
RTOp_ROp_max_rel_step.c
Go to the documentation of this file.
00001 /*
00002 // @HEADER
00003 // ***********************************************************************
00004 // 
00005 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00006 //                  Copyright (2003) Sandia Corporation
00007 // 
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 // 
00011 // This library is free software; you can redistribute it and/or modify
00012 // it under the terms of the GNU Lesser General Public License as
00013 // published by the Free Software Foundation; either version 2.1 of the
00014 // License, or (at your option) any later version.
00015 //  
00016 // This library is distributed in the hope that it will be useful, but
00017 // WITHOUT ANY WARRANTY; without even the implied warranty of
00018 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019 // Lesser General Public License for more details.
00020 //  
00021 // You should have received a copy of the GNU Lesser General Public
00022 // License along with this library; if not, write to the Free Software
00023 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00024 // USA
00025 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00026 // 
00027 // ***********************************************************************
00028 // @HEADER
00029 */
00030 
00031 #include <math.h>
00032 
00033 /* */
00034 /* Note: This file was created automatically by 'new_rtop.pl' */
00035 /*       on 6/24/2002 at 21:2 */
00036 /* */
00037 
00038 #define max(a,b) ( (a) > (b) ? (a) : (b) )
00039 #define min(a,b) ( (a) < (b) ? (a) : (b) )
00040 
00041 #include "RTOp_ROp_max_rel_step.h"
00042 #include "RTOp_obj_null_vtbl.h"  /* vtbl for operator object instance data */
00043 #include "RTOp_reduct_max_value.h"
00044 
00045 /* Implementation functions for RTOp_RTOp */
00046 
00047 static int RTOp_ROp_max_rel_step_apply_op(
00048   const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
00049   , const int num_vecs, const struct RTOp_SubVector vecs[]
00050   , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
00051   , RTOp_ReductTarget reduct_obj )
00052 {
00053   /* */
00054   /* Declare local variables */
00055   /* */
00056 
00057     /* Access to the reduction object data */
00058     RTOp_value_type *gamma = (RTOp_value_type*)reduct_obj;
00059     /* Vector data */
00060     RTOp_index_type           sub_dim;
00061     /* v0 */
00062     const RTOp_value_type     *v0_val;
00063     ptrdiff_t                 v0_val_s;
00064     /* v1 */
00065     const RTOp_value_type     *v1_val;
00066     ptrdiff_t                 v1_val_s;
00067 
00068     register RTOp_index_type  k;
00069     register RTOp_value_type  gamma_i;
00070 
00071   /* */
00072   /* Validate the input */
00073   /* */
00074     if( num_vecs != 2 || ( num_vecs && vecs == NULL ) )
00075         return RTOp_ERR_INVALID_NUM_VECS;
00076     if( num_targ_vecs != 0 || ( num_targ_vecs && targ_vecs == NULL ) )
00077         return RTOp_ERR_INVALID_NUM_TARG_VECS;
00078     if( /* Validate sub_dim */
00079         vecs[1].sub_dim != vecs[0].sub_dim
00080         )
00081         return RTOp_ERR_INCOMPATIBLE_VECS;
00082     assert(reduct_obj);
00083 
00084   /* */
00085   /* Get pointers to data */
00086   /* */
00087     sub_dim      = vecs[0].sub_dim;
00088     /* v0 */
00089     v0_val        = vecs[0].values;
00090     v0_val_s      = vecs[0].values_stride;
00091     /* v1 */
00092     v1_val        = vecs[1].values;
00093     v1_val_s      = vecs[1].values_stride;
00094 
00095   /* */
00096   /* Apply the operator: */
00097   /* */
00098     /*    element-wise reduction      : gamma = max( gamma, fabs(v1) / ( 1.0 + fabs(v0) ) ); */
00099     /* */
00100     for( k = 0; k < sub_dim; ++k, v0_val += v0_val_s, v1_val += v1_val_s )
00101     {
00102         /* Element-wise reduction */
00103     gamma_i = fabs((*v1_val)) / ( 1.0 + fabs((*v0_val)) );
00104         (*gamma) = max( (*gamma), gamma_i  );
00105     }
00106 
00107   return 0; /* success? */
00108 }
00109 
00110 /* Virtual function table */
00111 const struct RTOp_RTOp_vtbl_t RTOp_ROp_max_rel_step_vtbl =
00112 {
00113   &RTOp_obj_null_vtbl
00114   ,&RTOp_obj_value_vtbl
00115   ,"ROp_max_rel_step"
00116   ,NULL
00117   ,RTOp_ROp_max_rel_step_apply_op
00118   ,RTOp_reduct_max_value
00119   ,RTOp_get_reduct_max_value_op
00120 };
00121 
00122 /* Class specific functions */
00123 
00124 int RTOp_ROp_max_rel_step_construct(  struct RTOp_RTOp* op )
00125 {
00126 #ifdef RTOp_DEBUG
00127   assert(op);
00128 #endif
00129   op->obj_data  = NULL;
00130   op->vtbl      = &RTOp_ROp_max_rel_step_vtbl;
00131   op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
00132   return 0;
00133 }
00134 
00135 int RTOp_ROp_max_rel_step_destroy( struct RTOp_RTOp* op )
00136 {
00137   op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
00138   op->obj_data  = NULL;
00139   op->vtbl      = NULL;
00140   return 0;
00141 }
00142 
00143 RTOp_value_type RTOp_ROp_max_rel_step_val(RTOp_ReductTarget reduct_obj)
00144 {
00145     return *((RTOp_value_type*)reduct_obj);
00146 }
00147 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines