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

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-hipcub/checkouts/docs-5.5.1/hipcub/include/hipcub/backend/rocprim/iterator/discard_output_iterator.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/iterator/discard_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) 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_DISCARD_OUTPUT_ITERATOR_HPP_
 #define HIPCUB_ROCPRIM_ITERATOR_DISCARD_OUTPUT_ITERATOR_HPP_
  
 #include <iterator>
 #include <iostream>
  
 #include "../../../config.hpp"
  
 BEGIN_HIPCUB_NAMESPACE
 #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
  
 template <typename OffsetT = ptrdiff_t>
 class DiscardOutputIterator
 {
 public:
  
     // Required iterator traits
     typedef DiscardOutputIterator   self_type;              
     typedef OffsetT                 difference_type;        
     typedef void                    value_type;             
     typedef void                    pointer;                
     typedef void                    reference;              
  
 #if (THRUST_VERSION >= 100700)
     // Use Thrust's iterator categories so we can use these iterators in Thrust 1.7 (or newer) methods
     typedef typename thrust::detail::iterator_facade_category<
         thrust::any_system_tag,
         thrust::random_access_traversal_tag,
         value_type,
         reference
       >::type iterator_category;                                        
 #else
     typedef std::random_access_iterator_tag     iterator_category;      
 #endif  // THRUST_VERSION
  
 private:
  
     OffsetT offset;
  
 public:
  
     __host__ __device__ __forceinline__ DiscardOutputIterator(
         OffsetT offset = 0)     
     :
         offset(offset)
     {}
  
     __host__ __device__ __forceinline__ self_type operator++(int)
     {
         self_type retval = *this;
         offset++;
         return retval;
     }
  
     __host__ __device__ __forceinline__ self_type operator++()
     {
         offset++;
         return *this;
     }
  
     __host__ __device__ __forceinline__ self_type& operator*()
     {
         // return self reference, which can be assigned to anything
         return *this;
     }
  
     template <typename Distance>
     __host__ __device__ __forceinline__ self_type operator+(Distance n) const
     {
         self_type retval(offset + n);
         return retval;
     }
  
     template <typename Distance>
     __host__ __device__ __forceinline__ self_type& operator+=(Distance n)
     {
         offset += n;
         return *this;
     }
  
     template <typename Distance>
     __host__ __device__ __forceinline__ self_type operator-(Distance n) const
     {
         self_type retval(offset - n);
         return retval;
     }
  
     template <typename Distance>
     __host__ __device__ __forceinline__ self_type& operator-=(Distance n)
     {
         offset -= n;
         return *this;
     }
  
     __host__ __device__ __forceinline__ difference_type operator-(self_type other) const
     {
         return offset - other.offset;
     }
  
     template <typename Distance>
     __host__ __device__ __forceinline__ self_type& operator[](Distance)
     {
         // return self reference, which can be assigned to anything
         return *this;
     }
  
     __host__ __device__ __forceinline__ pointer operator->()
     {
         return;
     }
  
     template<typename T>
     __host__ __device__ __forceinline__ void operator=(T const&)
     {}
  
     __host__ __device__ __forceinline__ operator void*() const { return NULL; }
  
     __host__ __device__ __forceinline__ bool operator==(const self_type& rhs)
     {
         return (offset == rhs.offset);
     }
  
     __host__ __device__ __forceinline__ bool operator!=(const self_type& rhs)
     {
         return (offset != rhs.offset);
     }
  
     friend std::ostream& operator<<(std::ostream& os, const self_type& itr)
     {
         os << "[" << itr.offset << "]";
         return os;
     }
 };
  
 END_HIPCUB_NAMESPACE
  
 #endif // HIPCUB_ROCPRIM_ITERATOR_DISCARD_OUTPUT_ITERATOR_HPP_