Public Member Functions | List of all members
cudf::scalar_column_view Struct Reference

A non-owning, immutable view of device data as a column of elements, some of which may be null as indicated by a bitmask. More...

#include <scalar_column_view.hpp>

Inheritance diagram for cudf::scalar_column_view:
cudf::column_view

Public Member Functions

 scalar_column_view (column_view view)
 Construct a scalar_column_view from a column_view. More...
 
column_view const & as_column_view () const noexcept
 Returns a reference to the underlying column_view of this scalar_column_view. More...
 

Detailed Description

A non-owning, immutable view of device data as a column of elements, some of which may be null as indicated by a bitmask.

A scalar_column_view can be constructed explicitly from a cudf::column_view.

Unless otherwise noted, the memory layout of the scalar_column_view's data and bitmask is expected to adhere to the Arrow Physical Memory Layout Specification: https://arrow.apache.org/docs/memory_layout.html

Because scalar_column_view is non-owning, no device memory is allocated nor freed when scalar_column_view objects are created or destroyed.

Definition at line 27 of file scalar_column_view.hpp.

Constructor & Destructor Documentation

◆ scalar_column_view()

cudf::scalar_column_view::scalar_column_view ( column_view  view)
inlineexplicit

Construct a scalar_column_view from a column_view.

Exceptions
cudf::logic_errorif the column view does not have exactly one element.
Parameters
viewThe column view to construct from

Definition at line 33 of file scalar_column_view.hpp.

Member Function Documentation

◆ as_column_view()

column_view const& cudf::scalar_column_view::as_column_view ( ) const
inlinenoexcept

Returns a reference to the underlying column_view of this scalar_column_view.

Returns
A reference to the underlying column_view

Definition at line 54 of file scalar_column_view.hpp.


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