Files | Functions
Extracting

Files

file  datetime.hpp
 DateTime column APIs.
 

Functions

std::unique_ptr< cudf::columncudf::datetime::extract_year (cudf::column_view const &column, rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
 Extracts year from any date time type and returns an int16_t cudf::column. More...
 
std::unique_ptr< cudf::columncudf::datetime::extract_month (cudf::column_view const &column, rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
 Extracts month from any date time type and returns an int16_t cudf::column. More...
 
std::unique_ptr< cudf::columncudf::datetime::extract_day (cudf::column_view const &column, rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
 Extracts day from any date time type and returns an int16_t cudf::column. More...
 
std::unique_ptr< cudf::columncudf::datetime::extract_weekday (cudf::column_view const &column, rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
 Extracts day from any date time type and returns an int16_t cudf::column. More...
 
std::unique_ptr< cudf::columncudf::datetime::extract_hour (cudf::column_view const &column, rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
 Extracts hour from any date time type and returns an int16_t cudf::column. More...
 
std::unique_ptr< cudf::columncudf::datetime::extract_minute (cudf::column_view const &column, rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
 Extracts minute from any date time type and returns an int16_t cudf::column. More...
 
std::unique_ptr< cudf::columncudf::datetime::extract_second (cudf::column_view const &column, rmm::mr::device_memory_resource *mr=rmm::mr::get_current_device_resource())
 Extracts second from any date time type and returns an int16_t cudf::column. More...
 

Detailed Description

Function Documentation

◆ extract_day()

std::unique_ptr<cudf::column> cudf::datetime::extract_day ( cudf::column_view const &  column,
rmm::mr::device_memory_resource mr = rmm::mr::get_current_device_resource() 
)

Extracts day from any date time type and returns an int16_t cudf::column.

Parameters
columncudf::column_view of the input datetime values
mrDevice memory resource used to allocate device memory of the returned column
Returns
cudf::column of the extracted int16_t days
Exceptions
cudf::logic_errorif input column datatype is not TIMESTAMP

◆ extract_hour()

std::unique_ptr<cudf::column> cudf::datetime::extract_hour ( cudf::column_view const &  column,
rmm::mr::device_memory_resource mr = rmm::mr::get_current_device_resource() 
)

Extracts hour from any date time type and returns an int16_t cudf::column.

Parameters
columncudf::column_view of the input datetime values
mrDevice memory resource used to allocate device memory of the returned column
Returns
cudf::column of the extracted int16_t hours
Exceptions
cudf::logic_errorif input column datatype is not TIMESTAMP

◆ extract_minute()

std::unique_ptr<cudf::column> cudf::datetime::extract_minute ( cudf::column_view const &  column,
rmm::mr::device_memory_resource mr = rmm::mr::get_current_device_resource() 
)

Extracts minute from any date time type and returns an int16_t cudf::column.

Parameters
columncudf::column_view of the input datetime values
mrDevice memory resource used to allocate device memory of the returned column
Returns
cudf::column of the extracted int16_t minutes
Exceptions
cudf::logic_errorif input column datatype is not TIMESTAMP

◆ extract_month()

std::unique_ptr<cudf::column> cudf::datetime::extract_month ( cudf::column_view const &  column,
rmm::mr::device_memory_resource mr = rmm::mr::get_current_device_resource() 
)

Extracts month from any date time type and returns an int16_t cudf::column.

Parameters
columncudf::column_view of the input datetime values
mrDevice memory resource used to allocate device memory of the returned column
Returns
cudf::column of the extracted int16_t months
Exceptions
cudf::logic_errorif input column datatype is not TIMESTAMP

◆ extract_second()

std::unique_ptr<cudf::column> cudf::datetime::extract_second ( cudf::column_view const &  column,
rmm::mr::device_memory_resource mr = rmm::mr::get_current_device_resource() 
)

Extracts second from any date time type and returns an int16_t cudf::column.

Parameters
columncudf::column_view of the input datetime values
mrDevice memory resource used to allocate device memory of the returned column
Returns
cudf::column of the extracted int16_t seconds
Exceptions
cudf::logic_errorif input column datatype is not TIMESTAMP

◆ extract_weekday()

std::unique_ptr<cudf::column> cudf::datetime::extract_weekday ( cudf::column_view const &  column,
rmm::mr::device_memory_resource mr = rmm::mr::get_current_device_resource() 
)

Extracts day from any date time type and returns an int16_t cudf::column.

Parameters
columncudf::column_view of the input datetime values
mrDevice memory resource used to allocate device memory of the returned column
Returns
cudf::column of the extracted int16_t days
Exceptions
cudf::logic_errorif input column datatype is not TIMESTAMP

◆ extract_year()

std::unique_ptr<cudf::column> cudf::datetime::extract_year ( cudf::column_view const &  column,
rmm::mr::device_memory_resource mr = rmm::mr::get_current_device_resource() 
)

Extracts year from any date time type and returns an int16_t cudf::column.

Parameters
columncudf::column_view of the input datetime values
mrDevice memory resource used to allocate device memory of the returned column
Returns
cudf::column of the extracted int16_t years
Exceptions
cudf::logic_errorif input column datatype is not TIMESTAMP