fortran-lapack
Loading...
Searching...
No Matches
la_determinant::det Interface Reference

Compute the determinant of a rectangular matrix. More...

Public Member Functions

pure real(sp) function la_sdeterminant (a)
 
real(sp) function la_sdeterminant_err (a, overwrite_a, err)
 
pure real(dp) function la_ddeterminant (a)
 
real(dp) function la_ddeterminant_err (a, overwrite_a, err)
 
pure complex(sp) function la_cdeterminant (a)
 
complex(sp) function la_cdeterminant_err (a, overwrite_a, err)
 
pure complex(dp) function la_zdeterminant (a)
 
complex(dp) function la_zdeterminant_err (a, overwrite_a, err)
 

Detailed Description

Compute the determinant of a rectangular matrix.

This function computes the determinant of a real or complex rectangular matrix \( A \). The determinant is calculated using LU factorization.

Without err the function is pure, takes A as intent(in), and stops on error; it is the function behind .det.. With err it returns the error state instead, and can overwrite A.

Parameters
[in,out]AThe input square matrix of size \( [m, n] \). If overwrite_a is true, the contents of A may be modified during computation.
[in]overwrite_a(Optional, with err only) If .true., A may be overwritten and destroyed. Default is .false..
[out]err(Optional) A state return flag. If an error occurs and err is not provided, the function will stop execution.
Returns
The determinant of the matrix \( A \). The result is a real scalar value of the same kind as the input matrix.
Note
This function relies on a matrix factorization approach (e.g., LU decomposition) to compute the determinant efficiently from the getrf backend.
A singular matrix is not an error: its determinant is 0.
Warning
If overwrite_a is enabled, the original contents of A will be lost.

Member Function/Subroutine Documentation

◆ la_cdeterminant()

pure complex(sp) function la_determinant::det::la_cdeterminant ( complex(sp), dimension(:,:), intent(in) a)
Parameters
[in]aInput matrix a[m,n]
Returns
Result: matrix determinant

◆ la_cdeterminant_err()

complex(sp) function la_determinant::det::la_cdeterminant_err ( complex(sp), dimension(:,:), intent(inout), target a,
logical(lk), intent(in), optional overwrite_a,
type(la_state), intent(out) err )
Parameters
[in,out]aInput matrix a[m,n]
[in]overwrite_a[optional] Can A data be overwritten and destroyed?
[out]errState return flag
Returns
Result: matrix determinant
Here is the call graph for this function:

◆ la_ddeterminant()

pure real(dp) function la_determinant::det::la_ddeterminant ( real(dp), dimension(:,:), intent(in) a)
Parameters
[in]aInput matrix a[m,n]
Returns
Result: matrix determinant

◆ la_ddeterminant_err()

real(dp) function la_determinant::det::la_ddeterminant_err ( real(dp), dimension(:,:), intent(inout), target a,
logical(lk), intent(in), optional overwrite_a,
type(la_state), intent(out) err )
Parameters
[in,out]aInput matrix a[m,n]
[in]overwrite_a[optional] Can A data be overwritten and destroyed?
[out]errState return flag
Returns
Result: matrix determinant
Here is the call graph for this function:

◆ la_sdeterminant()

pure real(sp) function la_determinant::det::la_sdeterminant ( real(sp), dimension(:,:), intent(in) a)
Parameters
[in]aInput matrix a[m,n]
Returns
Result: matrix determinant

◆ la_sdeterminant_err()

real(sp) function la_determinant::det::la_sdeterminant_err ( real(sp), dimension(:,:), intent(inout), target a,
logical(lk), intent(in), optional overwrite_a,
type(la_state), intent(out) err )
Parameters
[in,out]aInput matrix a[m,n]
[in]overwrite_a[optional] Can A data be overwritten and destroyed?
[out]errState return flag
Returns
Result: matrix determinant
Here is the call graph for this function:

◆ la_zdeterminant()

pure complex(dp) function la_determinant::det::la_zdeterminant ( complex(dp), dimension(:,:), intent(in) a)
Parameters
[in]aInput matrix a[m,n]
Returns
Result: matrix determinant

◆ la_zdeterminant_err()

complex(dp) function la_determinant::det::la_zdeterminant_err ( complex(dp), dimension(:,:), intent(inout), target a,
logical(lk), intent(in), optional overwrite_a,
type(la_state), intent(out) err )
Parameters
[in,out]aInput matrix a[m,n]
[in]overwrite_a[optional] Can A data be overwritten and destroyed?
[out]errState return flag
Returns
Result: matrix determinant
Here is the call graph for this function:

The documentation for this interface was generated from the following file: