TheRock/rocm-libraries/projects/rocthrust/thrust/system/hip/detail/extrema.h

/*******************************************************************************
 * Copyright (c) 2016, NVIDIA CORPORATION.  All rights reserved.
 * Modifications Copyright (c) 2019-2025, 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:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of the NVIDIA CORPORATION nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 NVIDIA CORPORATION 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.
 *
 ******************************************************************************/
#pragma once

#include <thrust/detail/config.h>

#if defined(_CCCL_IMPLICIT_SYSTEM_HEADER_GCC)
#  pragma GCC system_header
#elif defined(_CCCL_IMPLICIT_SYSTEM_HEADER_CLANG)
#  pragma clang system_header
#elif defined(_CCCL_IMPLICIT_SYSTEM_HEADER_MSVC)
#  pragma system_header
#endif // no system header

#if THRUST_DEVICE_COMPILER == THRUST_DEVICE_COMPILER_HIP

#  include <thrust/system/hip/config.h>

#  include <thrust/detail/temporary_array.h>
#  include <thrust/distance.h>
#  include <thrust/extrema.h>
#  include <thrust/iterator/counting_iterator.h>
#  include <thrust/iterator/transform_iterator.h>
#  include <thrust/pair.h>
#  include <thrust/system/hip/detail/general/temp_storage.h>
#  include <thrust/system/hip/detail/get_value.h>
#  include <thrust/system/hip/detail/reduce.h>

// rocprim include
#  include <rocprim/rocprim.hpp>

#  include <cstdint>

THRUST_NAMESPACE_BEGIN
namespace hip_rocprim
{

namespace __extrema
{

template <class InputType, class IndexType, class Predicate>
struct arg_min_f
{
  Predicate predicate;
  using pair_type = tuple<InputType, IndexType>;

  THRUST_HOST_DEVICE arg_min_f(Predicate p)
      : predicate(p)
  {}

  pair_type THRUST_DEVICE operator()(pair_type const& lhs, pair_type const& rhs)
  {
    InputType const& rhs_value = get<0>(rhs);
    InputType const& lhs_value = get<0>(lhs);
    IndexType const& rhs_key   = get<1>(rhs);
    IndexType const& lhs_key   = get<1>(lhs);

    // check values first
    if (predicate(lhs_value, rhs_value))
    {
      return lhs;
    }
    else if (predicate(rhs_value, lhs_value))
    {
      return rhs;
    }

    // values are equivalent, prefer smaller index
    if (lhs_key < rhs_key)
    {
      return lhs;
    }
    else
    {
      return rhs;
    }
  }
}; // struct arg_min_f

template <class InputType, class IndexType, class Predicate>
struct arg_max_f
{
  Predicate predicate;
  using pair_type = tuple<InputType, IndexType>;

  THRUST_HOST_DEVICE arg_max_f(Predicate p)
      : predicate(p)
  {}

  pair_type THRUST_DEVICE operator()(pair_type const& lhs, pair_type const& rhs)
  {
    InputType const& rhs_value = get<0>(rhs);
    InputType const& lhs_value = get<0>(lhs);
    IndexType const& rhs_key   = get<1>(rhs);
    IndexType const& lhs_key   = get<1>(lhs);

    // check values first
    if (predicate(lhs_value, rhs_value))
    {
      return rhs;
    }
    else if (predicate(rhs_value, lhs_value))
    {
      return lhs;
    }

    // values are equivalent, prefer smaller index
    if (lhs_key < rhs_key)
    {
      return lhs;
    }
    else
    {
      return rhs;
    }
  }
}; // struct arg_max_f

template <class InputType, class IndexType, class Predicate>
struct arg_minmax_f
{
  Predicate predicate;

  using pair_type      = tuple<InputType, IndexType>;
  using two_pairs_type = tuple<pair_type, pair_type>;

  using arg_min_t = arg_min_f<InputType, IndexType, Predicate>;
  using arg_max_t = arg_max_f<InputType, IndexType, Predicate>;

  THRUST_HOST_DEVICE arg_minmax_f(Predicate p)
      : predicate(p)
  {}

