/* **************************************************************************
 * Copyright (C) 2019-2022 Advanced Micro Devices, Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * *************************************************************************/

#include "roclapack_gesvdj_notransv.hpp"

/*
 * ===========================================================================
 *    gesvdj_notransv is not intended for inclusion in the public API. It
 *    exists to provide a gesvdj method with a signature identical to
 *    the cuSOLVER implementation, for use exclusively in hipSOLVER.
 * ===========================================================================
 */

template <typename T, typename SS, typename W>
rocblas_status rocsolver_gesvdj_notransv_strided_batched_impl(rocblas_handle handle,
                                                              const rocblas_svect left_svect,
                                                              const rocblas_svect right_svect,
                                                              const rocblas_int m,
                                                              const rocblas_int n,
                                                              W A,
                                                              const rocblas_int lda,
                                                              const rocblas_stride strideA,
                                                              const SS abstol,
                                                              SS* residual,
                                                              const rocblas_int max_sweeps,
                                                              rocblas_int* n_sweeps,
                                                              SS* S,
                                                              const rocblas_stride strideS,
                                                              T* U,
                                                              const rocblas_int ldu,
                                                              const rocblas_stride strideU,
                                                              T* V,
                                                              const rocblas_int ldv,
                                                              const rocblas_stride strideV,
                                                              rocblas_int* info,
                                                              const rocblas_int batch_count)
{
    ROCSOLVER_ENTER_TOP("gesvdj_notransv_strided_batched", "--left_svect", left_svect,
                        "--right_svect", right_svect, "-m", m, "-n", n, "--lda", lda, "--strideA",
                        strideA, "--abstol", abstol, "--max_sweeps", max_sweeps, "--strideS",
                        strideS, "--ldu", ldu, "--strideU", strideU, "--ldv", ldv, "--strideV",
                        strideV, "--batch_count", batch_count);

    if(!handle)
        return rocblas_status_invalid_handle;

    // argument checking
    rocblas_status st = rocsolver_gesvdj_notransv_argCheck(handle, left_svect, right_svect, m, n, A,
                                                           lda, residual, max_sweeps, n_sweeps, S,
                                                           U, ldu, V, ldv, info, batch_count);
    if(st != rocblas_status_continue)
        return st;

    // working with unshifted arrays
    rocblas_int shiftA = 0;

    // memory workspace sizes:
    // size for constants in rocblas calls
    size_t size_scalars;
    // size for temporary matrix storage
    size_t size_VUtmp;
    // extra requirements for calling SYEVJ/HEEVJ, GEQRF, ORGQR/UNGQR, GELQF, ORGLQ/UNGLQ
    size_t size_work1_UVtmp, size_work2, size_work3, size_work4, size_work5_ipiv, size_work6_workArr;

    rocsolver_gesvdj_notransv_getMemorySize<false, T, SS>(
        left_svect, right_svect, m, n, batch_count, &size_scalars, &size_VUtmp, &size_work1_UVtmp,
        &size_work2, &size_work3, &size_work4, &size_work5_ipiv, &size_work6_workArr);

    if(rocblas_is_device_memory_size_query(handle))
        return rocblas_set_optimal_device_memory_size(
            handle, size_scalars, size_VUtmp, size_work1_UVtmp, size_work2, size_work3, size_work4,
            size_work5_ipiv, size_work6_workArr);

    // memory workspace allocation
    void *scalars, *VUtmp, *work1_UVtmp, *work2, *work3, *work4, *work5_ipiv, *work6_workArr;
    rocblas_device_malloc mem(handle, size_scalars, size_VUtmp, size_work1_UVtmp, size_work2,
                              size_work3, size_work4, size_work5_ipiv, size_work6_workArr);

    if(!mem)
        return rocblas_status_memory_error;

    scalars = mem[0];
    VUtmp = mem[1];
    work1_UVtmp = mem[2];
    work2 = mem[3];
    work3 = mem[4];
    work4 = mem[5];
    work5_ipiv = mem[6];
    work6_workArr = mem[7];
    if(size_scalars > 0)
        init_scalars(handle, (T*)scalars);

    // execution
    return rocsolver_gesvdj_notransv_template<false, true, T>(
        handle, left_svect, right_svect, m, n, A, shiftA, lda, strideA, abstol, residual,
        max_sweeps, n_sweeps, S, strideS, U, ldu, strideU, V, ldv, strideV, info, batch_count,
        (T*)scalars, (T*)VUtmp, work1_UVtmp, work2, work3, work4, work5_ipiv, work6_workArr);
}

/*
 * ===========================================================================
 *    C wrapper
 * ===========================================================================
 */

