Public Types | Public Member Functions | List of all members
cudf::host_span< T, Extent > Struct Template Reference

C++20 std::span with reduced feature set. More...

#include <span.hpp>

Inheritance diagram for cudf::host_span< T, Extent >:
cudf::detail::span_base< T, cudf::dynamic_extent, host_span< T, cudf::dynamic_extent > >

Public Types

using base = cudf::detail::span_base< T, Extent, host_span< T, Extent > >
 Base type.
 
- Public Types inherited from cudf::detail::span_base< T, cudf::dynamic_extent, host_span< T, cudf::dynamic_extent > >
using element_type = T
 The type of the elements in the span.
 
using value_type = std::remove_cv< T >
 Stored value type.
 
using size_type = std::size_t
 The type used for the size of the span.
 
using difference_type = std::ptrdiff_t
 std::ptrdiff_t
 
using pointer = T *
 The type of the pointer returned by data()
 
using iterator = T *
 The type of the iterator returned by begin()
 
using const_pointer = T const *
 The type of the pointer returned by data() const.
 
using reference = T &
 The type of the reference returned by operator[](size_type)
 
using const_reference = T const &
 The type of the reference returned by operator[](size_type) const.
 

Public Member Functions

template<typename C , std::enable_if_t< is_host_span_supported_container< C >::value &&std::is_convertible_v< std::remove_pointer_t< decltype(thrust::raw_pointer_cast(std::declval< C & >().data()))>(*)[], T(*)[]> , * = nullptr>
constexpr host_span (C &in)
 
template<typename C , std::enable_if_t< is_host_span_supported_container< C >::value &&std::is_convertible_v< std::remove_pointer_t< decltype(thrust::raw_pointer_cast(std::declval< C & >().data()))>(*)[], T(*)[]> , * = nullptr>
constexpr host_span (C const &in)
 
template<typename OtherT , std::enable_if_t< std::is_convertible_v< OtherT(*)[], T(*)[]>> * = nullptr>
constexpr host_span (cudf::detail::host_vector< OtherT > &in)
 
template<typename OtherT , std::enable_if_t< std::is_convertible_v< OtherT(*)[], T(*)[]>> * = nullptr>
constexpr host_span (cudf::detail::host_vector< OtherT > const &in)
 
template<typename OtherT , std::size_t OtherExtent, std::enable_if_t<(Extent==OtherExtent||Extent==dynamic_extent) &&std::is_convertible_v< OtherT(*)[], T(*)[]>, void > * = nullptr>
constexpr host_span (host_span< OtherT, OtherExtent > const &other) noexcept
 
bool is_device_accessible () const
 Returns whether the data is device accessible (e.g. pinned memory) More...
 
- Public Member Functions inherited from cudf::detail::span_base< T, cudf::dynamic_extent, host_span< T, cudf::dynamic_extent > >
constexpr span_base (pointer data, size_type size)
 Constructs a span from a pointer and a size. More...
 
constexpr span_base (span_base const &) noexcept=default
 Copy constructor.
 
constexpr span_baseoperator= (span_base const &) noexcept=default
 Copy assignment operator. More...
 
constexpr reference front () const
 Returns a reference to the first element in the span. More...
 
constexpr reference back () const
 Returns a reference to the last element in the span. More...
 
constexpr reference operator[] (size_type idx) const
 Returns a reference to the idx-th element of the sequence. More...
 
constexpr iterator begin () const noexcept
 Returns an iterator to the first element of the span. More...
 
constexpr iterator end () const noexcept
 Returns an iterator to the element following the last element of the span. More...
 
constexpr pointer data () const noexcept
 Returns a pointer to the beginning of the sequence. More...
 
constexpr size_type size () const noexcept
 Returns the number of elements in the span. More...
 
constexpr size_type size_bytes () const noexcept
 Returns the size of the sequence in bytes. More...
 
constexpr bool empty () const noexcept
 Checks if the span is empty. More...
 
