MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ConstrainedOptPack_MatrixIdentConcatStd.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef MATRIX_IDENT_CONCAT_STD_H
43 #define MATRIX_IDENT_CONCAT_STD_H
44 
47 #include "Teuchos_RCP.hpp"
48 
49 namespace ConstrainedOptPack {
50 
68 public:
69 
73  enum ETopBottom { TOP, BOTTOM };
77 
118  virtual void initialize(
119  const VectorSpace::space_ptr_t& space_cols
120  ,const VectorSpace::space_ptr_t& space_rows
121  ,ETopBottom top_or_bottom
123  ,const D_ptr_t &D_ptr
125  );
143  virtual void set_uninitialized();
149  virtual const D_ptr_t& D_ptr() const;
151 
155  Range1D D_rng() const;
157  Range1D I_rng() const;
159  value_type alpha() const;
161  const MatrixOp& D() const;
163  BLAS_Cpp::Transp D_trans() const;
165 
169  const VectorSpace& space_cols() const;
171  const VectorSpace& space_rows() const;
176  MatrixOp& operator=(const MatrixOp& m);
178 
179 private:
180 
181 #ifdef DOXYGEN_COMPILE
187 #else
188  VectorSpace::space_ptr_t space_cols_;
189  VectorSpace::space_ptr_t space_rows_;
190  D_ptr_t D_ptr_;
191  Range1D D_rng_;
192  Range1D I_rng_;
193 #endif
196 
197  //
198  void assert_initialized() const;
199 
200 }; // end class MatrixIndentConcatStd
201 
202 } // end namespace ConstrainedOptPack
203 
204 #endif // MATRIX_IDENT_CONCAT_STD_H
const VectorSpace & space_cols() const
MatrixOp & operator=(const MatrixOp &m)
The default just performs a shallow copy and just copies the underlying smart reference counted point...
. One-based subregion index range class.
Concrete implementation class for a matrix vertically concatonated with an identity matrix...
Abstract interface for objects that represent a space for mutable coordinate vectors.
const VectorSpace & space_rows() const
Base class for all matrices that support basic matrix operations.
Matrix class for a matrix vertically concatonated with an identity matrix {abstract}.
AbstractLinAlgPack::value_type value_type
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)
Setup with a matrix object.
virtual const D_ptr_t & D_ptr() const
Return the smart reference counted point to the D matrix.
Transp
TRANS.
virtual void set_uninitialized()
Set the matrix to uninitialized.