/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hipcub/checkouts/docs-5.5.1/hipcub/include/hipcub/backend/rocprim/block/block_raking_layout.hpp Source File

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hipcub/checkouts/docs-5.5.1/hipcub/include/hipcub/backend/rocprim/block/block_raking_layout.hpp Source File#

hipCUB: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hipcub/checkouts/docs-5.5.1/hipcub/include/hipcub/backend/rocprim/block/block_raking_layout.hpp Source File

Go to the documentation of this file.

 /******************************************************************************
  * Copyright (c) 2011, Duane Merrill.  All rights reserved.
  * Copyright (c) 2011-2018, NVIDIA CORPORATION.  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.
  *
  ******************************************************************************/
  
 #ifndef HIPCUB_ROCPRIM_BLOCK_BLOCK_RAKING_LAYOUT_HPP_
 #define HIPCUB_ROCPRIM_BLOCK_BLOCK_RAKING_LAYOUT_HPP_
  
 #include <type_traits>
  
 #include "../../../config.hpp"
  
 #include <rocprim/config.hpp>
 #include <rocprim/detail/various.hpp>
  
 BEGIN_HIPCUB_NAMESPACE
  
 template<typename T, int BLOCK_THREADS, int ARCH = HIPCUB_ARCH /* ignored */
          >
 struct BlockRakingLayout
 {
     //---------------------------------------------------------------------
     // Constants and type definitions
     //---------------------------------------------------------------------
  
     enum
     {
         SHARED_ELEMENTS = BLOCK_THREADS,
  
         MAX_RAKING_THREADS = ::rocprim::detail::get_min_warp_size(
             static_cast<unsigned int>(BLOCK_THREADS), HIPCUB_DEVICE_WARP_THREADS),
  
         SEGMENT_LENGTH = (SHARED_ELEMENTS + MAX_RAKING_THREADS - 1) / MAX_RAKING_THREADS,
  
         RAKING_THREADS = (SHARED_ELEMENTS + SEGMENT_LENGTH - 1) / SEGMENT_LENGTH,
  
         USE_SEGMENT_PADDING = ((SEGMENT_LENGTH & 1) == 0) && (SEGMENT_LENGTH > 2),
  
         GRID_ELEMENTS = RAKING_THREADS * (SEGMENT_LENGTH + USE_SEGMENT_PADDING),
  
         UNGUARDED = (SHARED_ELEMENTS % RAKING_THREADS == 0),
     };
  
 #ifndef DOXYGEN_SHOULD_SKIP_THIS    // Do not document
     struct __align__(16) _TempStorage
     {
         T buff[BlockRakingLayout::GRID_ELEMENTS];
     };
  
 #endif
  
     struct TempStorage : Uninitialized<_TempStorage> {};
  
     static HIPCUB_DEVICE inline T* PlacementPtr(
         TempStorage &temp_storage,
         unsigned int linear_tid)
     {
         // Offset for partial
         unsigned int offset = linear_tid;
  
         // Add in one padding element for every segment
         if (USE_SEGMENT_PADDING > 0)
         {
             offset += offset / SEGMENT_LENGTH;
         }
  
         // Incorporating a block of padding partials every shared memory segment
         return temp_storage.Alias().buff + offset;
     }
  
     static HIPCUB_DEVICE inline T* RakingPtr(
         TempStorage &temp_storage,
         unsigned int linear_tid)
     {
         return temp_storage.Alias().buff + (linear_tid * (SEGMENT_LENGTH + USE_SEGMENT_PADDING));
     }
 };
  
 END_HIPCUB_NAMESPACE
  
 #endif // HIPCUB_ROCPRIM_BLOCK_BLOCK_RAKING_LAYOUT_HPP_