solve_info.hpp

Go to the documentation of this file.

#pragma once
 
#include <uni20/core/runtime_precision.hpp>
#include <uni20/core/scalar_concepts.hpp>
#if UNI20_HAS_MPREAL
#include <uni20/core/mpreal.hpp>
#endif
 
#include <cstddef>
#include <optional>
 
namespace uni20::linalg
{
 
enum class SolveStatus
{
  success,
  singular,
  small_pivot,
  nonfinite_input,
  nonfinite_result
};
 
struct SolveInfo
{
    SolveStatus status = SolveStatus::success;
    std::optional<std::size_t> pivot = {};
 
    [[nodiscard]] bool succeeded() const noexcept { return this->status == SolveStatus::success; }
};
 
template <uni20::Real Real> struct SolveOptions
{
    Real relative_pivot_tolerance = Real{};
};
 
} // namespace uni20::linalg