LabVIEW Multicore Analysis and Sparse Matrix Toolkit API Reference

Write to Matrix Market File VI

  • Updated2023-02-21
  • 7 minute(s) read

Write to Matrix Market File VI

Owning Palette: File I/O VIs

Requires: Multicore Analysis and Sparse Matrix Toolkit

Writes a matrix into a file in the Matrix Market exchange format.

You must manually select the polymorphic instance you want to use.

Details  Example

Write Sparse to Matrix Market (DBL)

pattern only? specifies whether to write sparsity pattern, the row indices and column indices of elements, into Matrix Market file. The default is to write both pattern and elements.
Matrix Market file specifies an absolute path to a file into which you want to write the matrix. The file can be a new file or an existing file. If the file exists, you must confirm whether to overwrite the existing file.
Sparse Matrix specifies the matrix to write into Matrix Market file. This input must be a square matrix if matrix type is Symmetric, Skew-symmetric, or Hermitian.
matrix type specifies the matrix type and how to write matrix elements into Matrix Market file.

0General (default)—The matrix is a general matrix. All elements write into the file.
1Symmetric—The matrix is a symmetric matrix. Only elements in the lower triangular part of the matrix write into the file.
2Skew-symmetric—The matrix is a skew-symmetric matrix. Only elements in the strict lower triangular part of the matrix write into the file.
3Hermitian—The matrix is a Hermitian matrix. Only elements in the lower triangular part write into the file. This matrix type applies only to complex matrices.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
description specifies the description of the matrix to write into Matrix Market file.
Matrix Market file out returns Matrix Market file.
error out contains error information. This output provides standard error out functionality.

Write Sparse to Matrix Market (CDB)

pattern only? specifies whether to write sparsity pattern, the row indices and column indices of elements, into Matrix Market file. The default is to write both pattern and elements.
Matrix Market file specifies an absolute path to a file into which you want to write the matrix. The file can be a new file or an existing file. If the file exists, you must confirm whether to overwrite the existing file.
Sparse Matrix specifies the matrix to write into Matrix Market file. This input must be a square matrix if matrix type is Symmetric, Skew-symmetric, or Hermitian.
matrix type specifies the matrix type and how to write matrix elements into Matrix Market file.

0General (default)—The matrix is a general matrix. All elements write into the file.
1Symmetric—The matrix is a symmetric matrix. Only elements in the lower triangular part of the matrix write into the file.
2Skew-symmetric—The matrix is a skew-symmetric matrix. Only elements in the strict lower triangular part of the matrix write into the file.
3Hermitian—The matrix is a Hermitian matrix. Only elements in the lower triangular part write into the file. This matrix type applies only to complex matrices.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
description specifies the description of the matrix to write into Matrix Market file.
Matrix Market file out returns Matrix Market file.
error out contains error information. This output provides standard error out functionality.

Write Dense to Matrix Market (DBL)

Matrix Market file specifies an absolute path to a file into which you want to write the matrix. The file can be a new file or an existing file. If the file exists, you must confirm whether to overwrite the existing file.
Dense Matrix specifies the matrix to write into Matrix Market file. This input must be a square matrix if matrix type is Symmetric, Skew-symmetric, or Hermitian.
matrix type specifies the matrix type and how to write matrix elements into Matrix Market file.

0General (default)—The matrix is a general matrix. All elements write into the file.
1Symmetric—The matrix is a symmetric matrix. Only elements in the lower triangular part of the matrix write into the file.
2Skew-symmetric—The matrix is a skew-symmetric matrix. Only elements in the strict lower triangular part of the matrix write into the file.
3Hermitian—The matrix is a Hermitian matrix. Only elements in the lower triangular part write into the file. This matrix type applies only to complex matrices.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
description specifies the description of the matrix to write into Matrix Market file.
Matrix Market file out returns Matrix Market file.
error out contains error information. This output provides standard error out functionality.

Write Dense to Matrix Market (CDB)

Matrix Market file specifies an absolute path to a file into which you want to write the matrix. The file can be a new file or an existing file. If the file exists, you must confirm whether to overwrite the existing file.
Dense Matrix specifies the matrix to write into Matrix Market file. This input must be a square matrix if matrix type is Symmetric, Skew-symmetric, or Hermitian.
matrix type specifies the matrix type and how to write matrix elements into Matrix Market file.

0General (default)—The matrix is a general matrix. All elements write into the file.
1Symmetric—The matrix is a symmetric matrix. Only elements in the lower triangular part of the matrix write into the file.
2Skew-symmetric—The matrix is a skew-symmetric matrix. Only elements in the strict lower triangular part of the matrix write into the file.
3Hermitian—The matrix is a Hermitian matrix. Only elements in the lower triangular part write into the file. This matrix type applies only to complex matrices.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
description specifies the description of the matrix to write into Matrix Market file.
Matrix Market file out returns Matrix Market file.
error out contains error information. This output provides standard error out functionality.

Write to Matrix Market File Details

The following table lists the support characteristics of this VI.

Supported on RT targets Yes
Suitable for bounded execution times on RT No

Example

Refer to the Write Matrix to Matrix Market File VI in the labview\examples\Multicore Analysis and Sparse Matrix\Sparse Matrix directory for an example of using the Write to Matrix Market File VI.