AbstractLinAlgPack_MatrixSymSecant.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_SYM_SECANT_UPDATEABLE_H
00030 #define MATRIX_SYM_SECANT_UPDATEABLE_H
00031 
00032 #include <stdexcept>
00033 
00034 #include "AbstractLinAlgPack_MatrixSymInitDiag.hpp"
00035 
00036 namespace AbstractLinAlgPack {
00037 
00052 class MatrixSymSecant
00053   : virtual public AbstractLinAlgPack::MatrixSymInitDiag // doxygen needs the full name
00054 {
00055 public:
00056 
00058   class UpdateSkippedException : public std::runtime_error
00059   {public: UpdateSkippedException(const std::string& what_arg) : std::runtime_error(what_arg) {}};
00060 
00062   class UpdateFailedException : public std::runtime_error
00063   {public: UpdateFailedException(const std::string& what_arg) : std::runtime_error(what_arg) {}};
00064 
00114   virtual void secant_update(
00115     VectorMutable     *s
00116     ,VectorMutable    *y
00117     ,VectorMutable    *Bs = NULL
00118     ) = 0;
00119   
00120 };  // end class MatrixSymSecant 
00121 
00122 } // end namespace AbstractLinAlgPack 
00123 
00124 #endif  // MATRIX_SYM_SECANT_UPDATEABLE_H

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