Array< T > Struct Template Reference

#include <heavydbTypes.h>

Public Member Functions
DEVICE	Array (T *ptr, const int64_t size, const bool is_null=false)
DEVICE	Array ()
template<typename M >
HOST	Array (M &mgr, const int64_t size, const bool is_null=false)
DEVICE	Array (const int64_t size, const bool is_null=false)
DEVICE	Array (const flatbuffer::Array< T > &arr)
DEVICE ALWAYS_INLINE T *	data () const
DEVICE ALWAYS_INLINE size_t	size () const
DEVICE T	operator() (const unsigned int index) const
DEVICE T &	operator[] (const unsigned int index)
DEVICE const T &	operator[] (const unsigned int index) const
DEVICE int64_t	getSize () const
DEVICE bool	isNull () const
DEVICE constexpr T	null_value () const
DEVICE bool	isNull (const unsigned int index) const
DEVICE bool	operator== (const Array &other) const
std::string	toString () const

Public Attributes
T *	ptr_
int64_t	size_
int8_t	is_null_

Detailed Description

template<typename T>
struct Array< T >

Definition at line 470 of file heavydbTypes.h.

Constructor & Destructor Documentation

template<typename T>

DEVICE Array< T >::Array ( T *  ptr, const int64_t  size, const bool  is_null = false  )

inline

Definition at line 475 of file heavydbTypes.h.

      : ptr_(is_null ? nullptr : ptr), size_(size), is_null_(is_null) {}

template<typename T>

DEVICE Array< T >::Array ( )

inline

Definition at line 477 of file heavydbTypes.h.

: ptr_(nullptr), size_(0), is_null_(true) {}

template<typename T>

template<typename M >

HOST Array< T >::Array ( M &  mgr, const int64_t  size, const bool  is_null = false  )

inline

Definition at line 481 of file heavydbTypes.h.

References Array< T >::is_null_, Array< T >::ptr_, and heavydb.dtypes::T.

      : size_(size), is_null_(is_null) {
    static_assert(
#ifndef UDF_COMPILED
        (std::is_same<TableFunctionManager, M>::value) ||
#endif  // #ifndef UDF_COMPILED
            (std::is_same<RowFunctionManager, M>::value),
        "M must be a TableFunctionManager or RowFunctionManager");
    if (!is_null_) {
      ptr_ = reinterpret_cast<T*>(mgr.makeBuffer(size, static_cast<int64_t>(sizeof(T))));
    } else {
      ptr_ = nullptr;
    }
  }

template<typename T>

DEVICE Array< T >::Array ( const int64_t  size, const bool  is_null = false  )

inline

Definition at line 497 of file heavydbTypes.h.

References allocate_varlen_buffer(), is_null(), Array< T >::ptr_, and heavydb.dtypes::T.

      : size_(size), is_null_(is_null) {
    if (!is_null) {
      // Memory must be manually released, otherwise leaks can happen.
      // On UDFs, if it is the return argument, memory is released with
      // register_buffer_with_executor_rsm
      ptr_ = reinterpret_cast<T*>(
          allocate_varlen_buffer(size, static_cast<int64_t>(sizeof(T))));
    } else {
      ptr_ = nullptr;
    }
  }

Here is the call graph for this function:

template<typename T>

DEVICE Array< T >::Array ( const flatbuffer::Array< T > &  arr )

inline

Definition at line 510 of file heavydbTypes.h.

References flatbuffer::NestedArray< T >::getValuesBuffer(), Array< T >::is_null_, Array< T >::ptr_, and Array< T >::size_.

                                              {
    bool _is_null;
    arr.getValuesBuffer(ptr_, size_, _is_null);
    is_null_ = _is_null;
  }

Here is the call graph for this function:

Member Function Documentation

template<typename T>

DEVICE ALWAYS_INLINE T* Array< T >::data ( ) const

inline

Definition at line 516 of file heavydbTypes.h.

References Array< T >::ptr_.

Referenced by anonymous_namespace{ExtensionFunctionsArray.hpp}::barray_append_impl(), raw_array_as_array_diff_type(), and raw_array_as_array_same_type().

                                       {
    return ptr_;
  }

Here is the caller graph for this function:

template<typename T>

DEVICE int64_t Array< T >::getSize ( ) const

inline

Definition at line 552 of file heavydbTypes.h.

References Array< T >::size_.

                                 {
    return size_;
  }

template<typename T>

DEVICE bool Array< T >::isNull ( ) const

inline

Definition at line 556 of file heavydbTypes.h.

References Array< T >::is_null_.

Referenced by array_first_half__t32(), anonymous_namespace{ExtensionFunctionsArray.hpp}::array_first_half_impl(), array_second_half__t32(), anonymous_namespace{ExtensionFunctionsArray.hpp}::array_second_half_impl(), Array< T >::operator==(), sum_along_row__cpu_template(), and tarray_append().

                             {
    return is_null_;
  }

Here is the caller graph for this function:

template<typename T>

DEVICE bool Array< T >::isNull ( const unsigned int  index ) const

inline

Definition at line 568 of file heavydbTypes.h.

