AbstractLinAlgPack_VectorMutableDense.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 VECTOR_WITH_OP_MUTABLE_DENSE_H
#define VECTOR_WITH_OP_MUTABLE_DENSE_H

#include "AbstractLinAlgPack_VectorSpaceSerial.hpp"
#include "AbstractLinAlgPack_VectorMutable.hpp"
#include "AbstractLinAlgPack_VectorApplyOpSerialBase.hpp"
#include "DenseLinAlgPack_DVectorClass.hpp"
#include "Teuchos_RCP.hpp"
#include "ReleaseResource.hpp"

namespace AbstractLinAlgPack {

class VectorMutableDense
  : virtual public VectorMutable
  , virtual private VectorApplyOpSerialBase
{
public:

  typedef Teuchos::RCP<
    MemMngPack::ReleaseResource>  release_resource_ptr_t;


  VectorMutableDense(
    const size_type                    dim = 0
    );
  VectorMutableDense(
    DVectorSlice                        v
    ,const release_resource_ptr_t&     v_release
    );
  void initialize(
    const size_type                    dim
    );
  void initialize(
    DVectorSlice                        v
    ,const release_resource_ptr_t&     v_release
    );


  
  DVectorSlice set_vec();
  const DVectorSlice get_vec() const;
  const release_resource_ptr_t& vec_release() const;



  const VectorSpace& space() const;
  void apply_op(
    const RTOpPack::RTOp& op
    ,const size_t num_vecs, const Vector* vecs[]
    ,const size_t num_targ_vecs, VectorMutable* targ_vecs[]
    ,RTOpPack::ReductTarget *reduct_obj
    ,const index_type first_ele, const index_type sub_dim, const index_type global_offset
    ) const;
  index_type dim() const;
  value_type get_ele(index_type i) const;
  void get_sub_vector( const Range1D& rng, RTOpPack::SubVector* sub_vec ) const;
  void free_sub_vector( RTOpPack::SubVector* sub_vec ) const;



  VectorMutable& operator=(value_type alpha);
  VectorMutable& operator=(const Vector& v);
  VectorMutable& operator=(const VectorMutable& v);
  void set_ele( index_type i, value_type val );
  vec_mut_ptr_t sub_view( const Range1D& rng );
  void get_sub_vector( const Range1D& rng, RTOpPack::MutableSubVector* sub_vec );
  void commit_sub_vector( RTOpPack::MutableSubVector* sub_vec );
  void set_sub_vector( const RTOpPack::SparseSubVector& sub_vec );
  void Vp_StMtV(
    value_type                       alpha
    ,const GenPermMatrixSlice        &P
    ,BLAS_Cpp::Transp                P_trans
    ,const Vector                    &x
    ,value_type                      beta
    );


  VectorMutableDense* operator&()
  {
    return this;
  }
private:

  // ///////////////////////////////////////
  // Private data members
  
  DVectorSlice              v_;
  release_resource_ptr_t    v_release_;
  VectorSpaceSerial         space_;

  // Not defined and not to be called
  //VectorMutableDense(const VectorMutableDense&);
  VectorMutableDense& operator=(const VectorMutableDense&);

}; // end class VectorMutableDense

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

inline
DVectorSlice
VectorMutableDense::set_vec()
{
  this->has_changed();
  return v_;
}

inline
const DVectorSlice
VectorMutableDense::get_vec() const
{
  return v_;
}

inline
const VectorMutableDense::release_resource_ptr_t&
VectorMutableDense::vec_release() const
{
  return v_release_;
}

} // end namespace AbstractLinAlgPack

#endif // VECTOR_WITH_OP_MUTABLE_DENSE_H