Amesos2_MatrixAdapter_decl.hpp

// @HEADER
//
// ***********************************************************************
//
//           Amesos2: Templated Direct Sparse Solver Package 
//                  Copyright 2011 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//
// @HEADER


#ifndef AMESOS2_MATRIXADAPTER_DECL_HPP
#define AMESOS2_MATRIXADAPTER_DECL_HPP

#include "Amesos2_config.h"

#include <Teuchos_Comm.hpp>
#include <Teuchos_ArrayView.hpp>
#include <Teuchos_VerbosityLevel.hpp>
#include <Teuchos_FancyOStream.hpp>

#include <Tpetra_ConfigDefs.hpp>  // for global_size_t

// #include "Amesos2_ConcreteMatrixAdapter_decl.hpp"
#include "Amesos2_Util.hpp"
#include "Amesos2_MatrixTraits.hpp"

namespace Amesos2 {

  template <class M> class ConcreteMatrixAdapter;
  
  template < class Matrix >
  class MatrixAdapter {

  public:

    typedef typename MatrixTraits<Matrix>::scalar_t                 scalar_t;
    typedef typename MatrixTraits<Matrix>::local_ordinal_t   local_ordinal_t;
    typedef typename MatrixTraits<Matrix>::global_ordinal_t global_ordinal_t;
    typedef typename MatrixTraits<Matrix>::node_t                     node_t;
    typedef Tpetra::global_size_t                              global_size_t;

    typedef Matrix                                                  matrix_t;
    typedef MatrixAdapter<Matrix>                                       type;
    typedef ConcreteMatrixAdapter<Matrix>                          adapter_t;

    typedef typename MatrixTraits<Matrix>::local_matrix_t     local_matrix_t;
    typedef typename MatrixTraits<Matrix>::sparse_ptr_type       spmtx_ptr_t;
    typedef typename MatrixTraits<Matrix>::sparse_idx_type       spmtx_idx_t;
    typedef typename MatrixTraits<Matrix>::sparse_values_type   spmtx_vals_t;

    // template<typename S, typename GO, typename GS, typename Op>
    // friend class Util::get_cxs_helper<MatrixAdapter<Matrix>,S,GO,GS,Op>;
    // template<class M, typename S, typename GO, typename GS, typename Op>
    // friend class Util::get_cxs_helper;

    MatrixAdapter(Teuchos::RCP<Matrix> m);


    void getCrs(const Teuchos::ArrayView<scalar_t> nzval,
    const Teuchos::ArrayView<global_ordinal_t> colind,
    const Teuchos::ArrayView<global_size_t> rowptr,
    global_size_t& nnz,
    const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > rowmap,
    EStorage_Ordering ordering=ARBITRARY,
    EDistribution distribution=ROOTED) const; // This was placed as last argument to preserve API

    void getCrs(const Teuchos::ArrayView<scalar_t> nzval,
    const Teuchos::ArrayView<global_ordinal_t> colind,
    const Teuchos::ArrayView<global_size_t> rowptr,
    global_size_t& nnz,
    EDistribution distribution,
    EStorage_Ordering ordering=ARBITRARY) const;

    void getCcs(const Teuchos::ArrayView<scalar_t> nzval,
    const Teuchos::ArrayView<global_ordinal_t> rowind,
    const Teuchos::ArrayView<global_size_t> colptr,
    global_size_t& nnz,
    const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > colmap,
    EStorage_Ordering ordering=ARBITRARY,
    EDistribution distribution=ROOTED) const; // This was placed as last argument to preserve API

    void getCcs(const Teuchos::ArrayView<scalar_t> nzval,
    const Teuchos::ArrayView<global_ordinal_t> rowind,
    const Teuchos::ArrayView<global_size_t> colptr,
    global_size_t& nnz,
    EDistribution distribution,
    EStorage_Ordering ordering=ARBITRARY) const;


    const Teuchos::RCP<const Teuchos::Comm<int> > getComm() const
    {
      return comm_;
    }

    global_size_t getGlobalNumRows() const;

    global_size_t getGlobalNumCols() const;

    global_size_t getRowIndexBase() const;

    global_size_t getColumnIndexBase() const;

    global_size_t getGlobalNNZ() const;

    size_t getLocalNumRows() const;

    size_t getLocalNumCols() const;

    size_t getLocalNNZ() const;

    Teuchos::RCP<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> >
    getMap() const {
      return static_cast<const adapter_t*>(this)->getMap_impl();
    }

    Teuchos::RCP<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> >
    getRowMap() const {
      return row_map_;
    }

    Teuchos::RCP<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> >
    getColMap() const {
      return col_map_;
    }

    Teuchos::RCP<const type> get(const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > map, EDistribution distribution = ROOTED) const;

    std::string description() const;

