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.
// 
// 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_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