MOOCHO (Single Doxygen Collection) Version of the Day
RTOp_TOp_multiplier_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 /* ///////////////////////////////////////////// */
00045 /* RTOp_TOp_multiplier_step.c */
00046 
00047 /* */
00048 /* Note: This file was created automatically by 'new_rtop.pl' */
00049 /*       on 7/10/2002 at 1:19 */
00050 /* */
00051 
00052 #define max(a,b) ( (a) > (b) ? (a) : (b) )
00053 #define min(a,b) ( (a) < (b) ? (a) : (b) )
00054 
00055 #include "RTOp_TOp_multiplier_step.h"
00056 #include "RTOp_obj_value_value_vtbl.h"  /* vtbl for operator object instance data */
00057 
00058 
00059 
00060 /* Implementation functions for RTOp_RTOp */
00061 
00062 static int RTOp_TOp_multiplier_step_apply_op(
00063   const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
00064   , const int num_vecs, const struct RTOp_SubVector vecs[]
00065   , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
00066   , RTOp_ReductTarget reduct_obj )
00067 {
00068   /* */
00069   /* Declare local variables */
00070   /* */
00071 
00072   /* Access to the operator object instance data */
00073   struct RTOp_value_value_type *data_cntr = (struct RTOp_value_value_type*)obj_data;
00074   RTOp_value_type *mu = &data_cntr->value1;
00075   RTOp_value_type *alpha = &data_cntr->value2;
00076   /* Vector data */
00077   RTOp_index_type           sub_dim;
00078   /* z0 */
00079   RTOp_value_type           *z0_val;
00080   ptrdiff_t                 z0_val_s;
00081   /* v0 */
00082   const RTOp_value_type     *v0_val;
00083   ptrdiff_t                 v0_val_s;
00084   /* v1 */
00085   const RTOp_value_type     *v1_val;
00086   ptrdiff_t                 v1_val_s;
00087   /* v2 */
00088   const RTOp_value_type     *v2_val;
00089   ptrdiff_t                 v2_val_s;
00090 
00091   /* Automatic temporary variables */
00092   register RTOp_index_type  k;
00093 
00094   /* */
00095   /* Validate the input */
00096   /* */
00097   if( num_vecs != 3 || ( num_vecs && vecs == NULL ) )
00098     return RTOp_ERR_INVALID_NUM_VECS;
00099   if( num_targ_vecs != 1 || ( num_targ_vecs && targ_vecs == NULL ) )
00100     return RTOp_ERR_INVALID_NUM_TARG_VECS;
00101   if( /* Validate sub_dim */
00102     vecs[1].sub_dim != vecs[0].sub_dim
00103     || vecs[2].sub_dim != vecs[0].sub_dim
00104     || targ_vecs[0].sub_dim != vecs[0].sub_dim
00105     )
00106     return RTOp_ERR_INCOMPATIBLE_VECS;
00107   assert(obj_data);
00108 
00109   /* */
00110   /* Get pointers to data */
00111   /* */
00112   sub_dim       = vecs[0].sub_dim;
00113   /* z0 */
00114   z0_val        = targ_vecs[0].values;
00115   z0_val_s      = targ_vecs[0].values_stride;
00116   /* v0 */
00117   v0_val        = vecs[0].values;
00118   v0_val_s      = vecs[0].values_stride;
00119   /* v1 */
00120   v1_val        = vecs[1].values;
00121   v1_val_s      = vecs[1].values_stride;
00122   /* v2 */
00123   v2_val        = vecs[2].values;
00124   v2_val_s      = vecs[2].values_stride;
00125 
00126   /* */
00127   /* Apply the operator: */
00128   /* */
00129   for( k = 0; k < sub_dim; ++k, v0_val += v0_val_s, v1_val += v1_val_s, v2_val += v2_val_s, z0_val += z0_val_s )
00130   {
00131     /* Element-wise transformation */
00132     (*z0_val) = -(*v1_val) + (*mu)*(*v0_val) + (*alpha)*(*v0_val)*(*v1_val)*(*v2_val);
00133   }
00134 
00135   return 0; /* success? */
00136 }
00137 
00138 /* Virtual function table */
00139 const struct RTOp_RTOp_vtbl_t RTOp_TOp_multiplier_step_vtbl =
00140 {
00141   &RTOp_obj_value_value_vtbl
00142   ,&RTOp_obj_null_vtbl
00143   ,"TOp_multiplier_step"
00144   ,NULL
00145   ,RTOp_TOp_multiplier_step_apply_op
00146   ,NULL
00147   ,NULL
00148 };
00149 
00150 /* Class specific functions */
00151 
00152 int RTOp_TOp_multiplier_step_construct( RTOp_value_type mu, RTOp_value_type alpha,  struct RTOp_RTOp* op )
00153 {
00154 #ifdef RTOp_DEBUG
00155   assert(op);
00156 #endif
00157   op->obj_data  = NULL;
00158   op->vtbl      = &RTOp_TOp_multiplier_step_vtbl;
00159   op->vtbl->obj_data_vtbl->obj_create(NULL,NULL,&op->obj_data);
00160   return RTOp_TOp_multiplier_step_init(mu,alpha,op);
00161 }
00162 
00163 int RTOp_TOp_multiplier_step_destroy( struct RTOp_RTOp* op )
00164 {
00165   op->vtbl->obj_data_vtbl->obj_free(NULL,NULL,&op->obj_data);
00166   op->obj_data  = NULL;
00167   op->vtbl      = NULL;
00168   return 0;
00169 }
00170 
00171 int RTOp_TOp_multiplier_step_init( RTOp_value_type mu, RTOp_value_type alpha, struct RTOp_RTOp* op )
00172 {
00173   struct RTOp_value_value_type *ptr_data_cntr = (struct RTOp_value_value_type*)op->obj_data;
00174   RTOp_value_type *ptr_mu = &ptr_data_cntr->value1;
00175   RTOp_value_type *ptr_alpha = &ptr_data_cntr->value2;
00176   *ptr_mu = mu;
00177   *ptr_alpha = alpha;
00178   return 0;
00179 }
00180 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines