AbstractLinAlgPack_MultiVector.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.
// 
// 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 ALAP_MULTI_VECTOR_H
#define ALAP_MULTI_VECTOR_H

#include "AbstractLinAlgPack_MatrixOp.hpp"
#include "RTOpPack_RTOpT.hpp"
#include "Teuchos_RCP.hpp"

namespace AbstractLinAlgPack {

enum EApplyBy {
  APPLY_BY_ROW        
  ,APPLY_BY_COL       
};

void apply_op(
  EApplyBy                        apply_by
  ,const RTOpPack::RTOp           &primary_op
  ,const size_t                   num_multi_vecs
  ,const MultiVector*             multi_vecs[]
  ,const size_t                   num_targ_multi_vecs
  ,MultiVectorMutable*            targ_multi_vecs[]
  ,RTOpPack::ReductTarget*        reduct_objs[]         = NULL
  ,const index_type               primary_first_ele     = 1
  ,const index_type               primary_sub_dim       = 0
  ,const index_type               primary_global_offset = 0
  ,const index_type               secondary_first_ele   = 1
  ,const index_type               secondary_sub_dim     = 0
  );

void apply_op(
  EApplyBy                        apply_by
  ,const RTOpPack::RTOp           &primary_op
  ,const RTOpPack::RTOp           &secondary_op
  ,const size_t                   num_multi_vecs
  ,const MultiVector*             multi_vecs[]
  ,const size_t                   num_targ_multi_vecs
  ,MultiVectorMutable*            targ_multi_vecs[]
  ,RTOpPack::ReductTarget         *reduct_obj
  ,const index_type               primary_first_ele     = 1
  ,const index_type               primary_sub_dim       = 0
  ,const index_type               primary_global_offset = 0
  ,const index_type               secondary_first_ele   = 1
  ,const index_type               secondary_sub_dim     = 0
  );

class MultiVector : virtual public MatrixOp {
public:

  using MatrixOp::clone;
  using MatrixOp::Mp_StMtM;

  typedef int  access_by_t;
  enum {
    ROW_ACCESS    = 0x1 
    ,COL_ACCESS   = 0x2 
    ,DIAG_ACCESS  = 0x4 
  };
  typedef Teuchos::RCP<const Vector>         vec_ptr_t;
  typedef Teuchos::RCP<const MultiVector>    multi_vec_ptr_t;


  friend void apply_op(
    EApplyBy                        apply_by
    ,const RTOpPack::RTOp           &primary_op
    ,const size_t                   num_multi_vecs
    ,const MultiVector*             multi_vecs[]
    ,const size_t                   num_targ_multi_vecs
    ,MultiVectorMutable*            targ_multi_vecs[]
    ,RTOpPack::ReductTarget*        reduct_objs[]
    ,const index_type               primary_first_ele
    ,const index_type               primary_sub_dim
    ,const index_type               primary_global_offset
    ,const index_type               secondary_first_ele
    ,const index_type               secondary_sub_dim
    );
  friend void apply_op(
    EApplyBy                        apply_by
    ,const RTOpPack::RTOp           &primary_op
    ,const RTOpPack::RTOp           &secondary_op
    ,const size_t                   num_multi_vecs
    ,const MultiVector*             multi_vecs[]
    ,const size_t                   num_targ_multi_vecs
    ,MultiVectorMutable*            targ_multi_vecs[]
    ,RTOpPack::ReductTarget         *reduct_obj
    ,const index_type               primary_first_ele
    ,const index_type               primary_sub_dim
    ,const index_type               primary_global_offset
    ,const index_type               secondary_first_ele
    ,const index_type               secondary_sub_dim
    );



  virtual multi_vec_ptr_t mv_clone() const;



  virtual access_by_t access_by() const = 0;

  virtual vec_ptr_t col(index_type j) const = 0;
  virtual vec_ptr_t row(index_type i) const = 0;
  virtual vec_ptr_t diag(int k) const = 0;



  virtual multi_vec_ptr_t mv_sub_view(const Range1D& row_rng, const Range1D& col_rng) const;
  
  multi_vec_ptr_t mv_sub_view(
    const index_type& rl, const index_type& ru
    ,const index_type& cl, const index_type& cu
    ) const;


protected:


  virtual void apply_op(
    EApplyBy apply_by, const RTOpPack::RTOp& primary_op
    ,const size_t num_multi_vecs,      const MultiVector*   multi_vecs[]
    ,const size_t num_targ_multi_vecs, MultiVectorMutable*  targ_multi_vecs[]
    ,RTOpPack::ReductTarget* reduct_objs[]
    ,const index_type primary_first_ele,   const index_type primary_sub_dim, const index_type primary_global_offset
    ,const index_type secondary_first_ele, const index_type secondary_sub_dim
    ) const;

  virtual void apply_op(
    EApplyBy apply_by, const RTOpPack::RTOp& primary_op, const RTOpPack::RTOp& secondary_op
    ,const size_t num_multi_vecs,      const MultiVector*   multi_vecs[]
    ,const size_t num_targ_multi_vecs, MultiVectorMutable*  targ_multi_vecs[]
    ,RTOpPack::ReductTarget* reduct_obj
    ,const index_type primary_first_ele, const index_type primary_sub_dim, const index_type primary_global_offset
    ,const index_type secondary_first_ele, const index_type secondary_sub_dim
    ) const;


public:


  mat_ptr_t clone() const;

  mat_ptr_t sub_view(const Range1D& row_rng, const Range1D& col_rng) const;

  bool Mp_StMtM(
    MatrixOp* mwo_lhs, value_type alpha
    ,const MatrixOp& mwo_rhs1, BLAS_Cpp::Transp trans_rhs1
    ,BLAS_Cpp::Transp trans_rhs2
    ,value_type beta
    ) const;

  bool Mp_StMtM(
    MatrixOp* mwo_lhs, value_type alpha
    ,BLAS_Cpp::Transp trans_rhs1
    ,const MatrixOp& mwo_rhs2, BLAS_Cpp::Transp trans_rhs2
    ,value_type beta
    ) const;


private:
  
#ifdef DOXYGEN_COMPILE
  Vector         *rows;
  Vector         *columns;
  Vector         *diagonals;
#endif  

}; // end class MultiVector

// //////////////////////////////////////////////////
// Inlined functions

inline
MultiVector::multi_vec_ptr_t
MultiVector::mv_sub_view(
  const index_type& rl, const index_type& ru
  ,const index_type& cl, const index_type& cu
  ) const
{
  return this->mv_sub_view(Range1D(rl,ru),Range1D(cl,cu));
}

} // end namespace AbstractLinAlgPack

#endif // ALAP_MULTI_VECTOR_H