MOOCHO (Single Doxygen Collection) Version of the Day
RTOp_SparseSubVector.h
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 #ifndef RTOP_SPARSE_SUB_VECTOR_H
00045 #define RTOP_SPARSE_SUB_VECTOR_H
00046 
00047 #include <stddef.h>
00048 
00049 #include "RTOp.h"
00050 
00051 #ifdef __cplusplus
00052 extern "C" {
00053 #endif
00054 
00055 /* */
00131 struct RTOp_SparseSubVector {
00132   /* Offset for the sub-vector into the global vector */
00133   RTOp_index_type                  global_offset;
00134   /* Dimension of the sub-vector */
00135   RTOp_index_type                  sub_dim;
00136   /* Number of nonzero elements (<tt>sub_nz == sub_dim</tt> for dense vectors) */
00137   RTOp_index_type                  sub_nz;
00138   /* Array (size min{|<tt>value_stride*sub_nz</tt>|,1}) for the values in the vector */
00139   const RTOp_value_type            *values;
00140   /* Stride between elements in <tt>values[]</tt> */
00141   ptrdiff_t                        values_stride;
00142   /* */
00146   const RTOp_index_type            *indices;
00147   /* Stride between indices in indices[] (sparse vectors only) */
00148   ptrdiff_t                        indices_stride;
00149   /* Offset of indices[] into local sub-vector (sparse vectors only) */
00150   ptrdiff_t                        local_offset;
00151   /* If <tt>is_sorted == 0</tt> then the vector is not sorted, otherwise it is sorted (sparse vectors only) */
00152   int                              is_sorted;
00153 };
00154 
00155 /* */
00158 void RTOp_sparse_sub_vector(
00159   RTOp_index_type global_offset, RTOp_index_type sub_dim, RTOp_index_type sub_nz
00160   ,const RTOp_value_type values[], ptrdiff_t values_stride
00161   ,const RTOp_index_type indices[], ptrdiff_t indices_stride
00162   ,ptrdiff_t local_offset, int is_sorted
00163   ,struct RTOp_SparseSubVector *sub_vec
00164   );
00165 /* */
00168 void RTOp_sparse_sub_vector_null( struct RTOp_SparseSubVector *sub_vec );
00169 
00170 /* */
00173 void RTOp_sparse_sub_vector_from_dense(
00174   const struct RTOp_SubVector     *sub_vec
00175   ,struct RTOp_SparseSubVector    *spc_sub_vec
00176   );
00177 
00178 #ifdef __cplusplus
00179 }
00180 #endif
00181 
00182 #endif /* RTOP_SPARSE_SUB_VECTOR_H */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines