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

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

Public Member Functions

pure subroutine la_s_expm_inplace (a, order, work, iwork, err)
 Matrix exponential in place: a is overwritten with exp(a)
 
pure subroutine la_s_expm (a, e, order, work, iwork, err)
 Matrix exponential written into a second matrix.
 
pure subroutine la_d_expm_inplace (a, order, work, iwork, err)
 Matrix exponential in place: a is overwritten with exp(a)
 
pure subroutine la_d_expm (a, e, order, work, iwork, err)
 Matrix exponential written into a second matrix.
 
pure subroutine la_c_expm_inplace (a, order, work, iwork, err)
 Matrix exponential in place: a is overwritten with exp(a)
 
pure subroutine la_c_expm (a, e, order, work, iwork, err)
 Matrix exponential written into a second matrix.
 
pure subroutine la_z_expm_inplace (a, order, work, iwork, err)
 Matrix exponential in place: a is overwritten with exp(a)
 
pure subroutine la_z_expm (a, e, order, work, iwork, err)
 Matrix exponential written into a second matrix.
 

Detailed Description

Compute the exponential of a square matrix in a subroutine.

This subroutine computes \( E = e^{A} \) for a real or complex square matrix \( A \), by scaling and squaring with a Pade approximant. It either overwrites \( A \) with its exponential, or writes the exponential into a second matrix \( E \).

Parameters
[in,out]AThe input square matrix of size \( [n, n] \). Without E, it is overwritten with \( e^{A} \).
[out]E(Optional) The output matrix of size \( [n, n] \).
[in]order(Optional) Order of the Pade approximant. Default is 10.
[in,out]work(Optional) Workspace of the same type and kind as \( A \), of size at least the lwork returned by expm_space.
[in,out]iwork(Optional) Integer workspace of size at least the liwork returned by expm_space.
[out]err(Optional) A state return flag. If an error occurs and err is not provided, the subroutine will stop execution.
Note
The subroutine is pure. With both work and iwork present it allocates no work arrays of its own.

Member Function/Subroutine Documentation

◆ la_c_expm()

pure subroutine la_matrix_functions::matrix_exp::la_c_expm ( complex(sp), dimension(:,:), intent(in) a,
complex(sp), dimension(:,:), intent(out) e,
integer(ilp), intent(in), optional order,
complex(sp), dimension(:), intent(inout), optional, target, contiguous work,
integer(ilp), dimension(:), intent(inout), optional, target, contiguous iwork,
type(la_state), intent(out), optional err )

Matrix exponential written into a second matrix.

Parameters
[in]aInput matrix a[n,n]
[out]eOutput matrix exponential e[n,n]
[in]order[optional] Order of the Pade approximant
[in,out]work[optional] Workspace, size to be checked with expm_space
[in,out]iwork[optional] Integer workspace, size to be checked with expm_space
[out]err[optional] State return flag. On error if not requested, the code will stop

◆ la_c_expm_inplace()

pure subroutine la_matrix_functions::matrix_exp::la_c_expm_inplace ( complex(sp), dimension(:,:), intent(inout) a,
integer(ilp), intent(in), optional order,
complex(sp), dimension(:), intent(inout), optional, target, contiguous work,
integer(ilp), dimension(:), intent(inout), optional, target, contiguous iwork,
type(la_state), intent(out), optional err )

Matrix exponential in place: a is overwritten with exp(a)

Parameters
[in,out]aInput matrix a[n,n]; on output, its exponential
[in]order[optional] Order of the Pade approximant
[in,out]work[optional] Workspace, size to be checked with expm_space
[in,out]iwork[optional] Integer workspace, size to be checked with expm_space
[out]err[optional] State return flag. On error if not requested, the code will stop
Here is the call graph for this function:

◆ la_d_expm()

pure subroutine la_matrix_functions::matrix_exp::la_d_expm ( real(dp), dimension(:,:), intent(in) a,
real(dp), dimension(:,:), intent(out) e,
integer(ilp), intent(in), optional order,
real(dp), dimension(:), intent(inout), optional, target, contiguous work,
integer(ilp), dimension(:), intent(inout), optional, target, contiguous iwork,
type(la_state), intent(out), optional err )

Matrix exponential written into a second matrix.

Parameters
[in]aInput matrix a[n,n]
[out]eOutput matrix exponential e[n,n]
[in]order[optional] Order of the Pade approximant
[in,out]work[optional] Workspace, size to be checked with expm_space
[in,out]iwork[optional] Integer workspace, size to be checked with expm_space
[out]err[optional] State return flag. On error if not requested, the code will stop

◆ la_d_expm_inplace()

pure subroutine la_matrix_functions::matrix_exp::la_d_expm_inplace ( real(dp), dimension(:,:), intent(inout) a,
integer(ilp), intent(in), optional order,
real(dp), dimension(:), intent(inout), optional, target, contiguous work,
integer(ilp), dimension(:), intent(inout), optional, target, contiguous iwork,
type(la_state), intent(out), optional err )

Matrix exponential in place: a is overwritten with exp(a)

Parameters
[in,out]aInput matrix a[n,n]; on output, its exponential
[in]order[optional] Order of the Pade approximant
[in,out]work[optional] Workspace, size to be checked with expm_space
[in,out]iwork[optional] Integer workspace, size to be checked with expm_space
[out]err[optional] State return flag. On error if not requested, the code will stop
Here is the call graph for this function:

◆ la_s_expm()

pure subroutine la_matrix_functions::matrix_exp::la_s_expm ( real(sp), dimension(:,:), intent(in) a,
real(sp), dimension(:,:), intent(out) e,
integer(ilp), intent(in), optional order,
real(sp), dimension(:), intent(inout), optional, target, contiguous work,
integer(ilp), dimension(:), intent(inout), optional, target, contiguous iwork,
type(la_state), intent(out), optional err )

Matrix exponential written into a second matrix.

Parameters
[in]aInput matrix a[n,n]
[out]eOutput matrix exponential e[n,n]
[in]order[optional] Order of the Pade approximant
[in,out]work[optional] Workspace, size to be checked with expm_space
[in,out]iwork[optional] Integer workspace, size to be checked with expm_space
[out]err[optional] State return flag. On error if not requested, the code will stop

◆ la_s_expm_inplace()

pure subroutine la_matrix_functions::matrix_exp::la_s_expm_inplace ( real(sp), dimension(:,:), intent(inout) a,
integer(ilp), intent(in), optional order,
real(sp), dimension(:), intent(inout), optional, target, contiguous work,
integer(ilp), dimension(:), intent(inout), optional, target, contiguous iwork,
type(la_state), intent(out), optional err )

Matrix exponential in place: a is overwritten with exp(a)

Parameters
[in,out]aInput matrix a[n,n]; on output, its exponential
[in]order[optional] Order of the Pade approximant
[in,out]work[optional] Workspace, size to be checked with expm_space
[in,out]iwork[optional] Integer workspace, size to be checked with expm_space
[out]err[optional] State return flag. On error if not requested, the code will stop
Here is the call graph for this function:

◆ la_z_expm()

pure subroutine la_matrix_functions::matrix_exp::la_z_expm ( complex(dp), dimension(:,:), intent(in) a,
complex(dp), dimension(:,:), intent(out) e,
integer(ilp), intent(in), optional order,
complex(dp), dimension(:), intent(inout), optional, target, contiguous work,
integer(ilp), dimension(:), intent(inout), optional, target, contiguous iwork,
type(la_state), intent(out), optional err )

Matrix exponential written into a second matrix.

Parameters
[in]aInput matrix a[n,n]
[out]eOutput matrix exponential e[n,n]
[in]order[optional] Order of the Pade approximant
[in,out]work[optional] Workspace, size to be checked with expm_space
[in,out]iwork[optional] Integer workspace, size to be checked with expm_space
[out]err[optional] State return flag. On error if not requested, the code will stop

◆ la_z_expm_inplace()

pure subroutine la_matrix_functions::matrix_exp::la_z_expm_inplace ( complex(dp), dimension(:,:), intent(inout) a,
integer(ilp), intent(in), optional order,
complex(dp), dimension(:), intent(inout), optional, target, contiguous work,
integer(ilp), dimension(:), intent(inout), optional, target, contiguous iwork,
type(la_state), intent(out), optional err )

Matrix exponential in place: a is overwritten with exp(a)

Parameters
[in,out]aInput matrix a[n,n]; on output, its exponential
[in]order[optional] Order of the Pade approximant
[in,out]work[optional] Workspace, size to be checked with expm_space
[in,out]iwork[optional] Integer workspace, size to be checked with expm_space
[out]err[optional] State return flag. On error if not requested, the code will stop
Here is the call graph for this function:

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