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 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00039 // 
00040 // ***********************************************************************
00041 // @HEADER
00042 */
00043 
00044 #include <math.h>
00045 
00046 /* */
00047 /* Note: This file was created automatically by 'new_rtop.pl' */
00048 /*       on 6/24/2002 at 21:2 */
00049 /* */
00050 
00051 #define max(a,b) ( (a) > (b) ? (a) : (b) )
00052 #define min(a,b) ( (a) < (b) ? (a) : (b) )
00053 
00054 #include "RTOp_ROp_max_rel_step.h"
00055 #include "RTOp_obj_null_vtbl.h"  /* vtbl for operator object instance data */
00056 #include "RTOp_reduct_max_value.h"
00057 
00058 /* Implementation functions for RTOp_RTOp */
00059 
00060 static int RTOp_ROp_max_rel_step_apply_op(
00061   const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
00062   , const int num_vecs, const struct RTOp_SubVector vecs[]
00063   , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
00064   , RTOp_ReductTarget reduct_obj )
00065 {
00066   /* */
00067   /* Declare local variables */
00068   /* */
00069 
00070     /* Access to the reduction object data */
00071     RTOp_value_type *gamma = (RTOp_value_type*)reduct_obj;
00072     /* Vector data */
00073     RTOp_index_type           sub_dim;
00074     /* v0 */
00075     const RTOp_value_type     *v0_val;
00076     ptrdiff_t                 v0_val_s;
00077     /* v1 */
00078     const RTOp_value_type     *v1_val;
00079     ptrdiff_t                 v1_val_s;
00080 
00081     register RTOp_index_type  k;
00082     register RTOp_value_type  gamma_i;
00083 
00084   /* */
00085   /* Validate the input */
00086   /* */
00087     if( num_vecs != 2 || ( num_vecs && vecs == NULL ) )
00088         return RTOp_ERR_INVALID_NUM_VECS;
00089     if( num_targ_vecs != 0 || ( num_targ_vecs && targ_vecs == NULL ) )
00090         return RTOp_ERR_INVALID_NUM_TARG_VECS;
00091     if( /* Validate sub_dim */
00092         vecs[1].sub_dim != vecs[0].sub_dim
00093         )
00094         return RTOp_ERR_INCOMPATIBLE_VECS;
00095     assert(reduct_obj);
00096 
00097   /* */
00098   /* Get pointers to data */
00099   /* */
00100     sub_dim      = vecs[0].sub_dim;
00101     /* v0 */
00102     v0_val        = vecs[0].values;
00103     v0_val_s      = vecs[0].values_stride;
00104     /* v1 */
00105     v1_val        = vecs[1].values;
00106     v1_val_s      = vecs[1].values_stride;
00107 
00108   /* */
00109   /* Apply the operator: */
00110   /* */
00111     /*    element-wise reduction      : gamma = max( gamma, fabs(v1) / ( 1.0 + fabs(v0) ) ); */
00112     /* */
00113     for( k = 0; k < sub_dim; ++k, v0_val += v0_val_s, v1_val += v1_val_s )
00114     {
00115         /* Element-wise reduction */
00116     gamma_i = fabs((*v1_val)) / ( 1.0 + fabs((*v0_val)) );
00117         (*gamma) = max( (*gamma), gamma_i  );
00118     }
00119 
00120   return 0; /* success? */
00121 }
00122 
00123 /* Virtual function table */
00124 const struct RTOp_RTOp_vtbl_t RTOp_ROp_max_rel_step_vtbl =
00125 {
00126   &RTOp_obj_null_vtbl
00127   ,&RTOp_obj_value_vtbl
00128   ,"ROp_max_rel_step"
00129   ,NULL
00130   ,RTOp_ROp_max_rel_step_apply_op
00131   ,RTOp_reduct_max_value
00132   ,RTOp_get_reduct_max_value_op
00133 };
00134 
00135 /* Class specific functions */
00136 
00137 int RTOp_ROp_max_rel_step_construct(  struct RTOp_RTOp* op )
00138 {
00139 #ifdef RTOp_DEBUG
00140   assert(op);
00141 #endif
00142   op->obj_data  = NULL;
00143   op->vtbl      = &RTOp_ROp_max_rel_step_vtbl;
00144   op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
00145   return 0;
00146 }
00147 
00148 int RTOp_ROp_max_rel_step_destroy( struct RTOp_RTOp* op )
00149 {
00150   op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
00151   op->obj_data  = NULL;
00152   op->vtbl      = NULL;
00153   return 0;
00154 }
00155 
00156 RTOp_value_type RTOp_ROp_max_rel_step_val(RTOp_ReductTarget reduct_obj)
00157 {
00158     return *((RTOp_value_type*)reduct_obj);
00159 }
00160 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines