sparrow::run_end_encoded_array Class Reference

A run-end encoded array. More...

#include <run_end_encoded_array.hpp>

Public Types
using	self_type = run_end_encoded_array
using	size_type = std::size_t
using	inner_value_type = array_traits::inner_value_type
using	value_type = array_traits::value_type
using	const_reference = array_traits::const_reference
using	iterator = run_encoded_array_iterator<false>
using	const_iterator = run_encoded_array_iterator<true>

Public Member Functions
SPARROW_API	run_end_encoded_array (arrow_proxy proxy)
template<class... Args> requires (mpl::excludes_copy_and_move_ctor_v<run_end_encoded_array, Args...>)
	run_end_encoded_array (Args &&... args)
SPARROW_API	run_end_encoded_array (const self_type &)
SPARROW_API self_type &	operator= (const self_type &)
	run_end_encoded_array (self_type &&)=default
self_type &	operator= (self_type &&)=default
SPARROW_API array_traits::const_reference	operator[] (std::uint64_t i)
SPARROW_API array_traits::const_reference	operator[] (std::uint64_t i) const
SPARROW_API iterator	begin ()
SPARROW_API iterator	end ()
SPARROW_API const_iterator	begin () const
SPARROW_API const_iterator	end () const
SPARROW_API const_iterator	cbegin () const
SPARROW_API const_iterator	cend () const
SPARROW_API array_traits::const_reference	front () const
SPARROW_API array_traits::const_reference	back () const
SPARROW_API bool	empty () const
SPARROW_API size_type	size () const
std::optional< std::string_view >	name () const
std::optional< key_value_view >	metadata () const

Friends
class	run_encoded_array_iterator< false >
class	run_encoded_array_iterator< true >
class	detail::array_access

Detailed Description

A run-end encoded array.

To use for data with long runs of identical values

This array is used to store data in a run-length encoded format, where each run is represented by a length and a value. Compresses data by storing run lengths for consecutive identical values. Apache Arrow specification: https://arrow.apache.org/docs/format/Columnar.html#run-end-encoded-layout

Definition at line 54 of file run_end_encoded_array.hpp.

Member Typedef Documentation

const_iterator

using sparrow::run_end_encoded_array::const_iterator = run_encoded_array_iterator<true>

Definition at line 64 of file run_end_encoded_array.hpp.

const_reference

using sparrow::run_end_encoded_array::const_reference = array_traits::const_reference

Definition at line 62 of file run_end_encoded_array.hpp.

inner_value_type

using sparrow::run_end_encoded_array::inner_value_type = array_traits::inner_value_type

Definition at line 60 of file run_end_encoded_array.hpp.

iterator

using sparrow::run_end_encoded_array::iterator = run_encoded_array_iterator<false>

Definition at line 63 of file run_end_encoded_array.hpp.

self_type

using sparrow::run_end_encoded_array::self_type = run_end_encoded_array

Definition at line 58 of file run_end_encoded_array.hpp.

size_type

using sparrow::run_end_encoded_array::size_type = std::size_t

Definition at line 59 of file run_end_encoded_array.hpp.

value_type

using sparrow::run_end_encoded_array::value_type = array_traits::value_type

Definition at line 61 of file run_end_encoded_array.hpp.

Constructor & Destructor Documentation

run_end_encoded_array() [1/4]

SPARROW_API sparrow::run_end_encoded_array::run_end_encoded_array ( arrow_proxy proxy )

explicit

Here is the call graph for this function:

Here is the caller graph for this function:

run_end_encoded_array() [2/4]

template<class... Args>
requires (mpl::excludes_copy_and_move_ctor_v<run_end_encoded_array, Args...>)

sparrow::run_end_encoded_array::run_end_encoded_array ( Args &&... args )

inlineexplicit

Definition at line 70 of file run_end_encoded_array.hpp.

run_end_encoded_array() [3/4]

SPARROW_API sparrow::run_end_encoded_array::run_end_encoded_array

(

const self_type &

)

run_end_encoded_array() [4/4]

sparrow::run_end_encoded_array::run_end_encoded_array ( self_type && )

default

Member Function Documentation

back()

SPARROW_API array_traits::const_reference sparrow::run_end_encoded_array::back ( ) const

nodiscard

begin() [1/2]

SPARROW_API iterator sparrow::run_end_encoded_array::begin ( )

nodiscard

begin() [2/2]

SPARROW_API const_iterator sparrow::run_end_encoded_array::begin ( ) const

nodiscard

cbegin()

SPARROW_API const_iterator sparrow::run_end_encoded_array::cbegin ( ) const

nodiscard

cend()

SPARROW_API const_iterator sparrow::run_end_encoded_array::cend ( ) const

nodiscard

empty()

SPARROW_API bool sparrow::run_end_encoded_array::empty ( ) const

nodiscard

end() [1/2]

SPARROW_API iterator sparrow::run_end_encoded_array::end ( )

nodiscard

end() [2/2]

SPARROW_API const_iterator sparrow::run_end_encoded_array::end ( ) const

nodiscard

front()

SPARROW_API array_traits::const_reference sparrow::run_end_encoded_array::front ( ) const

nodiscard

metadata()

std::optional< key_value_view > sparrow::run_end_encoded_array::metadata ( ) const

nodiscard

Here is the call graph for this function:

Here is the caller graph for this function:

name()

std::optional< std::string_view > sparrow::run_end_encoded_array::name ( ) const

nodiscard

Here is the caller graph for this function:

operator=() [1/2]

SPARROW_API self_type & sparrow::run_end_encoded_array::operator=

(

const self_type &

)

operator=() [2/2]

self_type & sparrow::run_end_encoded_array::operator= ( self_type && )

default

operator[]() [1/2]

SPARROW_API array_traits::const_reference sparrow::run_end_encoded_array::operator[] ( std::uint64_t i )

nodiscard

operator[]() [2/2]

SPARROW_API array_traits::const_reference sparrow::run_end_encoded_array::operator[] ( std::uint64_t i ) const

nodiscard

size()

SPARROW_API size_type sparrow::run_end_encoded_array::size ( ) const

nodiscard

Friends And Related Symbol Documentation

detail::array_access

friend class detail::array_access

friend

Definition at line 133 of file run_end_encoded_array.hpp.

run_encoded_array_iterator< false >

friend class run_encoded_array_iterator< false >

friend

Definition at line 128 of file run_end_encoded_array.hpp.

run_encoded_array_iterator< true >

friend class run_encoded_array_iterator< true >

friend

Definition at line 128 of file run_end_encoded_array.hpp.

---

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

• /home/runner/work/sparrow/sparrow/include/sparrow/layout/run_end_encoded_layout/run_end_encoded_array.hpp