generalized_eigenvalues_symmetric_matrix๐
Short description๐
generalized_eigenvalues_symmetric_matrix โ Compute the generalized eigenvalues and optionally generalized
eigenvectors of symmetric input matrices.
Signature๐
generalized_eigenvalues_symmetric_matrix( matrix MatrixAID, matrix MatrixBID, string ComputeEigenvectors, out matrix EigenvaluesID, out matrix EigenvectorsID )
Description๐
The operator generalized_eigenvalues_symmetric_matrix
computes all generalized eigenvalues and, optionally, generalized
eigenvectors of the symmetric matrix MatrixA and the
symmetric positive definite matrix MatrixB. Both
matrices must have identical dimensions. The matrices are
defined by the matrix handles MatrixAID and
MatrixBID. On output, a new matrix Eigenvalues
with the generalized eigenvalues in ascending order and,
optionally, a new matrix
Eigenvectors with the generalized eigenvectors is
created. Each \(j\)th column of the matrix Eigenvectors
contains the related eigenvector to the \(j\)th eigenvalue. The
operator returns the matrix handles EigenvaluesID and
EigenvectorsID of the matrices Eigenvalues and
Eigenvectors. Access to the elements of the matrices is
possible, e.g., with the operator get_full_matrix or
get_sub_matrix.
The computation of generalized eigenvectors can be selected via
ComputeEigenvectors = 'true'. The formula for
the calculation of the result is
with \(\lambda_{j}\) representing the \(j\)th eigenvalue and \(x_{j}\) represents the corresponding eigenvector.
If ComputeEigenvectors = 'false', no generalized
eigenvectors are computed. For this, the matrix handle
EigenvectorsID is invalid.
Example:
ComputeEigenvectors = 'true'
Attention๐
The upper triangular parts of the input matrices MatrixA
and MatrixB must contain the relevant information of the
matrices. The strictly lower triangular parts of the matrices are
not referenced. If the referenced parts of the input matrices
MatrixA or MatrixB are not of the specified
type, an exception is raised.
Execution information๐
Execution information
-
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
-
Multithreading scope: global (may be called from any thread).
-
Processed without parallelization.
Parameters๐
MatrixAID (input_control) matrix โ (handle)
Matrix handle of the symmetric input matrix A.
MatrixBID (input_control) matrix โ (handle)
Matrix handle of the symmetric positive definite input matrix B.
ComputeEigenvectors (input_control) string โ (string)
Computation of the eigenvectors.
Default: 'false'
List of values: 'false', 'true'
EigenvaluesID (output_control) matrix โ (handle)
Matrix handle with the eigenvalues.
EigenvectorsID (output_control) matrix โ (handle)
Matrix handle with the eigenvectors.
Result๐
If the parameters are valid, the operator
generalized_eigenvalues_symmetric_matrix returns the value
2 (H_MSG_TRUE). If necessary, an exception is raised.
Combinations with other operators๐
Combinations
Possible predecessors
Possible successors
get_full_matrix, get_value_matrix
Alternatives
generalized_eigenvalues_general_matrix
See also
References๐
David Poole: โLinear Algebra: A Modern Introductionโ; Thomson; Belmont; 2006.
Gene H. Golub, Charles F. van Loan: โMatrix Computationsโ; The Johns Hopkins University Press; Baltimore and London; 1996.
Module๐
Foundation