AbstractLinAlgPack_Vector.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_VECTOR_HPP
#define ALAP_VECTOR_HPP

#include <iosfwd>

#include "AbstractLinAlgPack_Types.hpp"
#include "RTOpPack_RTOpT.hpp"

namespace AbstractLinAlgPack {

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      = 1
  ,const index_type          sub_dim        = 0
  ,const index_type          global_offset  = 0
  );

class Vector {
public:

  typedef Teuchos::RCP<const Vector>   vec_ptr_t;
  typedef Teuchos::RCP<VectorMutable>  vec_mut_ptr_t;

  friend
  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
    );

  Vector();
  virtual ~Vector() {}


  virtual const VectorSpace& space() const = 0;

protected:

  virtual 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 = 0;


public:


  virtual index_type dim() const;

  virtual index_type nz() const;

  virtual std::ostream& output(
    std::ostream& out, bool print_dim = true, bool newline = true
    ,index_type global_offset = 0
    ) const;

  virtual vec_mut_ptr_t clone() const;

  virtual value_type get_ele(index_type i) const;

  virtual vec_ptr_t sub_view( const Range1D& rng ) const;


  vec_ptr_t sub_view( const index_type& l, const index_type& u ) const;


  virtual value_type norm_1() const;
  virtual value_type norm_2() const;
  virtual value_type norm_inf() const;
  


  virtual value_type inner_product( const Vector& v ) const;



  virtual void get_sub_vector( const Range1D& rng, RTOpPack::SubVector* sub_vec ) const;

  virtual void free_sub_vector( RTOpPack::SubVector* sub_vec ) const;


  virtual void has_changed() const;

protected:


  virtual void finalize_apply_op(
    const size_t num_targ_vecs, VectorMutable** targ_vecs
    ) const;


private:

  mutable index_type  num_nonzeros_;  
  mutable value_type  norm_1_, norm_2_, norm_inf_;  

}; // end class Vector

// ////////////////////////////////////////////////
// Inline functions

inline
Vector::vec_ptr_t
Vector::sub_view( const index_type& l, const index_type& u ) const
{
  return this->sub_view(Range1D(l,u));
}

} // end namespace AbstractLinAlgPack

#endif  // ALAP_VECTOR_HPP