  two_pairs_type THRUST_DEVICE operator()(two_pairs_type const& lhs, two_pairs_type const& rhs)
  {
    pair_type const& rhs_min = get<0>(rhs);
    pair_type const& lhs_min = get<0>(lhs);
    pair_type const& rhs_max = get<1>(rhs);
    pair_type const& lhs_max = get<1>(lhs);

    auto result = thrust::make_tuple(arg_min_t(predicate)(lhs_min, rhs_min), arg_max_t(predicate)(lhs_max, rhs_max));

    return result;
  }

  struct duplicate_tuple
  {
    THRUST_DEVICE two_pairs_type operator()(pair_type const& t)
    {
      return thrust::make_tuple(t, t);
    }
  };
}; // struct arg_minmax_f

// this is an init-less reduce, needed for min/max-element functionality
// this will avoid copying the first value from device->host
template <typename Derived, typename InputIt, typename Size, typename BinaryOp, typename T>
THRUST_RUNTIME_FUNCTION T
extrema(execution_policy<Derived>& policy, InputIt first, Size num_items, BinaryOp binary_op, T*)
{
  using namespace thrust::system::hip_rocprim::temp_storage;
  if (num_items == 0)
  {
    hip_rocprim::throw_on_error(hipErrorInvalidValue, "extrema number of items is zero");
  }

  size_t temp_storage_bytes = 0;
  hipStream_t stream        = hip_rocprim::stream(policy);

  bool debug_sync           = THRUST_HIP_DEBUG_SYNC_FLAG;

  // Determine temporary device storage requirements.
  hip_rocprim::throw_on_error(
    rocprim::reduce(
      nullptr, temp_storage_bytes, first, static_cast<T*>(nullptr), num_items, binary_op, stream, debug_sync),
    "extrema failed on 1st step");

  size_t storage_size;
  void* ptr       = nullptr;
  void* temp_stor = nullptr;
  T* d_result;

  auto l_part = make_linear_partition(make_partition(&temp_stor, temp_storage_bytes), ptr_aligned_array(&d_result, 1));

  // Calculate storage_size including alignment
  hip_rocprim::throw_on_error(partition(ptr, storage_size, l_part));

  // Allocate temporary storage.
  thrust::detail::temporary_array<std::uint8_t, Derived> tmp(policy, storage_size);
  ptr = static_cast<void*>(tmp.data().get());

  // Create pointers with alignment
  hip_rocprim::throw_on_error(partition(ptr, storage_size, l_part));

  hip_rocprim::throw_on_error(
    rocprim::reduce(ptr, temp_storage_bytes, first, d_result, num_items, binary_op, stream, debug_sync),
    "extrema failed on 2nd step");

  T result = hip_rocprim::get_value(policy, d_result);

  return result;
}

template <template <class, class, class> class ArgFunctor, class Derived, class ItemsIt, class BinaryPred>
ItemsIt THRUST_RUNTIME_FUNCTION
element(execution_policy<Derived>& policy, ItemsIt first, ItemsIt last, BinaryPred binary_pred)
{
  if (first == last)
  {
    return last;
  }

  using InputType = typename iterator_traits<ItemsIt>::value_type;
  using IndexType = typename iterator_traits<ItemsIt>::difference_type;

  IndexType num_items = static_cast<IndexType>(thrust::distance(first, last));

  using iterator_tuple = tuple<ItemsIt, counting_iterator<IndexType>>;
  using zip_iterator   = zip_iterator<iterator_tuple>;

  iterator_tuple iter_tuple = thrust::make_tuple(first, counting_iterator<IndexType>(0));

  using arg_min_t = ArgFunctor<InputType, IndexType, BinaryPred>;
  using T         = tuple<InputType, IndexType>;

  zip_iterator begin = make_zip_iterator(iter_tuple);

  T result = extrema(policy, begin, num_items, arg_min_t(binary_pred), (T*) (nullptr));
  return first + thrust::get<1>(result);
}

} // namespace __extrema

/// min element

THRUST_EXEC_CHECK_DISABLE
template <class Derived, class ItemsIt, class BinaryPred>
ItemsIt THRUST_HOST_DEVICE
min_element(execution_policy<Derived>& policy, ItemsIt first, ItemsIt last, BinaryPred binary_pred)
{
  THRUST_HIP_PRESERVE_KERNELS_WORKAROUND((__extrema::element<__extrema::arg_min_f, Derived, ItemsIt, BinaryPred>) );
#  if __THRUST_HAS_HIPRT__
  last = __extrema::element<__extrema::arg_min_f>(policy, first, last, binary_pred);
#  else // __THRUST_HAS_HIPRT__
  last = thrust::min_element(cvt_to_seq(derived_cast(policy)), first, last, binary_pred);
#  endif // __THRUST_HAS_HIPRT__
  return last;
}

template <class Derived, class ItemsIt>
ItemsIt THRUST_HOST_DEVICE min_element(execution_policy<Derived>& policy, ItemsIt first, ItemsIt last)
{
  using value_type = typename iterator_value<ItemsIt>::type;
  return hip_rocprim::min_element(policy, first, last, less<value_type>());
}

/// max element

THRUST_EXEC_CHECK_DISABLE
template <class Derived, class ItemsIt, class BinaryPred>
ItemsIt THRUST_HOST_DEVICE
max_element(execution_policy<Derived>& policy, ItemsIt first, ItemsIt last, BinaryPred binary_pred)
{
  THRUST_HIP_PRESERVE_KERNELS_WORKAROUND((__extrema::element<__extrema::arg_max_f, Derived, ItemsIt, BinaryPred>) );
#  if __THRUST_HAS_HIPRT__
  last = __extrema::element<__extrema::arg_max_f>(policy, first, last, binary_pred);
#  else // __THRUST_HAS_HIPRT__
  last = thrust::max_element(cvt_to_seq(derived_cast(policy)), first, last, binary_pred);
#  endif // __THRUST_HAS_HIPRT__
  return last;
}

template <class Derived, class ItemsIt>
ItemsIt THRUST_HOST_DEVICE max_element(execution_policy<Derived>& policy, ItemsIt first, ItemsIt last)
{
  using value_type = typename iterator_value<ItemsIt>::type;
  return hip_rocprim::max_element(policy, first, last, less<value_type>());
}

/// minmax element

THRUST_EXEC_CHECK_DISABLE
template <class Derived, class ItemsIt, class BinaryPred>
pair<ItemsIt, ItemsIt> THRUST_HOST_DEVICE
minmax_element(execution_policy<Derived>& policy, ItemsIt first, ItemsIt last, BinaryPred binary_pred)
{
  auto ret = thrust::make_pair(last, last);

  using InputType = typename iterator_traits<ItemsIt>::value_type;
  using IndexType = typename iterator_traits<ItemsIt>::difference_type;

  using iterator_tuple = tuple<ItemsIt, counting_iterator<IndexType>>;
  using zip_iterator   = zip_iterator<iterator_tuple>;

  using arg_minmax_t   = __extrema::arg_minmax_f<InputType, IndexType, BinaryPred>;
  using two_pairs_type = typename arg_minmax_t::two_pairs_type;
  using duplicate_t    = typename arg_minmax_t::duplicate_tuple;
  using transform_t    = transform_iterator<duplicate_t, zip_iterator, two_pairs_type, two_pairs_type>;

  THRUST_HIP_PRESERVE_KERNELS_WORKAROUND(
    (__extrema::extrema<Derived, transform_t, IndexType, arg_minmax_t, two_pairs_type>) );
#  if __THRUST_HAS_HIPRT__
  if (first == last)
  {
    return ret;
  }

  const auto num_items = static_cast<IndexType>(thrust::distance(first, last));

  iterator_tuple iter_tuple = thrust::make_tuple(first, counting_iterator<IndexType>(0));

  zip_iterator begin    = make_zip_iterator(iter_tuple);
  two_pairs_type result = __extrema::extrema(
    policy, transform_t(begin, duplicate_t()), num_items, arg_minmax_t(binary_pred), (two_pairs_type*) (nullptr));
  ret = thrust::make_pair(first + get<1>(get<0>(result)), first + get<1>(get<1>(result)));
#  else // __THRUST_HAS_HIPRT__
  ret = thrust::minmax_element(cvt_to_seq(derived_cast(policy)), first, last, binary_pred);
#  endif // __THRUST_HAS_HIPRT__
  return ret;
}

template <class Derived, class ItemsIt>
pair<ItemsIt, ItemsIt> THRUST_HOST_DEVICE minmax_element(execution_policy<Derived>& policy, ItemsIt first, ItemsIt last)
{
  using value_type = typename iterator_value<ItemsIt>::type;
  return hip_rocprim::minmax_element(policy, first, last, less<value_type>());
}

} // namespace hip_rocprim
THRUST_NAMESPACE_END
#endif