AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AbstractLinAlgPack_MatrixSymSecant.hpp
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_SYM_SECANT_UPDATEABLE_H
43 #define MATRIX_SYM_SECANT_UPDATEABLE_H
44 
45 #include <stdexcept>
46 
47 #include "AbstractLinAlgPack_MatrixSymInitDiag.hpp"
48 
49 namespace AbstractLinAlgPack {
50 
66  : virtual public AbstractLinAlgPack::MatrixSymInitDiag // doxygen needs the full name
67 {
68 public:
69 
71  class UpdateSkippedException : public std::runtime_error
72  {public: UpdateSkippedException(const std::string& what_arg) : std::runtime_error(what_arg) {}};
73 
75  class UpdateFailedException : public std::runtime_error
76  {public: UpdateFailedException(const std::string& what_arg) : std::runtime_error(what_arg) {}};
77 
127  virtual void secant_update(
128  VectorMutable *s
129  ,VectorMutable *y
130  ,VectorMutable *Bs = NULL
131  ) = 0;
132 
133 }; // end class MatrixSymSecant
134 
135 } // end namespace AbstractLinAlgPack
136 
137 #endif // MATRIX_SYM_SECANT_UPDATEABLE_H
Mix-in Interface for setting a matrix to a diagonal {abstract}.
Mix-in interface for all polymorphic symmetric matrices that support secant updating.
Abstract interface for mutable coordinate vectors {abstract}.
virtual void secant_update(VectorMutable *s, VectorMutable *y, VectorMutable *Bs=NULL)=0
Perform a secant update of the matrix.