AbstractLinAlgPack_VectorSpaceSubSpace.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

#ifndef VECTOR_SPACE_SUB_SPACE_H
#define VECTOR_SPACE_SUB_SPACE_H

#include "AbstractLinAlgPack_VectorSpace.hpp"

namespace AbstractLinAlgPack {

class VectorSpaceSubSpace : public virtual VectorSpace {
public:

  VectorSpaceSubSpace();

  VectorSpaceSubSpace( const space_ptr_t& full_space, const Range1D& rng );

  void initialize( const space_ptr_t& full_space, const Range1D& rng );

  void set_uninitialized();

  const space_ptr_t& full_space() const;

  const Range1D& rng() const;

  void validate_range( const Range1D& rng ) const;


  bool is_compatible(const VectorSpace& ) const;
  bool is_in_core() const;
  index_type dim() const;
  vec_mut_ptr_t create_member() const;
  space_ptr_t clone() const;
  space_ptr_t sub_space(const Range1D& rng) const;


private:

  space_ptr_t     full_space_;   
  Range1D         rng_;          

}; // end class VectorSpaceSubSpace

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

inline
VectorSpaceSubSpace::VectorSpaceSubSpace()
  : rng_(Range1D::Invalid)
{}

inline
const VectorSpace::space_ptr_t& VectorSpaceSubSpace::full_space() const
{
  return full_space_;
}

inline
const Range1D& VectorSpaceSubSpace::rng() const
{
  return rng_;
}

#ifndef TEUCHOS_DEBUG
inline
void VectorSpaceSubSpace::validate_range(const Range1D&) const
{}
#endif

} // end namespace AbstractLinAlgPack

#endif // VECTOR_SPACE_SUB_SPACE_H