MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ConstrainedOptPack_MatrixDecompRangeOrthog.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_DECOMP_RANGE_ORTHOG_H
43 #define MATRIX_DECOMP_RANGE_ORTHOG_H
44 
47 
48 namespace ConstrainedOptPack {
49 
68  : public AbstractLinAlgPack::MatrixOpNonsing // full path needed for doxygen
69 {
70 public:
71 
74 #ifndef DOXYGEN_COMPILE
75 
78  typedef Teuchos::RCP<const MatrixOp> D_ptr_t;
81 #endif
82 
83 
86 
94 
97  const C_ptr_t &C_ptr
98  ,const D_ptr_t &D_ptr
99  ,const S_ptr_t &S_ptr
100  );
101 
126  void initialize(
127  const C_ptr_t &C_ptr
128  ,const D_ptr_t &D_ptr
129  ,const S_ptr_t &S_ptr
130  );
131 
142  void set_uninitialized();
143 
145 
148 
150  const C_ptr_t& C_ptr() const;
152  const D_ptr_t& D_ptr() const;
154  const S_ptr_t& S_ptr() const;
155 
157 
160 
162  size_type rows() const;
164  size_type cols() const;
166  const VectorSpace& space_cols() const;
168  const VectorSpace& space_rows() const;
170  std::ostream& output(std::ostream& out) const;
172  void Vp_StMtV(
173  VectorMutable* v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
174  , const Vector& v_rhs2, value_type beta ) const;
175 
177 
180 
182  void V_InvMtV(
183  VectorMutable* v_lhs, BLAS_Cpp::Transp trans_rhs1
184  , const Vector& v_rhs2 ) const;
185 
187 
188 private:
189 
190 #ifdef DOXYGEN_COMPILE
194 #else
195  C_ptr_t C_ptr_;
196  D_ptr_t D_ptr_;
197  S_ptr_t S_ptr_;
198 #endif
199 
200  //
201  void assert_initialized(const char func_name[]) const;
202 
203  // not defined and not to be called
206 
207 }; // end class MatrixDecompRangeOrthog
208 
209 // /////////////////////////////////
210 // Inline members
211 
212 inline
213 const MatrixDecompRangeOrthog::C_ptr_t&
215 {
216  return C_ptr_;
217 }
218 
219 inline
220 const MatrixDecompRangeOrthog::D_ptr_t&
222 {
223  return D_ptr_;
224 }
225 
226 inline
227 const MatrixDecompRangeOrthog::S_ptr_t&
229 {
230  return S_ptr_;
231 }
232 
233 } // end namespace ConstrainedOptPack
234 
235 #endif // MATRIX_DECOMP_RANGE_ORTHOG_H
AbstractLinAlgPack::size_type size_type
Abstract base class for all polymorphic symmetrix nonsingular matrices that can be used to compute ma...
void V_InvMtV(VectorMutable *v_lhs, BLAS_Cpp::Transp trans_rhs1, const Vector &v_rhs2) const
void initialize(const C_ptr_t &C_ptr, const D_ptr_t &D_ptr, const S_ptr_t &S_ptr)
Initialize the matrix object.
MatrixDecompRangeOrthog & operator=(const MatrixDecompRangeOrthog &)
void Vp_StMtV(VectorMutable *v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1, const Vector &v_rhs2, value_type beta) const
std::ostream * out
Base class for all matrices that support basic matrix operations.
Matrix subclass for variable reduction orthogonal matrix R = Gc(:,con_decomp)'*Y. ...
AbstractLinAlgPack::value_type value_type
Abstract base class for all nonsingular polymorphic matrices that can be used to compute matrix-vecto...
Transp
TRANS.