sparrow 2.3.1
C++20 idiomatic APIs for the Apache Arrow Columnar Format
Loading...
Searching...
No Matches
sparrow::variable_size_binary_value_iterator< Layout, Iterator_types > Class Template Reference

Iterator over the data values of a variable size binary layout. More...

#include <variable_size_binary_iterator.hpp>

Inheritance diagram for sparrow::variable_size_binary_value_iterator< Layout, Iterator_types >:
[legend]
Collaboration diagram for sparrow::variable_size_binary_value_iterator< Layout, Iterator_types >:
[legend]

Public Types

using self_type = variable_size_binary_value_iterator<Layout, Iterator_types>
 
using base_type
 
using reference = typename base_type::reference
 
using difference_type = typename base_type::difference_type
 
using layout_type = mpl::constify_t<Layout, true>
 
using size_type = std::size_t
 
using value_type = typename Iterator_types::value_type
 
- Public Types inherited from sparrow::pointer_index_iterator_base< variable_size_binary_value_iterator< Layout, Iterator_types >, mpl::constify_t< Layout, true >, Iterator_types::value_type, Iterator_types::reference, Iterator_types::iterator_tag, std::ptrdiff_t >
using size_type
 
using difference_type
 

Public Member Functions

constexpr variable_size_binary_value_iterator () noexcept=default
 
constexpr variable_size_binary_value_iterator (layout_type *layout, size_type index)
 

Friends

class iterator_access
 

Additional Inherited Members

- Protected Member Functions inherited from sparrow::pointer_index_iterator_base< variable_size_binary_value_iterator< Layout, Iterator_types >, mpl::constify_t< Layout, true >, Iterator_types::value_type, Iterator_types::reference, Iterator_types::iterator_tag, std::ptrdiff_t >
constexpr pointer_index_iterator_base () noexcept=default
 
constexpr pointer_index_iterator_base (mpl::constify_t< Layout, true > *p, std::ptrdiff_t idx) noexcept
 
constexpr void increment () noexcept(SPARROW_CONTRACTS_THROW_ON_FAILURE==0)
 
constexpr void decrement () noexcept(SPARROW_CONTRACTS_THROW_ON_FAILURE==0)
 
constexpr void advance (std::ptrdiff_t n) noexcept(SPARROW_CONTRACTS_THROW_ON_FAILURE==0)
 
constexpr std::ptrdiff_t distance_to (const variable_size_binary_value_iterator< Layout, Iterator_types > &rhs) const noexcept(SPARROW_CONTRACTS_THROW_ON_FAILURE==0)
 
constexpr bool equal (const variable_size_binary_value_iterator< Layout, Iterator_types > &rhs) const noexcept
 
constexpr bool less_than (const variable_size_binary_value_iterator< Layout, Iterator_types > &rhs) const noexcept(SPARROW_CONTRACTS_THROW_ON_FAILURE==0)
 
- Protected Attributes inherited from sparrow::pointer_index_iterator_base< variable_size_binary_value_iterator< Layout, Iterator_types >, mpl::constify_t< Layout, true >, Iterator_types::value_type, Iterator_types::reference, Iterator_types::iterator_tag, std::ptrdiff_t >
mpl::constify_t< Layout, true > * p_object
 
std::ptrdiff_t m_index
 

Detailed Description

template<class Layout, iterator_types Iterator_types>
class sparrow::variable_size_binary_value_iterator< Layout, Iterator_types >

Iterator over the data values of a variable size binary layout.

Template Parameters
Lthe layout type
is_consta boolean flag specifying whether this iterator is const.

Definition at line 30 of file variable_size_binary_iterator.hpp.

Member Typedef Documentation

◆ base_type

template<class Layout, iterator_types Iterator_types>
using sparrow::variable_size_binary_value_iterator< Layout, Iterator_types >::base_type
Initial value:
typename Iterator_types::value_type,
typename Iterator_types::reference,
typename Iterator_types::iterator_tag,
std::ptrdiff_t>
bitset_iterator< B, is_const > self_type
typename constify< T, is_const >::type constify_t
Convenience alias for constify.
Definition mp_utils.hpp:807

Definition at line 42 of file variable_size_binary_iterator.hpp.

◆ difference_type

template<class Layout, iterator_types Iterator_types>
using sparrow::variable_size_binary_value_iterator< Layout, Iterator_types >::difference_type = typename base_type::difference_type

Definition at line 50 of file variable_size_binary_iterator.hpp.

◆ layout_type

template<class Layout, iterator_types Iterator_types>
using sparrow::variable_size_binary_value_iterator< Layout, Iterator_types >::layout_type = mpl::constify_t<Layout, true>

Definition at line 51 of file variable_size_binary_iterator.hpp.

◆ reference

template<class Layout, iterator_types Iterator_types>
using sparrow::variable_size_binary_value_iterator< Layout, Iterator_types >::reference = typename base_type::reference

Definition at line 49 of file variable_size_binary_iterator.hpp.

◆ self_type

template<class Layout, iterator_types Iterator_types>
using sparrow::variable_size_binary_value_iterator< Layout, Iterator_types >::self_type = variable_size_binary_value_iterator<Layout, Iterator_types>

Definition at line 41 of file variable_size_binary_iterator.hpp.

◆ size_type

template<class Layout, iterator_types Iterator_types>
using sparrow::variable_size_binary_value_iterator< Layout, Iterator_types >::size_type = std::size_t

Definition at line 52 of file variable_size_binary_iterator.hpp.

◆ value_type

template<class Layout, iterator_types Iterator_types>
using sparrow::variable_size_binary_value_iterator< Layout, Iterator_types >::value_type = typename Iterator_types::value_type

Definition at line 53 of file variable_size_binary_iterator.hpp.

Constructor & Destructor Documentation

◆ variable_size_binary_value_iterator() [1/2]

template<class Layout, iterator_types Iterator_types>
sparrow::variable_size_binary_value_iterator< Layout, Iterator_types >::variable_size_binary_value_iterator ( )
constexprdefaultnoexcept
Here is the caller graph for this function:

◆ variable_size_binary_value_iterator() [2/2]

template<class Layout, iterator_types Iterator_types>
sparrow::variable_size_binary_value_iterator< Layout, Iterator_types >::variable_size_binary_value_iterator ( layout_type * layout,
size_type index )
constexpr

Definition at line 70 of file variable_size_binary_iterator.hpp.

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ iterator_access

template<class Layout, iterator_types Iterator_types>
friend class iterator_access
friend

Definition at line 62 of file variable_size_binary_iterator.hpp.


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