RTOp_SparseSubVector.h

/*
// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER
*/

#ifndef RTOP_SPARSE_SUB_VECTOR_H
#define RTOP_SPARSE_SUB_VECTOR_H

#include <stddef.h>

#include "RTOp.h"

#ifdef __cplusplus
extern "C" {
#endif

/* */
struct RTOp_SparseSubVector {
  /* Offset for the sub-vector into the global vector */
  RTOp_index_type                  global_offset;
  /* Dimension of the sub-vector */
  RTOp_index_type                  sub_dim;
  /* Number of nonzero elements (<tt>sub_nz == sub_dim</tt> for dense vectors) */
  RTOp_index_type                  sub_nz;
  /* Array (size min{|<tt>value_stride*sub_nz</tt>|,1}) for the values in the vector */
  const RTOp_value_type            *values;
  /* Stride between elements in <tt>values[]</tt> */
  ptrdiff_t                        values_stride;
  /* */
  const RTOp_index_type            *indices;
  /* Stride between indices in indices[] (sparse vectors only) */
  ptrdiff_t                        indices_stride;
  /* Offset of indices[] into local sub-vector (sparse vectors only) */
  ptrdiff_t                        local_offset;
  /* If <tt>is_sorted == 0</tt> then the vector is not sorted, otherwise it is sorted (sparse vectors only) */
  int                              is_sorted;
};

/* */
void RTOp_sparse_sub_vector(
  RTOp_index_type global_offset, RTOp_index_type sub_dim, RTOp_index_type sub_nz
  ,const RTOp_value_type values[], ptrdiff_t values_stride
  ,const RTOp_index_type indices[], ptrdiff_t indices_stride
  ,ptrdiff_t local_offset, int is_sorted
  ,struct RTOp_SparseSubVector *sub_vec
  );
/* */
void RTOp_sparse_sub_vector_null( struct RTOp_SparseSubVector *sub_vec );

/* */
void RTOp_sparse_sub_vector_from_dense(
  const struct RTOp_SubVector     *sub_vec
  ,struct RTOp_SparseSubVector    *spc_sub_vec
  );

#ifdef __cplusplus
}
#endif

#endif /* RTOP_SPARSE_SUB_VECTOR_H */