MOOCHO (Single Doxygen Collection) Version of the Day
RTOp_ROp_sum.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_sum.h"
00045 #include "RTOp_obj_null_vtbl.h"
00046 #include "RTOp_obj_value_vtbl.h"
00047 #include "RTOp_reduct_sum_value.h"
00048 
00049 /* Implementation functions */
00050 
00051 static int RTOp_ROp_sum_apply_op(
00052   const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
00053   , const int num_vecs, const struct RTOp_SubVector vecs[]
00054   , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
00055   , RTOp_ReductTarget targ_obj )
00056 {
00057   RTOp_index_type        v0_sub_dim;
00058   const RTOp_value_type  *v0_val;
00059   ptrdiff_t              v0_val_s;
00060   register RTOp_index_type k;
00061   RTOp_value_type sum = 0.0;
00062 
00063   /* */
00064   /* Validate the input */
00065   /* */
00066   if( num_vecs != 1 )
00067     return RTOp_ERR_INVALID_NUM_VECS;
00068   if( num_targ_vecs != 0 )
00069     return RTOp_ERR_INVALID_NUM_TARG_VECS;
00070 
00071   /* */
00072   /* Get pointers to data */
00073   /* */
00074 
00075   /* v0 */
00076   v0_sub_dim      = vecs[0].sub_dim;
00077   v0_val         = vecs[0].values;
00078   v0_val_s       = vecs[0].values_stride;
00079 
00080   /* */
00081   /* Sum the vector elements! */
00082   /* */
00083 
00084   for( k = 0; k < v0_sub_dim; ++k, v0_val += v0_val_s )
00085     sum += *v0_val;
00086 
00087   /* */
00088   /* Add this to the result */
00089   /* */
00090   *((RTOp_value_type*)targ_obj) += sum;
00091 
00092   return 0; /* success? */
00093 }
00094 
00095 /* Virtual function table */
00096 const struct RTOp_RTOp_vtbl_t RTOp_ROp_sum_vtbl =
00097 {
00098   &RTOp_obj_null_vtbl   /* use null type for instance data */
00099   ,&RTOp_obj_value_vtbl /* use simple scalar type for target object */
00100   ,"ROp_sum"
00101   ,NULL
00102   ,RTOp_ROp_sum_apply_op
00103   ,RTOp_reduct_sum_value
00104   ,RTOp_get_reduct_sum_value_op
00105 };
00106 
00107 /* Class specific functions */
00108 
00109 int RTOp_ROp_sum_construct( struct RTOp_RTOp* op )
00110 {
00111   op->obj_data = NULL;
00112   op->vtbl     = &RTOp_ROp_sum_vtbl;
00113   return 0;
00114 }
00115 
00116 int RTOp_ROp_sum_destroy( struct RTOp_RTOp* op )
00117 {
00118   op->obj_data = NULL;
00119   op->vtbl     = NULL;
00120   return 0;
00121 }
00122 
00123 RTOp_value_type RTOp_ROp_sum_val(RTOp_ReductTarget targ_obj)
00124 {
00125   return *((RTOp_value_type*)targ_obj);
00126 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines