linalg 1.6.1
A linear algebra library that provides a user-friendly interface to several BLAS and LAPACK routines.
Loading...
Searching...
No Matches
linalg_core::rank1_update Interface Reference

Performs the rank-1 update to matrix A such that: \( A = \alpha X Y^T + A \), where \( A \) is an M-by-N matrix, \( \alpha \)is a scalar, \( X \) is an M-element array, and \( Y \) is an N-element array. In the event that \( Y \) is complex, \( Y^H \) is used instead of \( Y^T \). More...

Detailed Description

Performs the rank-1 update to matrix A such that: \( A = \alpha X Y^T + A \), where \( A \) is an M-by-N matrix, \( \alpha \)is a scalar, \( X \) is an M-element array, and \( Y \) is an N-element array. In the event that \( Y \) is complex, \( Y^H \) is used instead of \( Y^T \).

Syntax
subroutine rank1_update(real(real64) alpha, real(real64) x(:), real(real64) y(:), real(real64) a(:,:), class(errors) err)
subroutine rank1_update(complex(real64) alpha, complex(real64) x(:), complex(real64) y(:), complex(real64) a(:,:), class(errors) err)
Parameters
[in]alphaThe scalar multiplier.
[in]xAn M-element array.
[in]yAn N-element array.
[in,out]aOn input, the M-by-N matrix to update. On output, the updated M-by-N matrix.
[in,out]errAn optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling. Possible errors and warning messages that may be encountered are as follows.
  • LA_ARRAY_SIZE_ERROR: Occurs if the size of a does not match with x and y.
Notes
This routine is based upon the BLAS routine DGER or ZGER.

Definition at line 154 of file linalg_core.f90.


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