least_squares_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 LeastSquaresStatus
{
  success,
  zero_diagonal,
  small_diagonal,
  nonfinite_input,
  nonfinite_result,
  nonconvergence
};
 
struct LeastSquaresInfo
{
    LeastSquaresStatus status = LeastSquaresStatus::success;
    std::optional<std::size_t> column = {};
    std::optional<std::size_t> unconverged = {};
    [[nodiscard]] bool succeeded() const noexcept { return this->status == LeastSquaresStatus::success; }
};
 
template <Real R> struct LeastSquaresOptions
{
    R relative_diagonal_tolerance = R{};
};
} // namespace uni20::linalg