ormtr_scratchpad_size

Computes size of scratchpad memory required for ormtr function.

ormtr_scratchpad_size supports the following precisions.

T

float

double

Description

Computes the number of elements of type T the scratchpad memory to be passed to ormtr function should be able to hold. Calls to this routine must specify the template parameter explicitly.

ormtr_scratchpad_size

Syntax

template<typename T>
std::int64_t onemkl::lapack::ormtr_scratchpad_size(cl::sycl::queue &queue, onemkl::side left_right, onemkl::uplo upper_lower, onemkl::transpose trans, std::int64_t m, std::int64_t n, std::int64_t lda, std::int64_t ldc)

Input Parameters

In the descriptions below, r denotes the order of Q:

r = m

if left_right = side::left

r = n

if left_right = side::right
queue

Device queue where calculations by ormtr function will be performed.

left_right

Must be either side::left or side::right.

If left_right = side::left, Q or QT is applied to C from the left.

If left_right = side::right, Q or QT is applied to C from the right.

upper_lower

Must be either uplo::upper or uplo::lower. Uses the same upper_lower as supplied to sytrd.

trans

Must be either transpose::nontrans or transpose::trans.

If trans = transpose::nontrans, the routine multiplies C by Q.

If trans = transpose::trans, the routine multiplies C by QT.

m

The number of rows in the matrix C(m ≥ 0).

n

The number of rows in the matrix C(n ≥ 0).

lda

The leading dimension of a(max(1, r) ≤ lda).

ldc

The leading dimension of c(max(1, n) ≤ ldc).

Throws

onemkl::lapack::exception

Exception is thrown in case of incorrect argument value is supplied. Position of wrong argument can be determined by get_info() method of exception object.

Return Value

The number of elements of type T the scratchpad memory to be passed to ormtr function should be able to hold.

Parent topic: LAPACK Singular Value and Eigenvalue Problem Routines