Public Member Functions | List of all members
cudf::data_type Class Reference

Indicator for the logical data type of an element in a column. More...

#include <types.hpp>

Public Member Functions

 data_type (data_type const &)=default
 Copy constructor.
 
 data_type (data_type &&)=default
 Move constructor.
 
data_typeoperator= (data_type const &)=default
 Copy assignment operator for data_type. More...
 
data_typeoperator= (data_type &&)=default
 Move assignment operator for data_type. More...
 
constexpr data_type (type_id id)
 Construct a new data_type object. More...
 
 data_type (type_id id, int32_t scale)
 Construct a new data_type object for numeric::fixed_point More...
 
constexpr type_id id () const noexcept
 Returns the type identifier. More...
 
constexpr int32_t scale () const noexcept
 Returns the scale (for fixed_point types) More...
 

Detailed Description

Indicator for the logical data type of an element in a column.

Simple types can be entirely described by their id(), but some types require additional metadata to fully describe elements of that type.

Definition at line 241 of file types.hpp.

Constructor & Destructor Documentation

◆ data_type() [1/2]

constexpr cudf::data_type::data_type ( type_id  id)
inlineexplicitconstexpr

Construct a new data_type object.

Parameters
idThe type's identifier

Definition at line 267 of file types.hpp.

◆ data_type() [2/2]

cudf::data_type::data_type ( type_id  id,
int32_t  scale 
)
inlineexplicit

Construct a new data_type object for numeric::fixed_point

Parameters
idThe fixed_point's identifier
scaleThe fixed_point's scale (see fixed_point::_scale)

Definition at line 275 of file types.hpp.

Member Function Documentation

◆ id()

constexpr type_id cudf::data_type::id ( ) const
inlineconstexprnoexcept

Returns the type identifier.

Returns
The type identifier

Definition at line 285 of file types.hpp.

◆ operator=() [1/2]

data_type& cudf::data_type::operator= ( data_type &&  )
default

Move assignment operator for data_type.

Returns
Reference to this object

◆ operator=() [2/2]

data_type& cudf::data_type::operator= ( data_type const &  )
default

Copy assignment operator for data_type.

Returns
Reference to this object

◆ scale()

constexpr int32_t cudf::data_type::scale ( ) const
inlineconstexprnoexcept

Returns the scale (for fixed_point types)

Returns
The scale

Definition at line 292 of file types.hpp.


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