LabVIEW Multicore Analysis and Sparse Matrix Toolkit API Reference

Create Special Matrix VI

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

Create Special Matrix VI

Owning Palette: Sparse Linear Algebra VIs

Requires: Multicore Analysis and Sparse Matrix Toolkit

Creates a sparse matrix of a specific type.

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

Details  

Create Special Matrix (DBL)

matrix type specifies the type of sparse matrix to create.

0Identity (default)—Specifies to create an identity sparse matrix.
1Diagonal—Specifies to create a diagonal sparse matrix.
matrix size specifies the dimension size of Sparse Matrix. LabVIEW does not use matrix size if matrix type is Diagonal. If matrix type is Identity, matrix size must be positive. The default is 1.
Input Vector specifies the input to construct the main diagonal in Sparse Matrix. LabVIEW does not use Input Vector if matrix type is Identity. The Input Vector must not be empty if matrix type is Diagonal.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
max number of nonzeros specifies the maximum number of nonzeros in Sparse Matrix. If max number of nonzeros is negative, LabVIEW determines the number automatically. The default is -1.
Sparse Matrix returns the sparse matrix of a specific matrix type that this VI creates.
error out contains error information. This output provides standard error out functionality.

Create Special Matrix (SGL)

matrix type specifies the type of sparse matrix to create.

0Identity (default)—Specifies to create an identity sparse matrix.
1Diagonal—Specifies to create a diagonal sparse matrix.
matrix size specifies the dimension size of Sparse Matrix. LabVIEW does not use matrix size if matrix type is Diagonal. If matrix type is Identity, matrix size must be positive. The default is 1.
Input Vector specifies the input to construct the main diagonal in Sparse Matrix. LabVIEW does not use Input Vector if matrix type is Identity. The Input Vector must not be empty if matrix type is Diagonal.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
max number of nonzeros specifies the maximum number of nonzeros in Sparse Matrix. If max number of nonzeros is negative, LabVIEW determines the number automatically. The default is -1.
Sparse Matrix returns the sparse matrix of a specific matrix type that this VI creates.
error out contains error information. This output provides standard error out functionality.

Create Special Matrix (CDB)

matrix type specifies the type of sparse matrix to create.

0Identity (default)—Specifies to create an identity sparse matrix.
1Diagonal—Specifies to create a diagonal sparse matrix.
matrix size specifies the dimension size of Sparse Matrix. LabVIEW does not use matrix size if matrix type is Diagonal. If matrix type is Identity, matrix size must be positive. The default is 1.
Input Vector specifies the input to construct the main diagonal in Sparse Matrix. LabVIEW does not use Input Vector if matrix type is Identity. The Input Vector must not be empty if matrix type is Diagonal.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
max number of nonzeros specifies the maximum number of nonzeros in Sparse Matrix. If max number of nonzeros is negative, LabVIEW determines the number automatically. The default is -1.
Sparse Matrix returns the sparse matrix of a specific matrix type that this VI creates.
error out contains error information. This output provides standard error out functionality.

Create Special Matrix (CSG)

matrix type specifies the type of sparse matrix to create.

0Identity (default)—Specifies to create an identity sparse matrix.
1Diagonal—Specifies to create a diagonal sparse matrix.
matrix size specifies the dimension size of Sparse Matrix. LabVIEW does not use matrix size if matrix type is Diagonal. If matrix type is Identity, matrix size must be positive. The default is 1.
Input Vector specifies the input to construct the main diagonal in Sparse Matrix. LabVIEW does not use Input Vector if matrix type is Identity. The Input Vector must not be empty if matrix type is Diagonal.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
max number of nonzeros specifies the maximum number of nonzeros in Sparse Matrix. If max number of nonzeros is negative, LabVIEW determines the number automatically. The default is -1.
Sparse Matrix returns the sparse matrix of a specific matrix type that this VI creates.
error out contains error information. This output provides standard error out functionality.

Create Special Matrix Details

The following table lists the support characteristics of this VI.

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

Log in to get a better experience