AbstractLinAlgPack_MatrixBasisNonbasisStd.hpp

Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef MATRIX_BASIS_NON_BASIS_STD_H
00030 #define MATRIX_BASIS_NON_BASIS_STD_H
00031 
00032 #include "AbstractLinAlgPack_MatrixBasisNonbasis.hpp"
00033 #include "Miref_count_ptr.h"
00034 
00035 namespace AbstractLinAlgPack {
00036 
00043 class MatrixBasisNonbasisStd
00044   : public MatrixBasisNonbasis
00045 {
00046 public:
00047   
00049   typedef Teuchos::RefCountPtr<const MatrixOp>
00050     C_ptr_t;
00052   typedef Teuchos::RefCountPtr<const MatrixFactorized>
00053     C_nonsingular_ptr_t;
00055   typedef Teuchos::RefCountPtr<const MatrixOp>
00056     N_ptr_t;
00057 
00069   MatrixBasisNonbasisStd();
00070 
00104   void initialize( const C_ptr_t& C, const C_nonsingular_ptr_t& C_nonsingular
00105       , const N_ptr_t& N );
00106 
00108   C_ptr_t C_ptr() const {
00109     return C_;
00110   }
00112   C_nonsingular_ptr_t C_nonsingular_ptr() const {
00113     return C_nonsingular_;
00114   }
00116   N_ptr_t N_ptr() const {
00117     return N_;
00118   }
00119 
00120   // /////////////////////////////////////////////////////
00121   // Overridden from Matrix
00122 
00124   size_type rows() const;
00125 
00127   size_type cols() const;
00128 
00129   // //////////////////////////////////////////
00130   // Overridden from MatrixBasisNonbasis
00131 
00133   const MatrixOp& C() const;
00135   const MatrixFactorized& C_nonsingular() const;
00137   const MatrixOp& N() const;
00138 
00139 private:
00140   C_ptr_t               C_;
00141   C_nonsingular_ptr_t   C_nonsingular_;
00142   N_ptr_t               N_;
00143 
00144   // Validate that the matrix is initialized (throws std::logic_error)
00145   void assert_initialized() const;
00146 
00147 };  // end class MatrixBasisNonbasisStd
00148 
00149 } // end namespace AbstractLinAlgPack 
00150 
00151 #endif  // MATRIX_BASIS_NON_BASIS_STD_H

Generated on Thu Sep 18 12:35:11 2008 for MOOCHO (Single Doxygen Collection) by doxygen 1.3.9.1