AbstractLinAlgPack_TestMatrixSymSecant.hpp File Reference

#include <iosfwd>
#include "AbstractLinAlgPack_Types.hpp"

Include dependency graph for AbstractLinAlgPack_TestMatrixSymSecant.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  AbstractLinAlgPack

Functions

bool TestMatrixSymSecant (const MatrixOp &B, const Vector &s, const Vector &y, value_type warning_tol, value_type error_tol, bool print_all_warnings, std::ostream *out, bool trase=true)
 Checks the secant condition B*s = y.


Function Documentation

bool AbstractLinAlgPack::TestMatrixSymSecant const MatrixOp &  B,
const Vector &  s,
const Vector &  y,
value_type  warning_tol,
value_type  error_tol,
bool  print_all_warnings,
std::ostream *  out,
bool  trase = true
 

Checks the secant condition B*s = y.

Call this function after calling B.secant_update(s,y,...).

Returns true if the secant condition satsifies error_tol and false otherwise.

Parameters:
B [in] The matrix object we are testing.
s [in] First secant vector
y [in] Second secant vector
warning_tol [in] Any relative error above warning_tol will be noted and possibly printed.
error_tol [in] Any relative error above error_tol will cause the tests to stop and false to be returned.
print_all_warnings [in] If true then all relative errors greater than warning_tol will be printed.
out [in/out] Stream that output or error messages are sent to follow the tests.
trase [in] If trase==true then tests will be trased and if trase==false then only error messages will be output.

Definition at line 44 of file AbstractLinAlgPack_TestMatrixSymSecant.cpp.


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