AbstractLinAlgPack_VectorDenseEncap.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
*/

// /////////////////////////////////////////////////////////////////////
// AbstractLinAlgPack_VectorDenseEncap.hpp

#ifndef SLAP_VECTOR_DENSE_ENCAP_H
#define SLAP_VECTOR_DENSE_ENCAP_H

#include "AbstractLinAlgPack_Types.hpp"
#include "AbstractLinAlgPack_VectorMutable.hpp"
#include "DenseLinAlgPack_DVectorClass.hpp"

namespace AbstractLinAlgPack {

class VectorDenseEncap {
public:

  VectorDenseEncap( const Vector&  vec );
  ~VectorDenseEncap();
  const DVectorSlice& operator()() const;

private:

  const Vector            &vec_;
  RTOpPack::SubVector     sub_vec_;
  DVectorSlice            vs_;
  VectorDenseEncap();                                     // Not defined and not to be called!
  VectorDenseEncap(const VectorDenseEncap&);              // ""
  VectorDenseEncap& operator=(const VectorDenseEncap&);   // ""

}; // end class VectorDenseEncap

class VectorDenseMutableEncap {
public:

  VectorDenseMutableEncap( VectorMutable&  vec );
  ~VectorDenseMutableEncap();
  DVectorSlice& operator()();
  const DVectorSlice& operator()() const;

private:

  VectorMutable                  &vec_;
  RTOpPack::MutableSubVector     sub_vec_;
  DVectorSlice                   vs_;
  VectorDenseMutableEncap();                                            // Not defined and not to be called!
  VectorDenseMutableEncap(const VectorDenseMutableEncap&);              // ""
  VectorDenseMutableEncap& operator=(const VectorDenseMutableEncap&);   // ""

}; // end class VectorDenseMutableEncap

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

// VectorDenseEncap

inline
VectorDenseEncap::VectorDenseEncap( const Vector&  vec )
  :vec_(vec)
{
  vec_.get_sub_vector(Range1D(),&sub_vec_);
  vs_.bind( DVectorSlice(
          const_cast<value_type*>(sub_vec_.values())
          ,sub_vec_.subDim()
          ,sub_vec_.stride()
          )
    );
}

inline
VectorDenseEncap::~VectorDenseEncap()
{
  vec_.free_sub_vector(&sub_vec_);
}

inline
const DVectorSlice& VectorDenseEncap::operator()() const
{
  return vs_;
}

// VectorDenseMutableEncap

inline
VectorDenseMutableEncap::VectorDenseMutableEncap( VectorMutable&  vec )
  :vec_(vec)
{
  vec_.get_sub_vector(Range1D(),&sub_vec_);
  vs_.bind( DVectorSlice(
          sub_vec_.values()
          ,sub_vec_.subDim()
          ,sub_vec_.stride()
          )
    );
}

inline
VectorDenseMutableEncap::~VectorDenseMutableEncap()
{
  vec_.commit_sub_vector(&sub_vec_);
}

inline
DVectorSlice& VectorDenseMutableEncap::operator()()
{
  return vs_;
}

inline
const DVectorSlice& VectorDenseMutableEncap::operator()() const
{
  return vs_;
}

} // end namespace SparseLinALgPack

#endif // SLAP_VECTOR_DENSE_ENCAP_H