sparrow 1.0.0
Loading...
Searching...
No Matches
sparrow::fixed_sized_list_array Class Referencefinal

#include <list_array.hpp>

Inheritance diagram for sparrow::fixed_sized_list_array:
[legend]
Collaboration diagram for sparrow::fixed_sized_list_array:
[legend]

Public Types

using self_type = fixed_sized_list_array
 
using inner_types = array_inner_types<self_type>
 
using base_type = list_array_crtp_base<self_type>
 
using list_size_type = inner_types::list_size_type
 
using size_type = typename base_type::size_type
 
using offset_type = std::uint64_t
 
- Public Types inherited from sparrow::list_array_crtp_base< fixed_sized_list_array >
using self_type
 
using base_type
 
using inner_types
 
using value_iterator
 
using const_value_iterator
 
using size_type
 
using bitmap_type
 
using bitmap_const_reference
 
using const_bitmap_range
 
using inner_value_type
 
using inner_reference
 
using inner_const_reference
 
using value_type
 
using const_reference
 
using iterator_tag
 
- Public Types inherited from sparrow::array_bitmap_base_impl< D, false >
using base_type
 
using size_type
 
using bitmap_type
 
using bitmap_iterator
 
using const_bitmap_iterator
 
using bitmap_const_reference
 
using difference_type
 
using const_bitmap_range
 
using iterator_tag
 

Public Member Functions

 fixed_sized_list_array (arrow_proxy proxy)
 Constructs fixed size list array from Arrow proxy.
 
constexpr fixed_sized_list_array (const self_type &)=default
 
fixed_sized_list_arrayoperator= (const self_type &)=default
 
 fixed_sized_list_array (self_type &&)=default
 
fixed_sized_list_arrayoperator= (self_type &&)=default
 
template<class... ARGS>
requires (mpl::excludes_copy_and_move_ctor_v<fixed_sized_list_array, ARGS...>)
 fixed_sized_list_array (ARGS &&... args)
 Generic constructor for creating fixed size list array.
 
- Public Member Functions inherited from sparrow::list_array_crtp_base< fixed_sized_list_array >
constexpr const array_wrapperraw_flat_array () const
 Gets read-only access to the underlying flat array.
 
constexpr array_wrapperraw_flat_array ()
 Gets mutable access to the underlying flat array.
 
- Public Member Functions inherited from sparrow::array_bitmap_base_impl< D, false >
constexpr auto insert_bitmap (const_bitmap_iterator pos, InputIt first, InputIt last) -> bitmap_iterator is_mutable
 
constexpr auto insert_bitmap (const_bitmap_iterator pos, InputIt first, InputIt last) -> bitmap_iterator is_mutable
 

Friends

class array_crtp_base< self_type >
 
class list_array_crtp_base< self_type >
 

Additional Inherited Members

- Protected Member Functions inherited from sparrow::list_array_crtp_base< fixed_sized_list_array >
 list_array_crtp_base (arrow_proxy proxy)
 Constructs list array base from Arrow proxy.
 
constexpr list_array_crtp_base (const self_type &)
 Copy constructor.
 
constexpr list_array_crtp_base (self_type &&) noexcept=default
 
constexpr list_array_crtp_baseoperator= (const self_type &)
 Copy assignment operator.
 
constexpr list_array_crtp_baseoperator= (self_type &&) noexcept=default
 
- Protected Member Functions inherited from sparrow::array_bitmap_base_impl< D, false >
 array_bitmap_base_impl (arrow_proxy proxy)
 Constructs array bitmap base from Arrow proxy.
 
constexpr array_bitmap_base_impl (const array_bitmap_base_impl &)
 Copy constructor.
 
constexpr array_bitmap_base_imploperator= (const array_bitmap_base_impl &)
 Copy assignment operator.
 
constexpr array_bitmap_base_impl (array_bitmap_base_impl &&) noexcept=default
 
constexpr array_bitmap_base_imploperator= (array_bitmap_base_impl &&) noexcept=default
 
constexpr bitmap_typeget_bitmap ()
 Gets mutable reference to the validity bitmap.
 
constexpr const bitmap_typeget_bitmap () const
 Gets const reference to the validity bitmap.
 
constexpr void resize_bitmap (size_type new_length, bool value)
 Resizes the validity bitmap to accommodate new array length.
 
constexpr bitmap_iterator insert_bitmap (const_bitmap_iterator pos, bool value, size_type count)
 Inserts validity bits at specified position.
 
constexpr bitmap_iterator insert_bitmap (const_bitmap_iterator pos, InputIt first, InputIt last) is_mutable
 Inserts range of validity bits at specified position.
 
constexpr bitmap_iterator erase_bitmap (const_bitmap_iterator pos, size_type count)
 Erases validity bits starting at specified position.
 
constexpr void update ()
 Updates internal bitmap after external modifications to Arrow data.
 
constexpr non_owning_dynamic_bitset< uint8_t > get_non_owning_dynamic_bitset ()
 Gets non-owning view of the bitmap as dynamic bitset.
 
constexpr bitmap_type make_bitmap ()
 Creates bitmap wrapper from current Arrow validity buffer.
 
 array_bitmap_base_impl (arrow_proxy proxy)
 Constructs array bitmap base from Arrow proxy.
 
constexpr array_bitmap_base_impl (const array_bitmap_base_impl &)
 Copy constructor.
 
constexpr array_bitmap_base_impl (array_bitmap_base_impl &&) noexcept=default
 
constexpr array_bitmap_base_imploperator= (const array_bitmap_base_impl &)
 Copy assignment operator.
 
constexpr array_bitmap_base_imploperator= (array_bitmap_base_impl &&) noexcept=default
 
constexpr bitmap_typeget_bitmap ()
 Gets mutable reference to the validity bitmap.
 
constexpr const bitmap_typeget_bitmap () const
 Gets const reference to the validity bitmap.
 
constexpr void resize_bitmap (size_type new_length, bool value)
 Resizes the validity bitmap to accommodate new array length.
 
constexpr bitmap_iterator insert_bitmap (const_bitmap_iterator pos, bool value, size_type count)
 Inserts validity bits at specified position.
 
constexpr bitmap_iterator insert_bitmap (const_bitmap_iterator pos, InputIt first, InputIt last) is_mutable
 Inserts range of validity bits at specified position.
 
constexpr bitmap_iterator erase_bitmap (const_bitmap_iterator pos, size_type count)
 Erases validity bits starting at specified position.
 
constexpr void update ()
 Updates internal bitmap after external modifications to Arrow data.
 
constexpr non_owning_dynamic_bitset< uint8_t > get_non_owning_dynamic_bitset ()
 Gets non-owning view of the bitmap as dynamic bitset.
 
constexpr bitmap_type make_bitmap ()
 Creates bitmap wrapper from current Arrow validity buffer.
 

Detailed Description

Definition at line 728 of file list_array.hpp.

Member Typedef Documentation

◆ base_type

◆ inner_types

◆ list_size_type

using sparrow::fixed_sized_list_array::list_size_type = inner_types::list_size_type

Definition at line 735 of file list_array.hpp.

◆ offset_type

Definition at line 737 of file list_array.hpp.

◆ self_type

◆ size_type

using sparrow::fixed_sized_list_array::size_type = typename base_type::size_type

Definition at line 736 of file list_array.hpp.

Constructor & Destructor Documentation

◆ fixed_sized_list_array() [1/4]

sparrow::fixed_sized_list_array::fixed_sized_list_array ( arrow_proxy proxy)
inlineexplicit

Constructs fixed size list array from Arrow proxy.

Parameters
proxyArrow proxy containing fixed size list array data and schema
Precondition
proxy must contain valid Arrow Fixed Size List array and schema
proxy format must be "+w:[size]" where [size] is the list size
proxy format size must be parseable as uint64_t
Postcondition
Array is initialized with data from proxy
List size is extracted from format string

Definition at line 1303 of file list_array.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ fixed_sized_list_array() [2/4]

sparrow::fixed_sized_list_array::fixed_sized_list_array ( const self_type & )
constexprdefault

◆ fixed_sized_list_array() [3/4]

sparrow::fixed_sized_list_array::fixed_sized_list_array ( self_type && )
default

◆ fixed_sized_list_array() [4/4]

template<class... ARGS>
requires (mpl::excludes_copy_and_move_ctor_v<fixed_sized_list_array, ARGS...>)
sparrow::fixed_sized_list_array::fixed_sized_list_array ( ARGS &&... args)
inline

Generic constructor for creating fixed size list array.

Template Parameters
ARGSParameter pack for constructor arguments
Parameters
argsConstructor arguments (list_size, flat_values, validity, etc.)
Precondition
First argument must be the list size (uint64_t)
Second argument must be a valid array for flat values
flat_values.size() must be divisible by list_size
Postcondition
Array is created with the specified list size and data

Definition at line 771 of file list_array.hpp.

Member Function Documentation

◆ operator=() [1/2]

fixed_sized_list_array & sparrow::fixed_sized_list_array::operator= ( const self_type & )
default
Here is the call graph for this function:

◆ operator=() [2/2]

fixed_sized_list_array & sparrow::fixed_sized_list_array::operator= ( self_type && )
default
Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ array_crtp_base< self_type >

friend class array_crtp_base< self_type >
friend

Definition at line 862 of file list_array.hpp.

◆ list_array_crtp_base< self_type >

friend class list_array_crtp_base< self_type >
friend

Definition at line 862 of file list_array.hpp.


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