constexpr host_span< T, cudf::dynamic_extentfirst (size_type count) const noexcept
 Obtains a subspan consisting of the first N elements of the sequence. More...
 
constexpr host_span< T, cudf::dynamic_extentlast (size_type count) const noexcept
 Obtains a subspan consisting of the last N elements of the sequence. More...
 
constexpr host_span< T, cudf::dynamic_extentsubspan (size_type offset, size_type count) const noexcept
 Obtains a span that is a view over the count elements of this span starting at offset. More...
 

Additional Inherited Members

- Static Public Attributes inherited from cudf::detail::span_base< T, cudf::dynamic_extent, host_span< T, cudf::dynamic_extent > >
static constexpr std::size_t extent
 The extent of the span.
 

Detailed Description

template<typename T, std::size_t Extent = cudf::dynamic_extent>
struct cudf::host_span< T, Extent >

C++20 std::span with reduced feature set.

Definition at line 231 of file span.hpp.

Constructor & Destructor Documentation

◆ host_span() [1/5]

template<typename T , std::size_t Extent = cudf::dynamic_extent>
template<typename C , std::enable_if_t< is_host_span_supported_container< C >::value &&std::is_convertible_v< std::remove_pointer_t< decltype(thrust::raw_pointer_cast(std::declval< C & >().data()))>(*)[], T(*)[]> , * = nullptr>
constexpr cudf::host_span< T, Extent >::host_span ( C &  in)
inlineconstexpr

Constructor from container

Parameters
inThe container to construct the span from

Definition at line 246 of file span.hpp.

◆ host_span() [2/5]

template<typename T , std::size_t Extent = cudf::dynamic_extent>
template<typename C , std::enable_if_t< is_host_span_supported_container< C >::value &&std::is_convertible_v< std::remove_pointer_t< decltype(thrust::raw_pointer_cast(std::declval< C & >().data()))>(*)[], T(*)[]> , * = nullptr>
constexpr cudf::host_span< T, Extent >::host_span ( C const &  in)
inlineconstexpr

Constructor from const container

Parameters
inThe container to construct the span from

Definition at line 259 of file span.hpp.

◆ host_span() [3/5]

template<typename T , std::size_t Extent = cudf::dynamic_extent>
template<typename OtherT , std::enable_if_t< std::is_convertible_v< OtherT(*)[], T(*)[]>> * = nullptr>
constexpr cudf::host_span< T, Extent >::host_span ( cudf::detail::host_vector< OtherT > &  in)
inlineconstexpr

Constructor from a host_vector

Parameters
inThe host_vector to construct the span from

Definition at line 268 of file span.hpp.

◆ host_span() [4/5]

template<typename T , std::size_t Extent = cudf::dynamic_extent>
template<typename OtherT , std::enable_if_t< std::is_convertible_v< OtherT(*)[], T(*)[]>> * = nullptr>
constexpr cudf::host_span< T, Extent >::host_span ( cudf::detail::host_vector< OtherT > const &  in)
inlineconstexpr

Constructor from a const host_vector

Parameters
inThe host_vector to construct the span from

Definition at line 278 of file span.hpp.

◆ host_span() [5/5]

template<typename T , std::size_t Extent = cudf::dynamic_extent>
template<typename OtherT , std::size_t OtherExtent, std::enable_if_t<(Extent==OtherExtent||Extent==dynamic_extent) &&std::is_convertible_v< OtherT(*)[], T(*)[]>, void > * = nullptr>
constexpr cudf::host_span< T, Extent >::host_span ( host_span< OtherT, OtherExtent > const &  other)
inlineconstexprnoexcept
Parameters
otherThe span to copy

Definition at line 290 of file span.hpp.

Member Function Documentation

◆ is_device_accessible()

template<typename T , std::size_t Extent = cudf::dynamic_extent>
bool cudf::host_span< T, Extent >::is_device_accessible ( ) const
inline

Returns whether the data is device accessible (e.g. pinned memory)

Returns
true if the data is device accessible

Definition at line 300 of file span.hpp.


The documentation for this struct was generated from the following file: