RTOpPack: Extra C/C++ Code for Vector Reduction/Transformation Operators  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
RTOp_ROp_num_nonzeros.c
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
6 // Copyright (2003) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 */
43 
44 #include "RTOp_ROp_num_nonzeros.h"
45 #include "RTOp_obj_null_vtbl.h"
46 #include "RTOp_obj_value_vtbl.h"
47 #include "RTOp_reduct_sum_value.h"
48 
49 /* Note that the reduction quantity that we are accumulating (num_bounded) */
50 /* is an integral type and really should be delcared as RTOp_index_type. */
51 /* However, the machinary is already there for accumulating an RTOp_value_type */
52 /* reduction object so this implementation is just lazy and uses a double */
53 /* for an integer. This should not slow things down very much and does */
54 /* not really waste any memory. */
55 
56 /* Implementation functions */
57 
58 static int RTOp_ROp_num_nonzeros_apply_op(
59  const struct RTOp_RTOp_vtbl_t* vtbl, const void* obj_data
60  , const int num_vecs, const struct RTOp_SubVector vecs[]
61  , const int num_targ_vecs, const struct RTOp_MutableSubVector targ_vecs[]
62  , RTOp_ReductTarget targ_obj )
63 {
64  RTOp_index_type v0_sub_dim;
65  const RTOp_value_type *v0_val;
66  ptrdiff_t v0_val_s;
67  register RTOp_index_type k;
68  RTOp_index_type nz = 0;
69 
70  /* */
71  /* Validate the input */
72  /* */
73  if( num_vecs != 1 )
74  return RTOp_ERR_INVALID_NUM_VECS;
75  assert( vecs );
76  if( num_targ_vecs != 0 )
77  return RTOp_ERR_INVALID_NUM_TARG_VECS;
78 
79  /* */
80  /* Get pointers to data */
81  /* */
82 
83  /* v0 */
84  v0_sub_dim = vecs[0].sub_dim;
85  v0_val = vecs[0].values;
86  v0_val_s = vecs[0].values_stride;
87 
88  /* */
89  /* Count the number of nonzeros */
90  /* */
91 
92  for( k = 0; k < v0_sub_dim; ++k, v0_val += v0_val_s )
93  if(*v0_val != 0.0)
94  ++nz;
95 
96  /* */
97  /* Add this to the result */
98  /* */
99  *((RTOp_value_type*)targ_obj) += nz;
100 
101  return 0; /* success? */
102 }
103 
104 /* Virtual function table */
105 const struct RTOp_RTOp_vtbl_t RTOp_ROp_num_nonzeros_vtbl =
106 {
107  &RTOp_obj_null_vtbl /* use null type for instance data */
108  ,&RTOp_obj_value_vtbl /* use simple scalar type for target object */
109  ,"ROp_num_nonzeros"
110  ,NULL
111  ,RTOp_ROp_num_nonzeros_apply_op
112  ,RTOp_reduct_sum_value
113  ,RTOp_get_reduct_sum_value_op
114 };
115 
116 /* Class specific functions */
117 
118 int RTOp_ROp_num_nonzeros_construct( struct RTOp_RTOp* op )
119 {
120  op->obj_data = NULL;
121  op->vtbl = &RTOp_ROp_num_nonzeros_vtbl;
122  return 0;
123 }
124 
125 int RTOp_ROp_num_nonzeros_destroy( struct RTOp_RTOp* op )
126 {
127  op->obj_data = NULL;
128  op->vtbl = NULL;
129  return 0;
130 }
131 
132 RTOp_index_type RTOp_ROp_num_nonzeros_val(RTOp_ReductTarget targ_obj)
133 {
134  return (RTOp_index_type)*((RTOp_value_type*)targ_obj);
135 }