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 /* */
00032 /* Note: This file was created automatically by 'new_rtop.pl' */
00033 /*       on 6/24/2002 at 21:2 */
00034 /* */
00035 
00036 #define max(a,b) ( (a) > (b) ? (a) : (b) )
00037 #define min(a,b) ( (a) < (b) ? (a) : (b) )
00038 
00039 #include "RTOp_ROp_max_rel_step.h"
00040 #include "RTOp_obj_null_vtbl.h"  /* vtbl for operator object instance data */
00041 #include "RTOp_reduct_max_value.h"
00042 
00043 /* Implementation functions for RTOp_RTOp */
00044 
00045 static int RTOp_ROp_max_rel_step_apply_op(
00046   const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
00047   , const int num_vecs, const struct RTOp_SubVector vecs[]
00048   , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
00049   , RTOp_ReductTarget reduct_obj )
00050 {
00051   /* */
00052   /* Declare local variables */
00053   /* */
00054 
00055     /* Access to the reduction object data */
00056     RTOp_value_type *gamma = (RTOp_value_type*)reduct_obj;
00057     /* Vector data */
00058     RTOp_index_type           sub_dim;
00059     /* v0 */
00060     const RTOp_value_type     *v0_val;
00061     ptrdiff_t                 v0_val_s;
00062     /* v1 */
00063     const RTOp_value_type     *v1_val;
00064     ptrdiff_t                 v1_val_s;
00065 
00066     register RTOp_index_type  k;
00067     register RTOp_value_type  gamma_i;
00068 
00069   /* */
00070   /* Validate the input */
00071   /* */
00072     if( num_vecs != 2 || ( num_vecs && vecs == NULL ) )
00073         return RTOp_ERR_INVALID_NUM_VECS;
00074     if( num_targ_vecs != 0 || ( num_targ_vecs && targ_vecs == NULL ) )
00075         return RTOp_ERR_INVALID_NUM_TARG_VECS;
00076     if( /* Validate sub_dim */
00077         vecs[1].sub_dim != vecs[0].sub_dim
00078         )
00079         return RTOp_ERR_INCOMPATIBLE_VECS;
00080     assert(reduct_obj);
00081 
00082   /* */
00083   /* Get pointers to data */
00084   /* */
00085     sub_dim      = vecs[0].sub_dim;
00086     /* v0 */
00087     v0_val        = vecs[0].values;
00088     v0_val_s      = vecs[0].values_stride;
00089     /* v1 */
00090     v1_val        = vecs[1].values;
00091     v1_val_s      = vecs[1].values_stride;
00092 
00093   /* */
00094   /* Apply the operator: */
00095   /* */
00096     /*    element-wise reduction      : gamma = max( gamma, fabs(v1) / ( 1.0 + fabs(v0) ) ); */
00097     /* */
00098     for( k = 0; k < sub_dim; ++k, v0_val += v0_val_s, v1_val += v1_val_s )
00099     {
00100         /* Element-wise reduction */
00101     gamma_i = fabs((*v1_val)) / ( 1.0 + fabs((*v0_val)) );
00102         (*gamma) = max( (*gamma), gamma_i  );
00103     }
00104 
00105   return 0; /* success? */
00106 }
00107 
00108 /* Virtual function table */
00109 const struct RTOp_RTOp_vtbl_t RTOp_ROp_max_rel_step_vtbl =
00110 {
00111   &RTOp_obj_null_vtbl
00112   ,&RTOp_obj_value_vtbl
00113   ,"ROp_max_rel_step"
00114   ,NULL
00115   ,RTOp_ROp_max_rel_step_apply_op
00116   ,RTOp_reduct_max_value
00117   ,RTOp_get_reduct_max_value_op
00118 };
00119 
00120 /* Class specific functions */
00121 
00122 int RTOp_ROp_max_rel_step_construct(  struct RTOp_RTOp* op )
00123 {
00124 #ifdef RTOp_DEBUG
00125   assert(op);
00126 #endif
00127   op->obj_data  = NULL;
00128   op->vtbl      = &RTOp_ROp_max_rel_step_vtbl;
00129   op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
00130   return 0;
00131 }
00132 
00133 int RTOp_ROp_max_rel_step_destroy( struct RTOp_RTOp* op )
00134 {
00135   op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
00136   op->obj_data  = NULL;
00137   op->vtbl      = NULL;
00138   return 0;
00139 }
00140 
00141 RTOp_value_type RTOp_ROp_max_rel_step_val(RTOp_ReductTarget reduct_obj)
00142 {
00143     return *((RTOp_value_type*)reduct_obj);
00144 }
00145 

Generated on Tue Oct 20 12:51:49 2009 for MOOCHO (Single Doxygen Collection) by doxygen 1.4.7