eigenvalues_symmetric_matrix๐
Short description๐
eigenvalues_symmetric_matrix โ Compute the eigenvalues and optionally eigenvectors of a symmetric
matrix.
Signature๐
eigenvalues_symmetric_matrix( matrix MatrixID, string ComputeEigenvectors, out matrix EigenvaluesID, out matrix EigenvectorsID )
Description๐
The operator eigenvalues_symmetric_matrix computes all
eigenvalues and, optionally, eigenvectors of the symmetric
Matrix. The matrix is defined by the matrix handle
MatrixID. On output, a new matrix Eigenvalues
with the eigenvalues in ascending order and, optionally, a new matrix
Eigenvectors with the eigenvectors is created. 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.
The computation of eigenvectors can be selected via
ComputeEigenvectors = 'true' or
ComputeEigenvectors = 'false'.
Example:
ComputeEigenvectors = 'true'
Attention๐
The upper triangular part of the input Matrix must
contain the relevant information of the matrix. The strictly
lower triangular part of the matrix is not referenced. If the
referenced part of the input Matrix is 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๐
MatrixID (input_control) matrix โ (handle)
Matrix handle of the input matrix.
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
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
See also
generalized_eigenvalues_symmetric_matrix, generalized_eigenvalues_general_matrix
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