AbstractLinAlgPack_MultiVectorMutableCols.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 SLAP_MULTI_VECTOR_MUTABLE_COlS_H
#define SLAP_MULTI_VECTOR_MUTABLE_COlS_H

#include <vector>

#include "AbstractLinAlgPack_Types.hpp"
#include "AbstractLinAlgPack_MultiVectorMutable.hpp"
#include "AbstractLinAlgPack_VectorSpace.hpp"
#include "AbstractLinAlgPack_VectorMutable.hpp"

namespace AbstractLinAlgPack {

class MultiVectorMutableCols
  : virtual public AbstractLinAlgPack::MultiVectorMutable
{
public:


  MultiVectorMutableCols();

  MultiVectorMutableCols(
    const  Teuchos::RCP<const VectorSpace>   &space_cols
    ,const  Teuchos::RCP<const VectorSpace>  &space_rows
    ,Teuchos::RCP<VectorMutable>       col_vecs[] = NULL
    );
  
  void initialize(
    const  Teuchos::RCP<const VectorSpace>   &space_cols
    ,const  Teuchos::RCP<const VectorSpace>  &space_rows
    ,Teuchos::RCP<VectorMutable>       col_vecs[] = NULL
    );

  void set_uninitialized();



  size_type rows() const;
  size_type cols() const;

  

  const VectorSpace& space_cols() const;
  const VectorSpace& space_rows() const;
  void zero_out();
  void Mt_S( value_type alpha );
  MatrixOp& operator=(const MatrixOp& mwo_rhs);
  mat_mut_ptr_t clone();
  mat_ptr_t clone() const;
  void Vp_StMtV(
    VectorMutable* v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
    , const Vector& v_rhs2, value_type beta) const;
  void Vp_StMtV(
    VectorMutable* v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
    , const SpVectorSlice& sv_rhs2, value_type beta) const;
  bool syrk(
     BLAS_Cpp::Transp M_trans, value_type alpha
    , value_type beta, MatrixSymOp* sym_lhs ) const;


  access_by_t access_by() const;

  vec_mut_ptr_t col(index_type j);
  vec_mut_ptr_t row(index_type i);
  vec_mut_ptr_t diag(int k);
  multi_vec_mut_ptr_t mv_sub_view(const Range1D& row_rng, const Range1D& col_rng);

private:
  
#ifdef DOXYGEN_COMPILE
  const VectorSpace                  *space_cols;
  const VectorSpace                  *space_rows;
  VectorMutable                *column_vectors;
#else
  Teuchos::RCP<const VectorSpace>                  space_cols_;
  Teuchos::RCP<const VectorSpace>                  space_rows_;
  std::vector< Teuchos::RCP<VectorMutable> > col_vecs_;
#endif
  
}; // end class MultiVectorMutableCols

} // end namespace AbstractLinAlgPack

#endif // SLAP_MULTI_VECTOR_MUTABLE_COlS_H