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_SparseSubVector.h
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 #ifndef RTOP_SPARSE_SUB_VECTOR_H
45 #define RTOP_SPARSE_SUB_VECTOR_H
46 
47 #include <stddef.h>
48 
49 #include "RTOp.h"
50 
51 #ifdef __cplusplus
52 extern "C" {
53 #endif
54 
55 /* */
132  /* Offset for the sub-vector into the global vector */
133  RTOp_index_type global_offset;
134  /* Dimension of the sub-vector */
135  RTOp_index_type sub_dim;
136  /* Number of nonzero elements (<tt>sub_nz == sub_dim</tt> for dense vectors) */
137  RTOp_index_type sub_nz;
138  /* Array (size min{|<tt>value_stride*sub_nz</tt>|,1}) for the values in the vector */
139  const RTOp_value_type *values;
140  /* Stride between elements in <tt>values[]</tt> */
141  ptrdiff_t values_stride;
142  /* */
146  const RTOp_index_type *indices;
147  /* Stride between indices in indices[] (sparse vectors only) */
148  ptrdiff_t indices_stride;
149  /* Offset of indices[] into local sub-vector (sparse vectors only) */
150  ptrdiff_t local_offset;
151  /* If <tt>is_sorted == 0</tt> then the vector is not sorted, otherwise it is sorted (sparse vectors only) */
152  int is_sorted;
153 };
154 
155 /* */
158 void RTOp_sparse_sub_vector(
159  RTOp_index_type global_offset, RTOp_index_type sub_dim, RTOp_index_type sub_nz
160  ,const RTOp_value_type values[], ptrdiff_t values_stride
161  ,const RTOp_index_type indices[], ptrdiff_t indices_stride
162  ,ptrdiff_t local_offset, int is_sorted
163  ,struct RTOp_SparseSubVector *sub_vec
164  );
165 /* */
168 void RTOp_sparse_sub_vector_null( struct RTOp_SparseSubVector *sub_vec );
169 
170 /* */
173 void RTOp_sparse_sub_vector_from_dense(
174  const struct RTOp_SubVector *sub_vec
175  ,struct RTOp_SparseSubVector *spc_sub_vec
176  );
177 
178 #ifdef __cplusplus
179 }
180 #endif
181 
182 #endif /* RTOP_SPARSE_SUB_VECTOR_H */
const RTOp_index_type * indices