Batch Processing

Algorithm Input

Pivoted QR decomposition accepts the input described below. Pass the Input ID as a parameter to the methods that provide input for your algorithm. For more details, see Algorithms.

Input ID	Input
data	Pointer to the numeric table that represents the `n` x `p` matrix `X` to be factorized. The input can be an object of any class derived from NumericTable.

Algorithm Parameters

Pivoted QR decomposition has the following parameters:

Parameter	Default Value	Description
algorithmFPType	double	The floating-point type that the algorithm uses for intermediate computations. Can be float or double.
method	defaultDense	Performance-oriented computation method, the only method supported by the algorithm.
permutedColumns	NULL	Pointer to the numeric table with the 1 x `p` matrix with the information for the permutation: If the `i`-th element is zero, the `i`-th column of the input matrix is a free column and may be permuted with any other free column during the computation. If the `i`-th element is non-zero, the `i`-th column of the input matrix is moved to the beginning of `XP` before the computation and remains in its place during the computation. By default, this parameter is an object of the HomogenNumericTable class, filled by zeros. However, you can define this parameter as an object of any class derived from NumericTable except the PackedSymmetricMatrix class, CSRNumericTable class, and PackedTriangularMatrix class with the lowerPackedTriangularMatrix layout.

Parameter

Default Value

Description

algorithmFPType

double

The floating-point type that the algorithm uses for intermediate computations. Can be float or double.

method

defaultDense

Performance-oriented computation method, the only method supported by the algorithm.

permutedColumns

NULL

Pointer to the numeric table with the 1 x p matrix with the information for the permutation:

If the i-th element is zero, the i-th column of the input matrix is a free column and may be permuted with any other free column during the computation.
If the i-th element is non-zero, the i-th column of the input matrix is moved to the beginning of XP before the computation and remains in its place during the computation.

By default, this parameter is an object of the HomogenNumericTable class, filled by zeros. However, you can define this parameter as an object of any class derived from NumericTable except the PackedSymmetricMatrix class, CSRNumericTable class, and PackedTriangularMatrix class with the lowerPackedTriangularMatrix layout.

Algorithm Output

Pivoted QR decomposition calculates the results described below. Pass the Result ID as a parameter to the methods that access the results of your algorithm. For more details, see Algorithms.

Result ID	Result
matrixQ	Pointer to the numeric table with the `n` x `p` matrix `Q`1. By default, this result is an object of the HomogenNumericTable class, but you can define the result as an object of any class derived from NumericTable except PackedSymmetricMatrix, PackedTriangularMatrix, and CSRNumericTable.
matrixR	Pointer to the numeric table with the `p` x `p` upper triangular matrix `R`1. By default, this result is an object of the HomogenNumericTable class, but you can define the result as an object of any class derived from NumericTable except the PackedSymmetricMatrix class, CSRNumericTable class, and PackedTriangularMatrix class with the lowerPackedTriangularMatrix layout.
permutationMatrix	Pointer to the numeric table with the 1 x `p` matrix such that permutationMatrix(`i`) = `k` if the column `k` of the full matrix `X` is permuted into the position `i` in `XP`. By default, this result is an object of the HomogenNumericTable class, but you can define the result as an object of any class derived from NumericTable except the PackedSymmetricMatrix class, CSRNumericTable class, and PackedTriangularMatrix class with the lowerPackedTriangularMatrix layout.

Result ID

Result

matrixQ

Pointer to the numeric table with the n x p matrix Q1. By default, this result is an object of the HomogenNumericTable class, but you can define the result as an object of any class derived from NumericTable except PackedSymmetricMatrix, PackedTriangularMatrix, and CSRNumericTable.

matrixR

Pointer to the numeric table with the p x p upper triangular matrix R1. By default, this result is an object of the HomogenNumericTable class, but you can define the result as an object of any class derived from NumericTable except the PackedSymmetricMatrix class, CSRNumericTable class, and PackedTriangularMatrix class with the lowerPackedTriangularMatrix layout.

permutationMatrix

Pointer to the numeric table with the 1 x p matrix such that permutationMatrix(i) = k if the column k of the full matrix X is permuted into the position i in XP.

By default, this result is an object of the HomogenNumericTable class, but you can define the result as an object of any class derived from NumericTable except the PackedSymmetricMatrix class, CSRNumericTable class, and PackedTriangularMatrix class with the lowerPackedTriangularMatrix layout.

Examples

C++: pivoted_qr_batch.cpp

Java*: PivotedQRBatch.java