AbstractLinAlgPack_MatrixSymSecant.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef MATRIX_SYM_SECANT_UPDATEABLE_H
#define MATRIX_SYM_SECANT_UPDATEABLE_H

#include <stdexcept>

#include "AbstractLinAlgPack_MatrixSymInitDiag.hpp"

namespace AbstractLinAlgPack {

class MatrixSymSecant
  : virtual public AbstractLinAlgPack::MatrixSymInitDiag // doxygen needs the full name
{
public:

  class UpdateSkippedException : public std::runtime_error
  {public: UpdateSkippedException(const std::string& what_arg) : std::runtime_error(what_arg) {}};

  class UpdateFailedException : public std::runtime_error
  {public: UpdateFailedException(const std::string& what_arg) : std::runtime_error(what_arg) {}};

  virtual void secant_update(
    VectorMutable     *s
    ,VectorMutable    *y
    ,VectorMutable    *Bs = NULL
    ) = 0;
  
};  // end class MatrixSymSecant 

} // end namespace AbstractLinAlgPack 

#endif  // MATRIX_SYM_SECANT_UPDATEABLE_H