ranges.h

Go to the documentation of this file.

/*
 *  Copyright 2019 Patrick Stotko
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
 
#ifndef STDGPU_RANGES_H
#define STDGPU_RANGES_H
 
#include <thrust/iterator/transform_iterator.h>
 
#include <stdgpu/cstddef.h>
#include <stdgpu/iterator.h>
#include <stdgpu/platform.h>
 
namespace stdgpu
{
 
template <typename T>
class device_range
{
public:
    using iterator = device_ptr<T>;                             
    using value_type = typename iterator::value_type;           
    using difference_type = typename iterator::difference_type; 
    using reference = typename iterator::reference;             
    device_range() = default;
 
    explicit device_range(T* p);
 
    STDGPU_HOST_DEVICE
    device_range(T* p, index64_t n);
 
    STDGPU_HOST_DEVICE
    device_range(iterator begin, index64_t n);
 
    STDGPU_HOST_DEVICE
    device_range(iterator begin, iterator end);
 
    STDGPU_HOST_DEVICE iterator
    begin() const noexcept;
 
    STDGPU_HOST_DEVICE iterator
    end() const noexcept;
 
    STDGPU_HOST_DEVICE index64_t
    size() const;
 
    [[nodiscard]] STDGPU_HOST_DEVICE bool
    empty() const;
 
private:
    iterator _begin = {};
    iterator _end = {};
};
 
template <typename T>
class host_range
{
public:
    using iterator = host_ptr<T>;                               
    using value_type = typename iterator::value_type;           
    using difference_type = typename iterator::difference_type; 
    using reference = typename iterator::reference;             
    host_range() = default;
 
    explicit host_range(T* p);
 
    STDGPU_HOST_DEVICE
    host_range(T* p, index64_t n);
 
    STDGPU_HOST_DEVICE
    host_range(iterator begin, index64_t n);
 
    STDGPU_HOST_DEVICE
    host_range(iterator begin, iterator end);
 
    STDGPU_HOST_DEVICE iterator
    begin() const noexcept;
 
    STDGPU_HOST_DEVICE iterator
    end() const noexcept;
 
    STDGPU_HOST_DEVICE index64_t
    size() const;
 
    [[nodiscard]] STDGPU_HOST_DEVICE bool
    empty() const;
 
private:
    iterator _begin = {};
    iterator _end = {};
};
 
template <typename R, typename UnaryFunction>
class transform_range
{
public:
    using iterator = thrust::transform_iterator<UnaryFunction,
                                                typename R::iterator>; 
    using value_type = typename iterator::value_type;                  
    using difference_type = typename iterator::difference_type;        
    using reference = typename iterator::reference;                    
    transform_range() = default;
 
    STDGPU_HOST_DEVICE
    explicit transform_range(R r);
 
    STDGPU_HOST_DEVICE
    transform_range(R r, UnaryFunction f);
 
    STDGPU_HOST_DEVICE iterator
    begin() const noexcept;
 
    STDGPU_HOST_DEVICE iterator
    end() const noexcept;
 
    STDGPU_HOST_DEVICE index64_t
    size() const;
 
    [[nodiscard]] STDGPU_HOST_DEVICE bool
    empty() const;
 
private:
    iterator _begin = {};
    iterator _end = {};
};
 
namespace detail
{
 
template <typename T>
class select;
 
} // namespace detail
 
template <typename T>
using device_indexed_range = transform_range<device_range<index_t>, detail::select<T>>;
 
template <typename T>
using host_indexed_range = transform_range<host_range<index_t>, detail::select<T>>;
 
} // namespace stdgpu
 
#include <stdgpu/impl/ranges_detail.h>
 
#endif // STDGPU_RANGES_H