tesseract/condition_8h_source.html

#ifndef FUSED_ALGORITHMS_CONDITION_H

#define FUSED_ALGORITHMS_CONDITION_H


#include "config.h"

#include "utilities/expected.h"

#include "matrix_traits.h"

#include "algorithms/operations/norms.h"

#include "algorithms/operations/inverse.h"


namespace matrix_algorithms

{


    using matrix_traits::MatrixStatus;


    template <typename T, my_size_t N>


    Expected<T, MatrixStatus> condition(const FusedMatrix<T, N, N> &A)

    {

        static_assert(is_floating_point_v<T>,

                      "condition requires a floating-point scalar type");


        T norm_A = norm1(A);


        auto inv_result = inverse(A);


        if (!inv_result.has_value())

        {

            return Unexpected{inv_result.error()};

        }


        T norm_Ainv = norm1(inv_result.value());


        return norm_A * norm_Ainv;

    }


} // namespace matrix_algorithms


#endif // FUSED_ALGORITHMS_CONDITION_H

Expected
A discriminated union holding either a success value or an error.
Definition expected.h:86

FusedMatrix
Definition fused_matrix.h:12

config.h
Global configuration for the tesseract tensor library.

expected.h
A minimal, STL-free expected/result type for failable operations.

inverse.h
Matrix inverse with compile-time dispatch.

matrix_traits.h
Runtime property descriptors and error codes for matrices.

matrix_algorithms
Definition cholesky.h:52

matrix_algorithms::inverse
Expected< FusedMatrix< T, N, N >, MatrixStatus > inverse(const FusedMatrix< T, N, N > &A)
Compute the inverse of a square matrix.
Definition inverse.h:65

matrix_algorithms::norm1
T norm1(const FusedMatrix< T, N, N > &A)
Compute the 1-norm of a square matrix: max absolute column sum.
Definition norms.h:34

matrix_algorithms::condition
Expected< T, MatrixStatus > condition(const FusedMatrix< T, N, N > &A)
Compute the condition number of A in the 1-norm: cond₁(A) = ‖A‖₁ · ‖A⁻¹‖₁.
Definition condition.h:57

matrix_traits::MatrixStatus
MatrixStatus
Error codes for matrix decomposition and solver algorithms.
Definition matrix_traits.h:33

norms.h
Matrix and vector norms.

Unexpected
Tag type for constructing an Expected in the error state.
Definition expected.h:30

Unexpected::error
E error
The error value.
Definition expected.h:31