MOOCHO (Single Doxygen Collection) Version of the Day
RTOp_ROp_num_bounded.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_num_bounded.h"
00045 #include "RTOp_obj_value_vtbl.h"
00046 #include "RTOp_reduct_sum_value.h"
00047 
00048 /* Note that the reduction quantity that we are accumulating (num_bounded) */
00049 /* is an integral type and really should be delcared as RTOp_index_type. */
00050 /* However, the machinary is already there for accumulating an RTOp_value_type */
00051 /* reduction object so this implementation is just lazy and uses a double */
00052 /* for an integer.  This should not slow things down very much and does */
00053 /* not really waste any memory. */
00054 
00055 /* Implementation functions */
00056 
00057 static int RTOp_ROp_num_bounded_apply_op(
00058   const struct RTOp_RTOp_vtbl_t* vtbl,  const void* obj_data
00059   , const int num_vecs, const struct RTOp_SubVector vecs[]
00060   , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
00061   , RTOp_ReductTarget targ_obj )
00062 {
00063   RTOp_value_type        inf_bnd;
00064   RTOp_index_type        sub_dim;
00065   const RTOp_value_type  *xl_val;
00066   ptrdiff_t              xl_val_s;
00067   const RTOp_value_type  *xu_val;
00068   ptrdiff_t              xu_val_s;
00069   RTOp_index_type        num_bounded = 0;
00070   register RTOp_index_type k;
00071 
00072   /* */
00073   /* Validate the input */
00074   /* */
00075   if( num_vecs != 2 )
00076     return RTOp_ERR_INVALID_NUM_VECS;
00077   assert( vecs );
00078   if( num_targ_vecs != 0 )
00079     return RTOp_ERR_INVALID_NUM_TARG_VECS;
00080   if( vecs[0].sub_dim != vecs[1].sub_dim )                 /* Same sizes */
00081     return RTOp_ERR_INCOMPATIBLE_VECS;
00082 
00083   /* */
00084   /* Get pointers to data */
00085   /* */
00086 
00087   /* inf_bnd */
00088   inf_bnd = *((RTOp_value_type*)obj_data);
00089   /* sub_dim */
00090   sub_dim        = vecs[0].sub_dim;
00091   /* xl */
00092   xl_val         = vecs[0].values;
00093   xl_val_s       = vecs[0].values_stride;
00094   /* xl */
00095   xu_val         = vecs[1].values;
00096   xu_val_s       = vecs[1].values_stride;
00097 
00098   /* */
00099   /* Count the number of bounded variables */
00100   /* */
00101   for( k = 0; k < sub_dim; ++k, xl_val += xl_val_s, xu_val += xu_val_s ) {
00102     if( *xl_val > -inf_bnd || *xu_val < +inf_bnd )
00103       ++num_bounded;
00104   }
00105 
00106   /* */
00107   /* Add this to the result */
00108   /* */
00109   *((RTOp_value_type*)targ_obj) += num_bounded;
00110 
00111   return 0; /* success? */
00112 }
00113 
00114 /* Virtual function table pointer */
00115 const struct RTOp_RTOp_vtbl_t RTOp_ROp_num_bounded_vtbl =
00116 {
00117   &RTOp_obj_value_vtbl  /* use simple scalar value type for object instance data */
00118   ,&RTOp_obj_value_vtbl /* use simple scalar value type for target object */
00119   ,"ROp_num_bounded"
00120   ,NULL
00121   ,RTOp_ROp_num_bounded_apply_op
00122   ,RTOp_reduct_sum_value
00123   ,RTOp_get_reduct_sum_value_op
00124 };
00125 
00126 /* Class specific functions */
00127 
00128 int RTOp_ROp_num_bounded_construct( RTOp_value_type inf_bnd, struct RTOp_RTOp* op )
00129 {
00130   op->vtbl = &RTOp_ROp_num_bounded_vtbl;
00131   op->vtbl->obj_data_vtbl->obj_create( NULL, NULL, &op->obj_data );
00132   *((RTOp_value_type*)op->obj_data) = inf_bnd;
00133   return 0; /* success? */
00134 }
00135 
00136 int RTOp_ROp_num_bounded_destroy( struct RTOp_RTOp* op )
00137 {
00138   op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
00139   op->vtbl      = NULL;
00140   return 0; /* success? */
00141 }
00142 
00143 int RTOp_ROp_num_bounded_set_inf_bnd( RTOp_value_type inf_bnd, struct RTOp_RTOp* op )
00144 {
00145   *((RTOp_value_type*)op->obj_data) = inf_bnd;
00146   return 0; /* success? */
00147 }
00148 
00149 RTOp_index_type RTOp_ROp_num_bounded_val(RTOp_ReductTarget targ_obj)
00150 {
00151   return (RTOp_index_type)*((RTOp_value_type*)targ_obj);
00152 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines