MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
AbstractLinAlgPack_MatrixOpNonsing.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 ALAP_MATRIX_OP_NONSING_HPP
43 #define ALAP_MATRIX_OP_NONSING_HPP
44 
47 
48 namespace AbstractLinAlgPack {
49 
55  : virtual public MatrixOp
56  , virtual public MatrixNonsing
57 {
58 public:
59 
62 
63 #ifndef DOXYGEN_COMPILE
64 
65  typedef Teuchos::RCP<const MatrixOpNonsing> mat_mwons_ptr_t;
67  typedef Teuchos::RCP<MatrixOpNonsing> mat_mwons_mut_ptr_t;
68 #endif
69 
71 
74 
81  virtual mat_mwons_mut_ptr_t clone_mwons();
82 
88  virtual mat_mwons_ptr_t clone_mwons() const;
89 
91 
94 
128  const MatNorm calc_cond_num(
129  EMatNormType requested_norm_type = MAT_NORM_1
130  ,bool allow_replacement = false
131  ) const;
132 
134 
137  mat_mut_ptr_t clone();
140  mat_ptr_t clone() const;
142 
145  mat_mns_mut_ptr_t clone_mns();
148  mat_mns_ptr_t clone_mns() const;
150 
153  { static_cast<MatrixOp*>(this)->operator=(M); return *this; }
154 
155 }; // end class MatrixOpNonsing
156 
157 } // end namespace AbstractLinAlgPack
158 
159 #endif // ALAP_MATRIX_OP_NONSING_HPP
mat_mns_mut_ptr_t clone_mns()
Returns this->clone_mwons().
MatrixOpNonsing & operator=(const MatrixOpNonsing &M)
Calls operator=(MatrixOp&)
const LAPACK_C_Decl::f_int & M
Base class for all matrices that support basic matrix operations.
The induced one norm ||M||1, i.e. max abs col sum.
virtual mat_mwons_mut_ptr_t clone_mwons()
Clone the non-const matrix object (if supported).
const MatNorm calc_cond_num(EMatNormType requested_norm_type=MAT_NORM_1, bool allow_replacement=false) const
Compute an estimate of the condition number of this matrix.
Abstract base class for all nonsingular polymorphic matrices that can be used to compute matrix-vecto...
Abstract base class for all nonsingular polymorphic matrices that can solve for linear system with bu...
mat_mut_ptr_t clone()
Returns this->clone_mwons().