/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hipcub/checkouts/docs-5.7.0/hipcub/include/hipcub/backend/rocprim/iterator/cache_modified_output_iterator.hpp Source File

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hipcub/checkouts/docs-5.7.0/hipcub/include/hipcub/backend/rocprim/iterator/cache_modified_output_iterator.hpp Source File#

hipCUB: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hipcub/checkouts/docs-5.7.0/hipcub/include/hipcub/backend/rocprim/iterator/cache_modified_output_iterator.hpp Source File

 /******************************************************************************
  * Copyright (c) 2010-2011, Duane Merrill.  All rights reserved.
  * Copyright (c) 2011-2018, NVIDIA CORPORATION.  All rights reserved.
  * Modifications Copyright (c) 2017-2020, 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.
  *
  ******************************************************************************/
  
 #ifndef HIPCUB_ROCPRIM_ITERATOR_CACHE_MODIFIED_OUTPUT_ITERATOR_HPP_
 #define HIPCUB_ROCPRIM_ITERATOR_CACHE_MODIFIED_OUTPUT_ITERATOR_HPP_
  
 #include <iterator>
 #include <iostream>
  
 #include "../thread/thread_load.hpp"
 #include "../thread/thread_store.hpp"
 #include "../util_type.hpp"
  
 #if (THRUST_VERSION >= 100700)
     // This iterator is compatible with Thrust API 1.7 and newer
     #include <thrust/iterator/iterator_facade.h>
     #include <thrust/iterator/iterator_traits.h>
 #endif // THRUST_VERSION
  
  
 BEGIN_HIPCUB_NAMESPACE
  
 template <
     CacheStoreModifier  MODIFIER,
     typename            ValueType,
     typename            OffsetT = ptrdiff_t>
 class CacheModifiedOutputIterator
 {
 private:
  
     // Proxy object
     struct Reference
     {
         ValueType* ptr;
  
         __host__ __device__ __forceinline__ Reference(ValueType* ptr) : ptr(ptr) {}
  
         __device__ __forceinline__ ValueType operator =(ValueType val)
         {
             ThreadStore<MODIFIER>(ptr, val);
             return val;
         }
     };
  
 public:
  
     // Required iterator traits
     typedef CacheModifiedOutputIterator         self_type;              
     typedef OffsetT                             difference_type;        
     typedef void                                value_type;             
     typedef void                                pointer;                
     typedef Reference                           reference;              
     typedef std::random_access_iterator_tag     iterator_category;      
  
 private:
  
     ValueType* ptr;
  
 public:
  
     template <typename QualifiedValueType>
     __host__ __device__ __forceinline__ CacheModifiedOutputIterator(
         QualifiedValueType* ptr)     
     :
         ptr(const_cast<typename std::remove_cv<QualifiedValueType>::type *>(ptr))
     {}
  
     __host__ __device__ __forceinline__ self_type operator++(int)
     {
         self_type retval = *this;
         ptr++;
         return retval;
     }
  
  
     __host__ __device__ __forceinline__ self_type operator++()
     {
         ptr++;
         return *this;
     }
  
     __host__ __device__ __forceinline__ reference operator*() const
     {
         return Reference(ptr);
     }
  
     template <typename Distance>
     __host__ __device__ __forceinline__ self_type operator+(Distance n) const
     {
         self_type retval(ptr + n);
         return retval;
     }
  
     template <typename Distance>
     __host__ __device__ __forceinline__ self_type& operator+=(Distance n)
     {
         ptr += n;
         return *this;
     }
  
     template <typename Distance>
     __host__ __device__ __forceinline__ self_type operator-(Distance n) const
     {
         self_type retval(ptr - n);
         return retval;
     }
  
     template <typename Distance>
     __host__ __device__ __forceinline__ self_type& operator-=(Distance n)
     {
         ptr -= n;
         return *this;
     }
  
     __host__ __device__ __forceinline__ difference_type operator-(self_type other) const
     {
         return ptr - other.ptr;
     }
  
     template <typename Distance>
     __host__ __device__ __forceinline__ reference operator[](Distance n) const
     {
         return Reference(ptr + n);
     }
  
     __host__ __device__ __forceinline__ bool operator==(const self_type& rhs)
     {
         return (ptr == rhs.ptr);
     }
  
     __host__ __device__ __forceinline__ bool operator!=(const self_type& rhs)
     {
         return (ptr != rhs.ptr);
     }
  
 #ifndef DOXYGEN_SHOULD_SKIP_THIS    // Do not document
  
     friend std::ostream& operator<<(std::ostream& os, const self_type& itr)
     {
         (void)itr;
         return os;
     }
  
 #endif
 };
  
 END_HIPCUB_NAMESPACE
  
 #endif