MOOCHO (Single Doxygen Collection) Version of the Day
RTOp_ROp_max_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 "RTOp_ROp_max_step.h"
00045 #include "RTOp_obj_value_vtbl.h"
00046 #include "RTOp_obj_free_free.h"
00047 #include "RTOp_get_reduct_op.hpp"
00048 #include "RTOp_reduct_min_value.h"
00049 
00050 static int RTOp_ROp_max_step_reduct_obj_reinit(
00051   const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
00052   , RTOp_ReductTarget reduct_obj )
00053 {
00054   *((RTOp_value_type*)reduct_obj) = RTOp_ROp_max_step_inf;
00055   return 0;
00056 }
00057 
00058 static int ROp_max_step_apply_op(
00059   const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
00060   , const int num_vecs, const struct RTOp_SubVector vecs[]
00061   , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
00062   , RTOp_ReductTarget reduct_obj )
00063 {
00064   /* Declare locals */
00065   const RTOp_value_type     beta     = *(RTOp_value_type*)obj_data;
00066   RTOp_value_type           *alpha   =  (RTOp_value_type*)reduct_obj;
00067   RTOp_index_type           sub_dim  = 0;
00068   const RTOp_value_type     *v0_val = NULL, *v1_val = NULL;
00069   ptrdiff_t                 v0_val_s = 0, v1_val_s = 0;
00070   register RTOp_index_type  k;
00071   RTOp_value_type           alpha_tmp;
00072   /* Validate the input */
00073   if( num_vecs != 2 )                       return RTOp_ERR_INVALID_NUM_VECS;
00074   if( num_targ_vecs != 0 )                  return RTOp_ERR_INVALID_NUM_TARG_VECS;
00075   if( vecs[0].sub_dim != vecs[1].sub_dim )  return RTOp_ERR_INCOMPATIBLE_VECS;
00076   /* Get local variables to vector data */
00077   sub_dim  = vecs[0].sub_dim;
00078   v0_val   = vecs[0].values;  v0_val_s = vecs[0].values_stride;
00079   v1_val   = vecs[1].values;  v1_val_s = vecs[1].values_stride;
00080   /* Perform the reduction operation: */
00081   /*     max alpha s.t. v[0] + alpha * v[1] >= beta */
00082   for( k = 0; k < sub_dim; ++k, v0_val += v0_val_s, v1_val += v1_val_s ) {
00083     alpha_tmp = (beta - (*v0_val))/(*v1_val);
00084     *alpha = ( (0 <= alpha_tmp && alpha_tmp < *alpha) ? alpha_tmp : *alpha );
00085   }
00086   return 0; /* success! */
00087 }
00088 
00089 /* Virtual function table */
00090 const struct RTOp_RTOp_vtbl_t RTOp_ROp_max_step_vtbl =
00091 {
00092   &RTOp_obj_value_vtbl
00093   ,&RTOp_obj_value_vtbl
00094   ,"ROp_max_step"
00095   ,RTOp_ROp_max_step_reduct_obj_reinit
00096   ,ROp_max_step_apply_op
00097   ,RTOp_reduct_min_value
00098   ,RTOp_get_reduct_min_value_op
00099 };
00100 
00101 /* Class specific functions */
00102 
00103 int RTOp_ROp_max_step_construct( RTOp_value_type beta, struct RTOp_RTOp* op )
00104 {
00105   op->vtbl = &RTOp_ROp_max_step_vtbl;
00106   op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
00107   *((RTOp_value_type*)op->obj_data) = beta;
00108   return 0; /* success? */
00109 }
00110 
00111 int RTOp_ROp_max_step_destroy( struct RTOp_RTOp* op )
00112 {
00113   op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
00114   op->vtbl      = NULL;
00115   return 0; /* success? */
00116 }
00117 
00118 int RTOp_ROp_max_step_set_beta( RTOp_value_type beta, struct RTOp_RTOp* op )
00119 {
00120   *((RTOp_value_type*)op->obj_data) = beta;
00121   return 0; /* success? */
00122 }
00123 
00124 RTOp_value_type  RTOp_ROp_max_step_inf = +1e+50;
00125 
00126 RTOp_value_type  RTOp_ROp_max_step_val(RTOp_ReductTarget reduct_obj)
00127 {
00128   return *(RTOp_value_type*)reduct_obj;
00129 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines