ConstrainedOptPack_MatrixIdentConcatStd.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 MATRIX_IDENT_CONCAT_STD_H
#define MATRIX_IDENT_CONCAT_STD_H

#include "ConstrainedOptPack_MatrixIdentConcat.hpp"
#include "AbstractLinAlgPack_VectorSpace.hpp"
#include "Teuchos_RCP.hpp"

namespace ConstrainedOptPack {

class MatrixIdentConcatStd : public MatrixIdentConcat {
public:

  enum ETopBottom { TOP, BOTTOM };
  typedef Teuchos::RCP<const MatrixOp> D_ptr_t;

  MatrixIdentConcatStd();
  virtual void initialize(
    const VectorSpace::space_ptr_t&    space_cols
    ,const VectorSpace::space_ptr_t&   space_rows
    ,ETopBottom                        top_or_bottom
    ,value_type                        alpha
    ,const D_ptr_t                     &D_ptr
    ,BLAS_Cpp::Transp                  D_trans
    );
  virtual void set_uninitialized();
  virtual const D_ptr_t& D_ptr() const;

  Range1D D_rng() const;
  Range1D I_rng() const;
  value_type alpha() const;
  const MatrixOp& D() const;
  BLAS_Cpp::Transp D_trans() const;

  const VectorSpace& space_cols() const;
  const VectorSpace& space_rows() const;
  MatrixOp& operator=(const MatrixOp& m);

private:

#ifdef DOXYGEN_COMPILE
  AbstractLinAlgPack::VectorSpace    *space_cols;
  AbstractLinAlgPack::VectorSpace    *space_rows;
  AbstractLinAlgPack::MatrixOp   *D;
  RangePack::Range1D                 D_rng;
  RangePack::Range1D                 I_rng;
#else
  VectorSpace::space_ptr_t  space_cols_;
  VectorSpace::space_ptr_t  space_rows_;
  D_ptr_t           D_ptr_;
  Range1D           D_rng_;
  Range1D           I_rng_;
#endif
  value_type        alpha_;
  BLAS_Cpp::Transp  D_trans_;
 
  //
  void assert_initialized() const;

}; // end class MatrixIndentConcatStd

} // end namespace ConstrainedOptPack

#endif // MATRIX_IDENT_CONCAT_STD_H