Reason.hpp
1 // Distributed under the MIT License.
2 // See LICENSE.txt for details.
3 
4 #pragma once
5 
6 #include <iosfwd>
7 
8 namespace Convergence {
9 
10 /*!
11  * \brief The reason the algorithm has converged.
12  *
13  * \see Convergence::Criteria
14  */
15 enum class Reason { MaxIterations, AbsoluteResidual, RelativeResidual };
16 
17 std::ostream& operator<<(std::ostream& os, const Reason& reason) noexcept;
18 
19 } // namespace Convergence
Definition: Criteria.cpp:8