References Array< T >::is_null_, Array< T >::null_value(), and Array< T >::ptr_.

                                                     {
    return (is_null_ ? false : ptr_[index] == null_value());
  }

Here is the call graph for this function:

template<typename T>

DEVICE constexpr T Array< T >::null_value ( ) const

inline

Definition at line 560 of file heavydbTypes.h.

Referenced by Array< T >::isNull().

                                               {
    if constexpr (std::is_same<T, TextEncodingNone>::value) {
      return {};
    } else {
      return inline_null_value<T>();
    }
  }

Here is the caller graph for this function:

template<typename T>

DEVICE T Array< T >::operator() ( const unsigned int  index ) const

inline

Definition at line 524 of file heavydbTypes.h.

References Array< T >::ptr_, and Array< T >::size_.

                                                      {
#ifndef UDF_COMPILED
    // TODO: implement Array<TextEncodingNone> indexing support
    static_assert(!std::is_same<T, TextEncodingNone>::value);
#endif
    if (index < static_cast<unsigned int>(size_)) {
      return ptr_[index];
    } else {
      return 0;  // see array_at
    }
  }

template<typename T>

DEVICE bool Array< T >::operator== ( const Array< T > &  other ) const

inline

Definition at line 572 of file heavydbTypes.h.

References Array< T >::isNull(), Array< T >::size(), and Array< T >::size_.

                                                   {
    if (isNull() || other.isNull() || size() != other.size()) {
      return false;
    }
    for (int64_t i = 0; i < size_; i++) {
      if ((*this)[i] != other[i]) {
        return false;
      }
    }
    return true;
  }

Here is the call graph for this function:

template<typename T>

DEVICE T& Array< T >::operator[] ( const unsigned int  index )

inline

Definition at line 536 of file heavydbTypes.h.

References Array< T >::ptr_.

                                                 {
#ifndef UDF_COMPILED
    // TODO: implement Array<TextEncodingNone> indexing support
    static_assert(!std::is_same<T, TextEncodingNone>::value);
#endif
    return ptr_[index];
  }

template<typename T>

DEVICE const T& Array< T >::operator[] ( const unsigned int  index ) const

inline

Definition at line 544 of file heavydbTypes.h.

References Array< T >::ptr_.

                                                             {
#ifndef UDF_COMPILED
    // TODO: implement Array<TextEncodingNone> indexing support
    static_assert(!std::is_same<T, TextEncodingNone>::value);
#endif
    return ptr_[index];
  }

template<typename T>

DEVICE ALWAYS_INLINE size_t Array< T >::size ( ) const

inline

Definition at line 520 of file heavydbTypes.h.

References Array< T >::size_.

Referenced by array_append__cpu_template(), anonymous_namespace{ExtensionFunctionsArray.hpp}::array_append_impl(), array_first_half__t32(), anonymous_namespace{ExtensionFunctionsArray.hpp}::array_first_half_impl(), array_second_half__t32(), anonymous_namespace{ExtensionFunctionsArray.hpp}::array_second_half_impl(), array_split__cpu_template(), anonymous_namespace{ExtensionFunctionsArray.hpp}::barray_append_impl(), Array< T >::operator==(), sum_along_row__cpu_template(), and tarray_append().

                                           {
    return size_;
  }

Here is the caller graph for this function:

template<typename T>

std::string Array< T >::toString ( ) const

inline

Definition at line 585 of file heavydbTypes.h.

References Array< T >::is_null_, Array< T >::ptr_, run_benchmark_import::result, Array< T >::size_, to_string(), and typeName().

                             {
    std::string result = ::typeName(this) +
                         "(ptr=" + ::toString(reinterpret_cast<void*>(ptr_)) +
                         ", size=" + std::to_string(size_) +
                         ", is_null=" + std::to_string(is_null_) + ")[";
    for (int64_t i = 0; i < size_; i++) {
      if (size_ > 10) {
        // show the first 8 and the last 2 values in the array:
        if (i == 8) {
          result += "..., ";
        } else if (i > 8 && i < size_ - 2) {
          continue;
        }
      }
      result += ::toString((*this)[i]) + ", ";
    }
    result += "]";
    return result;
  }

Here is the call graph for this function:

Member Data Documentation

template<typename T>

int8_t Array< T >::is_null_

Definition at line 473 of file heavydbTypes.h.

Referenced by Array< T >::Array(), Array< T >::isNull(), and Array< T >::toString().

template<typename T>

T* Array< T >::ptr_

Definition at line 471 of file heavydbTypes.h.

Referenced by Array< T >::Array(), Array< T >::data(), Array< T >::isNull(), Array< T >::operator()(), Array< T >::operator[](), and Array< T >::toString().

template<typename T>

int64_t Array< T >::size_

Definition at line 472 of file heavydbTypes.h.

Referenced by Array< T >::Array(), Array< T >::getSize(), Array< T >::operator()(), Array< T >::operator==(), Array< T >::size(), and Array< T >::toString().

---

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

• /home/jenkins-slave/workspace/core-os-doxygen/QueryEngine/heavydbTypes.h