extern "C" {

ROCSOLVER_EXPORT rocblas_status
    rocsolver_sgesvdj_notransv_strided_batched(rocblas_handle handle,
                                               const rocblas_svect left_svect,
                                               const rocblas_svect right_svect,
                                               const rocblas_int m,
                                               const rocblas_int n,
                                               float* A,
                                               const rocblas_int lda,
                                               const rocblas_stride strideA,
                                               const float abstol,
                                               float* residual,
                                               const rocblas_int max_sweeps,
                                               rocblas_int* n_sweeps,
                                               float* S,
                                               const rocblas_stride strideS,
                                               float* U,
                                               const rocblas_int ldu,
                                               const rocblas_stride strideU,
                                               float* V,
                                               const rocblas_int ldv,
                                               const rocblas_stride strideV,
                                               rocblas_int* info,
                                               const rocblas_int batch_count)
{
    return rocsolver_gesvdj_notransv_strided_batched_impl<float>(
        handle, left_svect, right_svect, m, n, A, lda, strideA, abstol, residual, max_sweeps,
        n_sweeps, S, strideS, U, ldu, strideU, V, ldv, strideV, info, batch_count);
}

ROCSOLVER_EXPORT rocblas_status
    rocsolver_dgesvdj_notransv_strided_batched(rocblas_handle handle,
                                               const rocblas_svect left_svect,
                                               const rocblas_svect right_svect,
                                               const rocblas_int m,
                                               const rocblas_int n,
                                               double* A,
                                               const rocblas_int lda,
                                               const rocblas_stride strideA,
                                               const double abstol,
                                               double* residual,
                                               const rocblas_int max_sweeps,
                                               rocblas_int* n_sweeps,
                                               double* S,
                                               const rocblas_stride strideS,
                                               double* U,
                                               const rocblas_int ldu,
                                               const rocblas_stride strideU,
                                               double* V,
                                               const rocblas_int ldv,
                                               const rocblas_stride strideV,
                                               rocblas_int* info,
                                               const rocblas_int batch_count)
{
    return rocsolver_gesvdj_notransv_strided_batched_impl<double>(
        handle, left_svect, right_svect, m, n, A, lda, strideA, abstol, residual, max_sweeps,
        n_sweeps, S, strideS, U, ldu, strideU, V, ldv, strideV, info, batch_count);
}

ROCSOLVER_EXPORT rocblas_status
    rocsolver_cgesvdj_notransv_strided_batched(rocblas_handle handle,
                                               const rocblas_svect left_svect,
                                               const rocblas_svect right_svect,
                                               const rocblas_int m,
                                               const rocblas_int n,
                                               rocblas_float_complex* A,
                                               const rocblas_int lda,
                                               const rocblas_stride strideA,
                                               const float abstol,
                                               float* residual,
                                               const rocblas_int max_sweeps,
                                               rocblas_int* n_sweeps,
                                               float* S,
                                               const rocblas_stride strideS,
                                               rocblas_float_complex* U,
                                               const rocblas_int ldu,
                                               const rocblas_stride strideU,
                                               rocblas_float_complex* V,
                                               const rocblas_int ldv,
                                               const rocblas_stride strideV,
                                               rocblas_int* info,
                                               const rocblas_int batch_count)
{
    return rocsolver_gesvdj_notransv_strided_batched_impl<rocblas_float_complex>(
        handle, left_svect, right_svect, m, n, A, lda, strideA, abstol, residual, max_sweeps,
        n_sweeps, S, strideS, U, ldu, strideU, V, ldv, strideV, info, batch_count);
}

ROCSOLVER_EXPORT rocblas_status
    rocsolver_zgesvdj_notransv_strided_batched(rocblas_handle handle,
                                               const rocblas_svect left_svect,
                                               const rocblas_svect right_svect,
                                               const rocblas_int m,
                                               const rocblas_int n,
                                               rocblas_double_complex* A,
                                               const rocblas_int lda,
                                               const rocblas_stride strideA,
                                               const double abstol,
                                               double* residual,
                                               const rocblas_int max_sweeps,
                                               rocblas_int* n_sweeps,
                                               double* S,
                                               const rocblas_stride strideS,
                                               rocblas_double_complex* U,
                                               const rocblas_int ldu,
                                               const rocblas_stride strideU,
                                               rocblas_double_complex* V,
                                               const rocblas_int ldv,
                                               const rocblas_stride strideV,
                                               rocblas_int* info,
                                               const rocblas_int batch_count)
{
    return rocsolver_gesvdj_notransv_strided_batched_impl<rocblas_double_complex>(
        handle, left_svect, right_svect, m, n, A, lda, strideA, abstol, residual, max_sweeps,
        n_sweeps, S, strideS, U, ldu, strideU, V, ldv, strideV, info, batch_count);
}

} // extern C
