AbstractLinAlgPack_MatrixOpGetGMSMutable.hpp

Go to the documentation of this file.

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

#include "AbstractLinAlgPack_MatrixOpGetGMS.hpp"

namespace AbstractLinAlgPack {

class MatrixOpGetGMSMutable : virtual public MatrixOpGetGMS {
public:

  using MatrixOpGetGMS::get_gms_view;

  virtual DMatrixSlice get_gms_view() = 0;

  virtual void commit_gms_view(DMatrixSlice* gms_view) = 0;

}; // end class MatrixOpGetGMSMutable

class MatrixDenseMutableEncap {
public:

  MatrixDenseMutableEncap( MatrixOpGetGMSMutable*  mat_get );
  MatrixDenseMutableEncap( MatrixOp* mat );
  ~MatrixDenseMutableEncap();
  DMatrixSlice operator()();
  const DMatrixSlice operator()() const;

private:

  MatrixOpGetGMSMutable     *mat_get_;
  DMatrixSlice                gms_view_;
  MatrixDenseMutableEncap();                                          // Not defined and not to be called!
  MatrixDenseMutableEncap(const MatrixDenseMutableEncap&);            // ""
  MatrixDenseMutableEncap& operator=(const MatrixDenseMutableEncap&); // ""

}; // end class MatrixDenseMutableEncap

// ///////////////////////////////////////////
// Inline members

// MatrixDenseMutableEncap

inline
MatrixDenseMutableEncap::MatrixDenseMutableEncap( MatrixOpGetGMSMutable*  mat_get )
  :mat_get_(mat_get)
  ,gms_view_(mat_get_->get_gms_view())
{}

inline
MatrixDenseMutableEncap::MatrixDenseMutableEncap( MatrixOp* mat )
  :mat_get_(&Teuchos::dyn_cast<MatrixOpGetGMSMutable>(*mat))
  ,gms_view_(mat_get_->get_gms_view())
{}

inline
MatrixDenseMutableEncap::~MatrixDenseMutableEncap()
{
  mat_get_->commit_gms_view(&gms_view_);
}

inline
DMatrixSlice MatrixDenseMutableEncap::operator()()
{
  return gms_view_;
}

inline
const DMatrixSlice MatrixDenseMutableEncap::operator()() const
{
  return gms_view_;
}

} // end namespace AbstractLinAlgPack

#endif // MATRIX_WITH_OP_GET_GMS_MUTABLE_H