    void describe(Teuchos::FancyOStream &out,
      const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const;

    spmtx_ptr_t returnRowPtr() const;

    spmtx_idx_t returnColInd() const;

    spmtx_vals_t returnValues() const;

  private:

    void help_getCrs(const Teuchos::ArrayView<scalar_t> nzval,
         const Teuchos::ArrayView<global_ordinal_t> colind,
         const Teuchos::ArrayView<global_size_t> rowptr,
         global_size_t& nnz,
         const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > rowmap,
         EDistribution distribution,
         EStorage_Ordering ordering,
         has_special_impl hsi) const;

    void help_getCrs(const Teuchos::ArrayView<scalar_t> nzval,
         const Teuchos::ArrayView<global_ordinal_t> colind,
         const Teuchos::ArrayView<global_size_t> rowptr,
         global_size_t& nnz,
         const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > rowmap,
         EDistribution distribution,
         EStorage_Ordering ordering,
         no_special_impl nsi) const;

    void do_getCrs(const Teuchos::ArrayView<scalar_t> nzval,
        const Teuchos::ArrayView<global_ordinal_t> colind,
        const Teuchos::ArrayView<global_size_t> rowptr,
        global_size_t& nnz,
        const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > rowmap,
        EDistribution distribution,
        EStorage_Ordering ordering,
        row_access ra) const;

    void do_getCrs(const Teuchos::ArrayView<scalar_t> nzval,
        const Teuchos::ArrayView<global_ordinal_t> colind,
        const Teuchos::ArrayView<global_size_t> rowptr,
        global_size_t& nnz,
        const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > rowmap,
        EDistribution distribution,
        EStorage_Ordering ordering,
        col_access ca) const;

    void help_getCcs(const Teuchos::ArrayView<scalar_t> nzval,
         const Teuchos::ArrayView<global_ordinal_t> rowind,
         const Teuchos::ArrayView<global_size_t> colptr,
         global_size_t& nnz,
         const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > colmap,
         EDistribution distribution,
         EStorage_Ordering ordering,
         has_special_impl hsi) const;

    void help_getCcs(const Teuchos::ArrayView<scalar_t> nzval,
         const Teuchos::ArrayView<global_ordinal_t> rowind,
         const Teuchos::ArrayView<global_size_t> colptr,
         global_size_t& nnz,
         const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > colmap,
         EDistribution distribution,
         EStorage_Ordering ordering,
         no_special_impl nsi) const;

    void do_getCcs(const Teuchos::ArrayView<scalar_t> nzval,
        const Teuchos::ArrayView<global_ordinal_t> rowind,
        const Teuchos::ArrayView<global_size_t> colptr,
        global_size_t& nnz,
        const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > colmap,
        EDistribution distribution,
        EStorage_Ordering ordering,
        row_access ra) const;

    void do_getCcs(const Teuchos::ArrayView<scalar_t> nzval,
        const Teuchos::ArrayView<global_ordinal_t> rowind,
        const Teuchos::ArrayView<global_size_t> colptr,
        global_size_t& nnz,
        const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > colmap,
        EDistribution distribution,
        EStorage_Ordering ordering,
        col_access ca) const;

  protected:
    // These methods will link to concrete implementations, and may
    // also be used by them

    void getGlobalRowCopy(global_ordinal_t row,
        const Teuchos::ArrayView<global_ordinal_t>& indices,
        const Teuchos::ArrayView<scalar_t>& vals,
        size_t& nnz) const;

    void getGlobalColCopy(global_ordinal_t col,
        const Teuchos::ArrayView<global_ordinal_t>& indices,
        const Teuchos::ArrayView<scalar_t>& vals,
        size_t& nnz) const;

    size_t getMaxRowNNZ() const;

    size_t getMaxColNNZ() const;

    size_t getGlobalRowNNZ(global_ordinal_t row) const;

    size_t getLocalRowNNZ(local_ordinal_t row) const;

    size_t getGlobalColNNZ(global_ordinal_t col) const;

    size_t getLocalColNNZ(local_ordinal_t col) const;

    bool isLocallyIndexed() const;

    bool isGloballyIndexed() const;

  protected:
    const Teuchos::RCP<const Matrix> mat_;

    mutable Teuchos::RCP<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > row_map_;

    mutable Teuchos::RCP<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > col_map_;

    mutable Teuchos::RCP<const Teuchos::Comm<int> > comm_;
  };        // end class MatrixAdapter


  // Factory creation method
  template <class Matrix>
  Teuchos::RCP<MatrixAdapter<Matrix> >
  createMatrixAdapter(Teuchos::RCP<Matrix> m);
    
  template <class Matrix>
  Teuchos::RCP<const MatrixAdapter<Matrix> >
  createConstMatrixAdapter(Teuchos::RCP<const Matrix> m);

} // end namespace Amesos2

#endif  // AMESOS2_MATRIXADAPTER_DECL_HPP