AbstractLinAlgPack_MatrixConvertToSparse.hpp

// @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 MATRIX_CONVERT_TO_SPARSE_H
#define MATRIX_CONVERT_TO_SPARSE_H

#include "AbstractLinAlgPack_Types.hpp"
#include "AbstractLinAlgPack_MatrixBase.hpp"

namespace AbstractLinAlgPack {

class MatrixConvertToSparse
  : virtual public AbstractLinAlgPack::MatrixBase // doxygen needs full path
{
public:

  enum EExtractRegion {
    EXTRACT_FULL_MATRIX       
    ,EXTRACT_UPPER_TRIANGULAR 
    ,EXTRACT_LOWER_TRIANGULAR 
  };
  enum EElementUniqueness {
    ELEMENTS_FORCE_UNIQUE             
    ,ELEMENTS_ALLOW_DUPLICATES_SUM    
  };

  virtual index_type num_nonzeros(
    EExtractRegion        extract_region
    ,EElementUniqueness   element_uniqueness
    ) const = 0;

  virtual void coor_extract_nonzeros(
    EExtractRegion                extract_region
    ,EElementUniqueness           element_uniqueness
    ,const index_type             len_Aval
    ,value_type                   Aval[]
    ,const index_type             len_Aij
    ,index_type                   Arow[]
    ,index_type                   Acol[]
    ,const index_type             row_offset = 0
    ,const index_type             col_offset = 0
    ) const = 0;
  
  // Todo: Include extraction routines for Compressed Row (Column) when needed.

};  // end class MatrixConvertToSparse

} // end namespace AbstractLinAlgPack 

#endif  // MATRIX_CONVERT_TO_SPARSE_H