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.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// 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 */