AbstractLinAlgPack_VectorSpace.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.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef ALAP_VECTOR_SPACE_HPP
#define ALAP_VECTOR_SPACE_HPP

#include "AbstractLinAlgPack_InnerProduct.hpp"
#include "Teuchos_AbstractFactory.hpp"

namespace AbstractLinAlgPack {

class VectorSpace
  : public Teuchos::AbstractFactory<VectorMutable>
{
public:

  class IncompatibleVectorSpaces : public std::logic_error
  {public: IncompatibleVectorSpaces(const std::string& what_arg) : std::logic_error(what_arg) {}};
  typedef Teuchos::RCP<const InnerProduct>          inner_prod_ptr_t;
  typedef Teuchos::RCP<const VectorSpace>           space_ptr_t;
  typedef Teuchos::RCP<const VectorSpaceFactory>    space_fcty_ptr_t;
  typedef Teuchos::RCP<VectorMutable>               vec_mut_ptr_t;
  typedef Teuchos::RCP<MultiVectorMutable>          multi_vec_mut_ptr_t;



  VectorSpace( const inner_prod_ptr_t& inner_prod = Teuchos::null );

  virtual void inner_prod( const inner_prod_ptr_t& inner_prod );

  virtual const inner_prod_ptr_t inner_prod() const;



  virtual space_ptr_t clone() const = 0;

  virtual bool is_compatible(const VectorSpace& vec_spc ) const = 0;

  virtual index_type dim() const = 0;

  virtual vec_mut_ptr_t create_member() const = 0;



  virtual bool is_in_core() const;

  virtual space_fcty_ptr_t small_vec_spc_fcty() const;

  virtual vec_mut_ptr_t create_member(const value_type& alpha) const;

  virtual multi_vec_mut_ptr_t create_members(size_type num_vecs) const;


  virtual space_ptr_t sub_space(const Range1D& rng) const;

  space_ptr_t sub_space( const index_type il, const index_type iu ) const;

  virtual space_ptr_t space(
    const GenPermMatrixSlice  &P
    ,BLAS_Cpp::Transp         P_trans
    ) const;

  

  obj_ptr_t create() const;


private:
#ifdef DOXYGEN_COMPILE
  const InnerProduct   *inner_prod;
#else
  inner_prod_ptr_t     inner_prod_;
#endif

}; // end class VectorSpace

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

inline
VectorSpace::space_ptr_t
VectorSpace::sub_space( const index_type il, const index_type iu ) const
{
  return this->sub_space(Range1D(il,iu));
}

} // end namespace AbstractLinAlgPack

#endif  // ALAP_VECTOR_SPACE_HPP