fortran-lapack
Loading...
Searching...
No Matches
la_matrix_functions::expm Interface Reference

Compute the exponential of a square matrix. More...

Public Member Functions

pure real(sp) function, dimension(:,:), allocatable la_s_expm_fun (a, order)
 Matrix exponential, function form: pure, stops on error.
 
real(sp) function, dimension(:,:), allocatable la_s_expm_fun_err (a, order, err)
 Matrix exponential, function form with a state return flag.
 
pure real(dp) function, dimension(:,:), allocatable la_d_expm_fun (a, order)
 Matrix exponential, function form: pure, stops on error.
 
real(dp) function, dimension(:,:), allocatable la_d_expm_fun_err (a, order, err)
 Matrix exponential, function form with a state return flag.
 
pure complex(sp) function, dimension(:,:), allocatable la_c_expm_fun (a, order)
 Matrix exponential, function form: pure, stops on error.
 
complex(sp) function, dimension(:,:), allocatable la_c_expm_fun_err (a, order, err)
 Matrix exponential, function form with a state return flag.
 
pure complex(dp) function, dimension(:,:), allocatable la_z_expm_fun (a, order)
 Matrix exponential, function form: pure, stops on error.
 
complex(dp) function, dimension(:,:), allocatable la_z_expm_fun_err (a, order, err)
 Matrix exponential, function form with a state return flag.
 

Detailed Description

Compute the exponential of a square matrix.

This function computes \( E = e^{A} \) for a real or complex square matrix \( A \), by scaling and squaring with a Pade approximant.

Parameters
[in]AThe input square matrix of size \( [n, n] \).
[in]order(Optional) Order of the Pade approximant. Default is 10.
[out]err(Optional) A state return flag. Without it the function is pure, and an error stops execution.
Returns
The matrix exponential \( e^{A} \), of the same kind and size as \( A \).
Note
The function form without err is pure; the form with err is not, because a pure function cannot return an error argument.

Member Function/Subroutine Documentation

◆ la_c_expm_fun()

pure complex(sp) function, dimension(:,:), allocatable la_matrix_functions::expm::la_c_expm_fun ( complex(sp), dimension(:,:), intent(in) a,
integer(ilp), intent(in), optional order )

Matrix exponential, function form: pure, stops on error.

Parameters
[in]aInput matrix a[n,n]
[in]order[optional] Order of the Pade approximant
Returns
Matrix exponential e[n,n]

◆ la_c_expm_fun_err()

complex(sp) function, dimension(:,:), allocatable la_matrix_functions::expm::la_c_expm_fun_err ( complex(sp), dimension(:,:), intent(in) a,
integer(ilp), intent(in), optional order,
type(la_state), intent(out) err )

Matrix exponential, function form with a state return flag.

Parameters
[in]aInput matrix a[n,n]
[in]order[optional] Order of the Pade approximant
[out]errState return flag
Returns
Matrix exponential e[n,n]

◆ la_d_expm_fun()

pure real(dp) function, dimension(:,:), allocatable la_matrix_functions::expm::la_d_expm_fun ( real(dp), dimension(:,:), intent(in) a,
integer(ilp), intent(in), optional order )

Matrix exponential, function form: pure, stops on error.

Parameters
[in]aInput matrix a[n,n]
[in]order[optional] Order of the Pade approximant
Returns
Matrix exponential e[n,n]

◆ la_d_expm_fun_err()

real(dp) function, dimension(:,:), allocatable la_matrix_functions::expm::la_d_expm_fun_err ( real(dp), dimension(:,:), intent(in) a,
integer(ilp), intent(in), optional order,
type(la_state), intent(out) err )

Matrix exponential, function form with a state return flag.

Parameters
[in]aInput matrix a[n,n]
[in]order[optional] Order of the Pade approximant
[out]errState return flag
Returns
Matrix exponential e[n,n]

◆ la_s_expm_fun()

pure real(sp) function, dimension(:,:), allocatable la_matrix_functions::expm::la_s_expm_fun ( real(sp), dimension(:,:), intent(in) a,
integer(ilp), intent(in), optional order )

Matrix exponential, function form: pure, stops on error.

Parameters
[in]aInput matrix a[n,n]
[in]order[optional] Order of the Pade approximant
Returns
Matrix exponential e[n,n]

◆ la_s_expm_fun_err()

real(sp) function, dimension(:,:), allocatable la_matrix_functions::expm::la_s_expm_fun_err ( real(sp), dimension(:,:), intent(in) a,
integer(ilp), intent(in), optional order,
type(la_state), intent(out) err )

Matrix exponential, function form with a state return flag.

Parameters
[in]aInput matrix a[n,n]
[in]order[optional] Order of the Pade approximant
[out]errState return flag
Returns
Matrix exponential e[n,n]

◆ la_z_expm_fun()

pure complex(dp) function, dimension(:,:), allocatable la_matrix_functions::expm::la_z_expm_fun ( complex(dp), dimension(:,:), intent(in) a,
integer(ilp), intent(in), optional order )

Matrix exponential, function form: pure, stops on error.

Parameters
[in]aInput matrix a[n,n]
[in]order[optional] Order of the Pade approximant
Returns
Matrix exponential e[n,n]

◆ la_z_expm_fun_err()

complex(dp) function, dimension(:,:), allocatable la_matrix_functions::expm::la_z_expm_fun_err ( complex(dp), dimension(:,:), intent(in) a,
integer(ilp), intent(in), optional order,
type(la_state), intent(out) err )

Matrix exponential, function form with a state return flag.

Parameters
[in]aInput matrix a[n,n]
[in]order[optional] Order of the Pade approximant
[out]errState return flag
Returns
Matrix exponential e[n,n]

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