LabVIEW Multicore Analysis and Sparse Matrix Toolkit API Reference

Create Random Matrix VI

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

Create Random Matrix VI

Owning Palette: Sparse Linear Algebra VIs

Requires: Multicore Analysis and Sparse Matrix Toolkit

Generates a sparse matrix randomly.

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

Details  

Create Random Matrix (DBL)

distribution specifies the distribution of the elements in Sparse Matrix.

0Uniform (default)—Specifies that the elements in Sparse Matrix are uniformly distributed and whose values are in the range [-1, 1].
1Gaussian—Specifies that the elements in Sparse Matrix are standard Gaussian-distributed.
matrix type specifies the type of sparse matrix to create.

0General (default)—Specifies to create a general sparse matrix.
2Lower Triangular—Specifies to create a lower triangular sparse matrix. The elements on the main diagonal are always created in Sparse Matrix.
3Upper Triangular—Specifies to create an upper triangular sparse matrix. The elements on the main diagonal are always created in Sparse Matrix.
number of rows specifies the number of rows in Sparse Matrix. The number of rows must be positive.
number of columns specifies the number of columns in Sparse Matrix. The number of columns must be positive.
density specifies the density of elements in Sparse Matrix. The number of elements in Sparse Matrix equals to density*number of rows*number of columns. The density must range from 0 to 1. The default is 0.01.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
seed specifies how this VI generates the sparse matrix randomly. If seed is greater than 0, LabVIEW uses seed to generate the internal state directly. If seed is less than or equal to 0, LabVIEW uses a random number to generate the internal state. The default is -1.
Sparse Matrix returns the randomly created sparse matrix.
error out contains error information. This output provides standard error out functionality.

Create Random Matrix (SGL)

distribution specifies the distribution of the elements in Sparse Matrix.

0Uniform (default)—Specifies that the elements in Sparse Matrix are uniformly distributed and whose values are in the range [-1, 1].
1Gaussian—Specifies that the elements in Sparse Matrix are standard Gaussian-distributed.
matrix type specifies the type of sparse matrix to create.

0General (default)—Specifies to create a general sparse matrix.
2Lower Triangular—Specifies to create a lower triangular sparse matrix. The elements on the main diagonal are always created in Sparse Matrix.
3Upper Triangular—Specifies to create an upper triangular sparse matrix. The elements on the main diagonal are always created in Sparse Matrix.
number of rows specifies the number of rows in Sparse Matrix. The number of rows must be positive.
number of columns specifies the number of columns in Sparse Matrix. The number of columns must be positive.
density specifies the density of elements in Sparse Matrix. The number of elements in Sparse Matrix equals to density*number of rows*number of columns. The density must range from 0 to 1. The default is 0.01.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
seed specifies how this VI generates the sparse matrix randomly. If seed is greater than 0, LabVIEW uses seed to generate the internal state directly. If seed is less than or equal to 0, LabVIEW uses a random number to generate the internal state. The default is -1.
Sparse Matrix returns the randomly created sparse matrix.
error out contains error information. This output provides standard error out functionality.

Create Random Matrix (CDB)

distribution specifies the distribution of the elements in Sparse Matrix.

0Uniform (default)—Specifies that the elements in Sparse Matrix are uniformly distributed and whose values are in the range [-1, 1].
1Gaussian—Specifies that the elements in Sparse Matrix are standard Gaussian-distributed.
matrix type specifies the type of sparse matrix to create.

0General (default)—Specifies to create a general sparse matrix.
2Lower Triangular—Specifies to create a lower triangular sparse matrix. The elements on the main diagonal are always created in Sparse Matrix.
3Upper Triangular—Specifies to create an upper triangular sparse matrix. The elements on the main diagonal are always created in Sparse Matrix.
number of rows specifies the number of rows in Sparse Matrix. The number of rows must be positive.
number of columns specifies the number of columns in Sparse Matrix. The number of columns must be positive.
density specifies the density of elements in Sparse Matrix. The number of elements in Sparse Matrix equals to density*number of rows*number of columns. The density must range from 0 to 1. The default is 0.01.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
seed specifies how this VI generates the sparse matrix randomly. If seed is greater than 0, LabVIEW uses seed to generate the internal state directly. If seed is less than or equal to 0, LabVIEW uses a random number to generate the internal state. The default is -1.
Sparse Matrix returns the randomly created sparse matrix.
error out contains error information. This output provides standard error out functionality.

Create Random Matrix (CSG)

distribution specifies the distribution of the elements in Sparse Matrix.

0Uniform (default)—Specifies that the elements in Sparse Matrix are uniformly distributed and whose values are in the range [-1, 1].
1Gaussian—Specifies that the elements in Sparse Matrix are standard Gaussian-distributed.
matrix type specifies the type of sparse matrix to create.

0General (default)—Specifies to create a general sparse matrix.
2Lower Triangular—Specifies to create a lower triangular sparse matrix. The elements on the main diagonal are always created in Sparse Matrix.
3Upper Triangular—Specifies to create an upper triangular sparse matrix. The elements on the main diagonal are always created in Sparse Matrix.
number of rows specifies the number of rows in Sparse Matrix. The number of rows must be positive.
number of columns specifies the number of columns in Sparse Matrix. The number of columns must be positive.
density specifies the density of elements in Sparse Matrix. The number of elements in Sparse Matrix equals to density*number of rows*number of columns. The density must range from 0 to 1. The default is 0.01.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
seed specifies how this VI generates the sparse matrix randomly. If seed is greater than 0, LabVIEW uses seed to generate the internal state directly. If seed is less than or equal to 0, LabVIEW uses a random number to generate the internal state. The default is -1.
Sparse Matrix returns the randomly created sparse matrix.
error out contains error information. This output provides standard error out functionality.

Create Random 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