text: /* ************************************************************************
   * Copyright (c) 2020-2021 Advanced Micro Devices, Inc.
   *
   * Permission is hereby granted, free of charge, to any person obtaining a copy
   * of this software and associated documentation files (the "Software"), to deal
   * in the Software without restriction, including without limitation the rights
   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   * copies of the Software, and to permit persons to whom the Software is
   * furnished to do so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice shall be included in
   * all copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   * THE SOFTWARE.
   *
   * ************************************************************************ */
  
  #include "testing.hpp"
  
  template <typename I, typename T>
  void testing_gather_bad_arg(const Arguments& arg)
  {
      I size = 100;
      I nnz  = 100;
  
      rocsparse_index_base base = rocsparse_index_base_zero;
  
      // Index and data type
      rocsparse_indextype itype = get_indextype<I>();
      rocsparse_datatype  ttype = get_datatype<T>();
  
      // Create rocsparse handle
      rocsparse_local_handle handle;
  
      // Allocate memory on device
      device_vector<I> dx_ind(nnz);
      device_vector<T> dx_val(nnz);
      device_vector<T> dy(size);
  
      if(!dx_ind || !dx_val || !dy)
      {
          CHECK_HIP_ERROR(hipErrorOutOfMemory);
          return;
      }
  
      // Structures
      rocsparse_local_spvec x(size, nnz, dx_ind, dx_val, itype, base, ttype);
      rocsparse_local_dnvec y(size, dy, ttype);
  
      EXPECT_ROCSPARSE_STATUS(rocsparse_gather(nullptr, y, x), rocsparse_status_invalid_handle);
      EXPECT_ROCSPARSE_STATUS(rocsparse_gather(handle, nullptr, x), rocsparse_status_invalid_pointer);
      EXPECT_ROCSPARSE_STATUS(rocsparse_gather(handle, y, nullptr), rocsparse_status_invalid_pointer);
  }
  
  template <typename I, typename T>
  void testing_gather(const Arguments& arg)
  {
      I size = arg.M;
      I nnz  = arg.nnz;
  
      rocsparse_index_base base = arg.baseA;
  
      // Index and data type
      rocsparse_indextype itype = get_indextype<I>();
      rocsparse_datatype  ttype = get_datatype<T>();
  
      // Create rocsparse handle
      rocsparse_local_handle handle;
  
      // Argument sanity check before allocating invalid memory
      if(size <= 0 || nnz <= 0)
      {
          static const I safe_size = 100;
  
          // Allocate memory on device
          device_vector<T> dx_ind(safe_size);
          device_vector<T> dx_val(safe_size);
          device_vector<T> dy(safe_size);
  
          if(!dx_ind || !dx_val || !dy)
          {
              CHECK_HIP_ERROR(hipErrorOutOfMemory);
              return;
          }
  
          // Check structures
          rocsparse_local_spvec x(size, nnz, dx_ind, dx_val, itype, base, ttype);
          rocsparse_local_dnvec y(size, dy, ttype);
  
          // Check Gather when structures were created
          if(size >= 0 && nnz >= 0)
          {
              EXPECT_ROCSPARSE_STATUS(rocsparse_gather(handle, y, x), rocsparse_status_success);
          }
  
          return;
      }
  
      // Allocate host memory for matrix
      host_vector<I> hx_ind(nnz);
      host_vector<T> hx_val(nnz);
      host_vector<T> hx_val_gold(nnz);
      host_vector<T> hy(size);
  
      // Initialize data on CPU
      rocsparse_seedrand();
      rocsparse_init_index(hx_ind, nnz, 1, size);
      rocsparse_init<T>(hy, 1, size, 1);
  
      // Allocate device memory
      device_vector<I> dx_ind(nnz);
      device_vector<T> dx_val(nnz);
      device_vector<T> dy(size);
  
      if(!dx_ind || !dx_val || !dy)
      {
          CHECK_HIP_ERROR(hipErrorOutOfMemory);
          return;
      }
  
      // Copy data from CPU to device
      CHECK_HIP_ERROR(hipMemcpy(dx_ind, hx_ind, sizeof(I) * nnz, hipMemcpyHostToDevice));
      CHECK_HIP_ERROR(hipMemcpy(dy, hy, sizeof(T) * size, hipMemcpyHostToDevice));
  
      // Create descriptors
      rocsparse_local_spvec x(size, nnz, dx_ind, dx_val, itype, base, ttype);
      rocsparse_local_dnvec y(size, dy, ttype);
  
      if(arg.unit_check)
      {
          // Gather
          CHECK_ROCSPARSE_ERROR(rocsparse_gather(handle, y, x));
  
          // Copy output to host
          CHECK_HIP_ERROR(hipMemcpy(hx_val, dx_val, sizeof(T) * nnz, hipMemcpyDeviceToHost));
  
          // CPU coomv
          host_gthr<I, T>(nnz, hy, hx_val_gold, hx_ind, base);
  
          unit_check_general<T>(1, nnz, 1, hx_val_gold, hx_val);
      }
  
      if(arg.timing)
      {
          int number_cold_calls = 2;
          int number_hot_calls  = arg.iters;
  
          // Warm up
          for(int iter = 0; iter < number_cold_calls; ++iter)
          {
              CHECK_ROCSPARSE_ERROR(rocsparse_gather(handle, y, x));
          }
  
          double gpu_time_used = get_time_us();
  
          // Performance run
          for(int iter = 0; iter < number_hot_calls; ++iter)
          {
              CHECK_ROCSPARSE_ERROR(rocsparse_gather(handle, y, x));
          }
  
          gpu_time_used = (get_time_us() - gpu_time_used) / number_hot_calls;
  
          double gpu_gbyte = gthr_gbyte_count<T>(nnz) / gpu_time_used * 1e6;
  
          std::cout.precision(2);
          std::cout.setf(std::ios::fixed);
          std::cout.setf(std::ios::left);
  
          std::cout << std::setw(12) << "nnz" << std::setw(12) << "GB/s" << std::setw(12) << "usec"
                    << std::setw(12) << "iter" << std::setw(12) << "verified" << std::endl;
  
          std::cout << std::setw(12) << nnz << std::setw(12) << gpu_gbyte << std::setw(12)
                    << gpu_time_used << std::setw(12) << number_hot_calls << std::setw(12)
                    << (arg.unit_check ? "yes" : "no") << std::endl;
      }
  }
  
  #define INSTANTIATE(ITYPE, TTYPE)                                             \
      template void testing_gather_bad_arg<ITYPE, TTYPE>(const Arguments& arg); \
      template void testing_gather<ITYPE, TTYPE>(const Arguments& arg)
  
  INSTANTIATE(int32_t, float);
  INSTANTIATE(int32_t, double);
  INSTANTIATE(int32_t, rocsparse_float_complex);
  INSTANTIATE(int32_t, rocsparse_double_complex);
  INSTANTIATE(int64_t, float);
  INSTANTIATE(int64_t, double);
  INSTANTIATE(int64_t, rocsparse_float_complex);
  INSTANTIATE(int64_t, rocsparse_double_complex);
  