MOOCHO (Single Doxygen Collection) Version of the Day
RTOp_ROp_num_nonzeros.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_nonzeros.h"
00045 #include "RTOp_obj_null_vtbl.h"
00046 #include "RTOp_obj_value_vtbl.h"
00047 #include "RTOp_reduct_sum_value.h"
00048 
00049 /* Note that the reduction quantity that we are accumulating (num_bounded) */
00050 /* is an integral type and really should be delcared as RTOp_index_type. */
00051 /* However, the machinary is already there for accumulating an RTOp_value_type */
00052 /* reduction object so this implementation is just lazy and uses a double */
00053 /* for an integer.  This should not slow things down very much and does */
00054 /* not really waste any memory. */
00055 
00056 /* Implementation functions */
00057 
00058 static int RTOp_ROp_num_nonzeros_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 targ_obj )
00063 {
00064   RTOp_index_type        v0_sub_dim;
00065   const RTOp_value_type  *v0_val;
00066   ptrdiff_t              v0_val_s;
00067   register RTOp_index_type k;
00068   RTOp_index_type          nz = 0;
00069 
00070   /* */
00071   /* Validate the input */
00072   /* */
00073   if( num_vecs != 1 )
00074     return RTOp_ERR_INVALID_NUM_VECS;
00075   assert( vecs );
00076   if( num_targ_vecs != 0 )
00077     return RTOp_ERR_INVALID_NUM_TARG_VECS;
00078 
00079   /* */
00080   /* Get pointers to data */
00081   /* */
00082 
00083   /* v0 */
00084   v0_sub_dim     = vecs[0].sub_dim;
00085   v0_val         = vecs[0].values;
00086   v0_val_s       = vecs[0].values_stride;
00087 
00088   /* */
00089   /* Count the number of nonzeros */
00090   /* */
00091 
00092   for( k = 0; k < v0_sub_dim; ++k, v0_val += v0_val_s )
00093     if(*v0_val != 0.0)
00094       ++nz;
00095 
00096   /* */
00097   /* Add this to the result */
00098   /* */
00099   *((RTOp_value_type*)targ_obj) += nz;
00100 
00101   return 0; /* success? */
00102 }
00103 
00104 /* Virtual function table */
00105 const struct RTOp_RTOp_vtbl_t RTOp_ROp_num_nonzeros_vtbl =
00106 {
00107   &RTOp_obj_null_vtbl   /* use null type for instance data */
00108   ,&RTOp_obj_value_vtbl /* use simple scalar type for target object */
00109   ,"ROp_num_nonzeros"
00110   ,NULL
00111   ,RTOp_ROp_num_nonzeros_apply_op
00112   ,RTOp_reduct_sum_value
00113   ,RTOp_get_reduct_sum_value_op
00114 };
00115 
00116 /* Class specific functions */
00117 
00118 int RTOp_ROp_num_nonzeros_construct( struct RTOp_RTOp* op )
00119 {
00120   op->obj_data = NULL;
00121   op->vtbl     = &RTOp_ROp_num_nonzeros_vtbl;
00122   return 0;
00123 }
00124 
00125 int RTOp_ROp_num_nonzeros_destroy( struct RTOp_RTOp* op )
00126 {
00127   op->obj_data = NULL;
00128   op->vtbl     = NULL;
00129   return 0;
00130 }
00131 
00132 RTOp_index_type RTOp_ROp_num_nonzeros_val(RTOp_ReductTarget targ_obj)
00133 {
00134   return (RTOp_index_type)*((RTOp_value_type*)targ_obj);
00135 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines