Public Member Functions | Static Public Member Functions | List of all members
cudf::io::csv_reader_options Class Reference

Settings to use for read_csv(). More...

#include <csv.hpp>

Public Member Functions

 csv_reader_options ()=default
 Default constructor. More...
 
source_info const & get_source () const
 Returns source info. More...
 
compression_type get_compression () const
 Returns compression format of the source. More...
 
std::size_t get_byte_range_offset () const
 Returns number of bytes to skip from source start. More...
 
std::size_t get_byte_range_size () const
 Returns number of bytes to read. More...
 
std::size_t get_byte_range_size_with_padding () const
 Returns number of bytes to read with padding. More...
 
std::size_t get_byte_range_padding () const
 Returns number of bytes to pad when reading. More...
 
std::vector< std::string > const & get_names () const
 Returns names of the columns. More...
 
std::string get_prefix () const
 Returns prefix to be used for column ID. More...
 
bool is_enabled_mangle_dupe_cols () const
 Whether to rename duplicate column names. More...
 
std::vector< std::string > const & get_use_cols_names () const
 Returns names of the columns to be read. More...
 
std::vector< int > const & get_use_cols_indexes () const
 Returns indexes of columns to read. More...
 
size_type get_nrows () const
 Returns number of rows to read. More...
 
size_type get_skiprows () const
 Returns number of rows to skip from start. More...
 
size_type get_skipfooter () const
 Returns number of rows to skip from end. More...
 
size_type get_header () const
 Returns header row index. More...
 
char get_lineterminator () const
 Returns line terminator. More...
 
char get_delimiter () const
 Returns field delimiter. More...
 
char get_thousands () const
 Returns numeric data thousands separator. More...
 
char get_decimal () const
 Returns decimal point character. More...
 
char get_comment () const
 Returns comment line start character. More...
 
bool is_enabled_windowslinetermination () const
 Whether to treat \r\n as line terminator. More...
 
bool is_enabled_delim_whitespace () const
 Whether to treat whitespace as field delimiter. More...
 
bool is_enabled_skipinitialspace () const
 Whether to skip whitespace after the delimiter. More...
 
bool is_enabled_skip_blank_lines () const
 Whether to ignore empty lines or parse line values as invalid. More...
 
quote_style get_quoting () const
 Returns quoting style. More...
 
char get_quotechar () const
 Returns quoting character. More...
 
bool is_enabled_doublequote () const
 Whether a quote inside a value is double-quoted. More...
 
bool is_enabled_detect_whitespace_around_quotes () const
 Whether to detect quotes surrounded by spaces e.g. "data". This flag has no effect when _doublequote is true. More...
 
std::vector< std::string > const & get_parse_dates_names () const
 Returns names of columns to read as datetime. More...
 
std::vector< int > const & get_parse_dates_indexes () const
 Returns indexes of columns to read as datetime. More...
 
std::vector< std::string > const & get_parse_hex_names () const
 Returns names of columns to read as hexadecimal. More...
 
std::vector< int > const & get_parse_hex_indexes () const
 Returns indexes of columns to read as hexadecimal. More...
 
std::variant< std::vector< data_type >, std::map< std::string, data_type > > const & get_dtypes () const
 Returns per-column types. More...
 
std::vector< std::string > const & get_true_values () const
 Returns additional values to recognize as boolean true values. More...
 
std::vector< std::string > const & get_false_values () const
 Returns additional values to recognize as boolean false values. More...
 
std::vector< std::string > const & get_na_values () const
 Returns additional values to recognize as null values. More...
 
bool is_enabled_keep_default_na () const
 Whether to keep the built-in default NA values. More...
 
bool is_enabled_na_filter () const
 Whether to disable null filter. More...
 
bool is_enabled_dayfirst () const
 Whether to parse dates as DD/MM versus MM/DD. More...
 
data_type get_timestamp_type () const
 Returns timestamp_type to which all timestamp columns will be cast. More...
 
void set_compression (compression_type comp)
 Sets compression format of the source. More...
 
void set_byte_range_offset (std::size_t offset)
 Sets number of bytes to skip from source start. More...
 
void set_byte_range_size (std::size_t size)
 Sets number of bytes to read. More...
 
void set_names (std::vector< std::string > col_names)
 Sets names of the column. More...
 
void set_prefix (std::string pfx)
 Sets prefix to be used for column ID. More...
 
void enable_mangle_dupe_cols (bool val)
 Sets whether to rename duplicate column names. More...
 
void set_use_cols_names (std::vector< std::string > col_names)
 Sets names of the columns to be read. More...
 
void set_use_cols_indexes (std::vector< int > col_indices)
 Sets indexes of columns to read. More...
 
void set_nrows (size_type nrows)
 Sets number of rows to read. More...
 
void set_skiprows (size_type skiprows)
 Sets number of rows to skip from start. More...
 
void set_skipfooter (size_type skipfooter)
 Sets number of rows to skip from end. More...
 
void set_header (size_type hdr)
 Sets header row index. More...
 
void set_lineterminator (char term)
 Sets line terminator. More...
 
void set_delimiter (char delim)
 Sets field delimiter. More...
 
void set_thousands (char val)
 Sets numeric data thousands separator. More...
 
void set_decimal (char val)
 Sets decimal point character. More...
 
void set_comment (char val)
 Sets comment line start character. More...
 
void enable_windowslinetermination (bool val)
 Sets whether to treat \r\n as line terminator. More...
 
void enable_delim_whitespace (bool val)
 Sets whether to treat whitespace as field delimiter. More...
 
void enable_skipinitialspace (bool val)
 Sets whether to skip whitespace after the delimiter. More...
 
void enable_skip_blank_lines (bool val)
 Sets whether to ignore empty lines or parse line values as invalid. More...
 
void set_quoting (quote_style quoting)
 Sets the expected quoting style used in the input CSV data. More...
 
void set_quotechar (char ch)
 Sets quoting character. More...
 
void enable_doublequote (bool val)
 Sets a quote inside a value is double-quoted. More...
 
void enable_detect_whitespace_around_quotes (bool val)
 Sets whether to detect quotes surrounded by spaces e.g. "data". This flag has no effect when _doublequote is true. More...
 
void set_parse_dates (std::vector< std::string > col_names)
 Sets names of columns to read as datetime. More...
 
void set_parse_dates (std::vector< int > col_indices)
 Sets indexes of columns to read as datetime. More...
 
void set_parse_hex (std::vector< std::string > col_names)
 Sets names of columns to parse as hexadecimal. More...
 
void set_parse_hex (std::vector< int > col_indices)
 Sets indexes of columns to parse as hexadecimal. More...
 
void set_dtypes (std::map< std::string, data_type > types)
 Sets per-column types. More...
 
void set_dtypes (std::vector< data_type > types)
 Sets per-column types. More...
 
void set_true_values (std::vector< std::string > vals)
 Sets additional values to recognize as boolean true values. More...
 
void set_false_values (std::vector< std::string > vals)
 Sets additional values to recognize as boolean false values. More...
 
void set_na_values (std::vector< std::string > vals)
 Sets additional values to recognize as null values. More...
 
void enable_keep_default_na (bool val)
 Sets whether to keep the built-in default NA values. More...
 
void enable_na_filter (bool val)
 Sets whether to disable null filter. More...
 
void enable_dayfirst (bool val)
 Sets whether to parse dates as DD/MM versus MM/DD. More...
 
void set_timestamp_type (data_type type)
 Sets timestamp_type to which all timestamp columns will be cast. More...
 

Static Public Member Functions

static csv_reader_options_builder builder (source_info src)
 Creates a csv_reader_options_builder which will build csv_reader_options. More...
 

Detailed Description

Settings to use for read_csv().

Definition at line 50 of file csv.hpp.

Constructor & Destructor Documentation

◆ csv_reader_options()

cudf::io::csv_reader_options::csv_reader_options ( )
default

Default constructor.

This has been added since Cython requires a default constructor to create objects on stack.

Member Function Documentation

◆ builder()

static csv_reader_options_builder cudf::io::csv_reader_options::builder ( source_info  src)
static

Creates a csv_reader_options_builder which will build csv_reader_options.

Parameters
srcSource information to read csv file
Returns
Builder to build reader options

◆ enable_dayfirst()

void cudf::io::csv_reader_options::enable_dayfirst ( bool  val)
inline

Sets whether to parse dates as DD/MM versus MM/DD.

Parameters
valBoolean value to enable/disable

Definition at line 831 of file csv.hpp.

◆ enable_delim_whitespace()

void cudf::io::csv_reader_options::enable_delim_whitespace ( bool  val)
inline

Sets whether to treat whitespace as field delimiter.

Parameters
valBoolean value to enable/disable

Definition at line 668 of file csv.hpp.

◆ enable_detect_whitespace_around_quotes()

void cudf::io::csv_reader_options::enable_detect_whitespace_around_quotes ( bool  val)
inline

Sets whether to detect quotes surrounded by spaces e.g. "data". This flag has no effect when _doublequote is true.

Parameters
valBoolean value to enable/disable

Definition at line 721 of file csv.hpp.

◆ enable_doublequote()

void cudf::io::csv_reader_options::enable_doublequote ( bool  val)
inline

Sets a quote inside a value is double-quoted.

Parameters
valBoolean value to enable/disable

Definition at line 713 of file csv.hpp.

◆ enable_keep_default_na()

void cudf::io::csv_reader_options::enable_keep_default_na ( bool  val)
inline

Sets whether to keep the built-in default NA values.

Parameters
valBoolean value to enable/disable

Definition at line 813 of file csv.hpp.

◆ enable_mangle_dupe_cols()

void cudf::io::csv_reader_options::enable_mangle_dupe_cols ( bool  val)
inline

Sets whether to rename duplicate column names.

Parameters
valBoolean value to enable/disable

Definition at line 544 of file csv.hpp.

◆ enable_na_filter()

void cudf::io::csv_reader_options::enable_na_filter ( bool  val)
inline

Sets whether to disable null filter.

Parameters
valBoolean value to enable/disable

Definition at line 820 of file csv.hpp.

◆ enable_skip_blank_lines()

void cudf::io::csv_reader_options::enable_skip_blank_lines ( bool  val)
inline

Sets whether to ignore empty lines or parse line values as invalid.

Parameters
valBoolean value to enable/disable

Definition at line 682 of file csv.hpp.

◆ enable_skipinitialspace()

void cudf::io::csv_reader_options::enable_skipinitialspace ( bool  val)
inline

Sets whether to skip whitespace after the delimiter.

Parameters
valBoolean value to enable/disable

Definition at line 675 of file csv.hpp.

◆ enable_windowslinetermination()

void cudf::io::csv_reader_options::enable_windowslinetermination ( bool  val)
inline

Sets whether to treat \r\n as line terminator.

Parameters
valBoolean value to enable/disable

Definition at line 661 of file csv.hpp.

◆ get_byte_range_offset()

std::size_t cudf::io::csv_reader_options::get_byte_range_offset ( ) const
inline

Returns number of bytes to skip from source start.

Returns
Number of bytes to skip from source start

Definition at line 183 of file csv.hpp.

◆ get_byte_range_padding()

std::size_t cudf::io::csv_reader_options::get_byte_range_padding ( ) const
inline

Returns number of bytes to pad when reading.

Returns
Number of bytes to pad when reading

Definition at line 211 of file csv.hpp.

◆ get_byte_range_size()

std::size_t cudf::io::csv_reader_options::get_byte_range_size ( ) const
inline

Returns number of bytes to read.

Returns
Number of bytes to read

Definition at line 190 of file csv.hpp.

◆ get_byte_range_size_with_padding()

std::size_t cudf::io::csv_reader_options::get_byte_range_size_with_padding ( ) const
inline

Returns number of bytes to read with padding.

Returns
Number of bytes to read with padding

Definition at line 197 of file csv.hpp.

◆ get_comment()

char cudf::io::csv_reader_options::get_comment ( ) const
inline

Returns comment line start character.

Returns
Comment line start character

Definition at line 329 of file csv.hpp.

◆ get_compression()

compression_type cudf::io::csv_reader_options::get_compression ( ) const
inline

Returns compression format of the source.

Returns
Compression format of the source

Definition at line 176 of file csv.hpp.

◆ get_decimal()

char cudf::io::csv_reader_options::get_decimal ( ) const
inline

Returns decimal point character.

Returns
Decimal point character

Definition at line 322 of file csv.hpp.

◆ get_delimiter()

char cudf::io::csv_reader_options::get_delimiter ( ) const
inline

Returns field delimiter.

Returns
Field delimiter

Definition at line 308 of file csv.hpp.

◆ get_dtypes()

std::variant<std::vector<data_type>, std::map<std::string, data_type> > const& cudf::io::csv_reader_options::get_dtypes ( ) const
inline

Returns per-column types.

Returns
Per-column types

Definition at line 434 of file csv.hpp.

◆ get_false_values()

std::vector<std::string> const& cudf::io::csv_reader_options::get_false_values ( ) const
inline

Returns additional values to recognize as boolean false values.

Returns
Additional values to recognize as boolean false values

Definition at line 451 of file csv.hpp.

◆ get_header()

size_type cudf::io::csv_reader_options::get_header ( ) const
inline

Returns header row index.

Returns
Header row index

Definition at line 294 of file csv.hpp.

◆ get_lineterminator()

char cudf::io::csv_reader_options::get_lineterminator ( ) const
inline

Returns line terminator.

Returns
Line terminator

Definition at line 301 of file csv.hpp.

◆ get_na_values()

std::vector<std::string> const& cudf::io::csv_reader_options::get_na_values ( ) const
inline

Returns additional values to recognize as null values.

Returns
Additional values to recognize as null values

Definition at line 458 of file csv.hpp.

◆ get_names()

std::vector<std::string> const& cudf::io::csv_reader_options::get_names ( ) const
inline

Returns names of the columns.

Returns
Names of the columns

Definition at line 235 of file csv.hpp.

◆ get_nrows()

size_type cudf::io::csv_reader_options::get_nrows ( ) const
inline

Returns number of rows to read.

Returns
Number of rows to read

Definition at line 273 of file csv.hpp.

◆ get_parse_dates_indexes()

std::vector<int> const& cudf::io::csv_reader_options::get_parse_dates_indexes ( ) const
inline

Returns indexes of columns to read as datetime.

Returns
Indexes of columns to read as datetime

Definition at line 406 of file csv.hpp.

◆ get_parse_dates_names()

std::vector<std::string> const& cudf::io::csv_reader_options::get_parse_dates_names ( ) const
inline

Returns names of columns to read as datetime.

Returns
Names of columns to read as datetime

Definition at line 396 of file csv.hpp.

◆ get_parse_hex_indexes()

std::vector<int> const& cudf::io::csv_reader_options::get_parse_hex_indexes ( ) const
inline

Returns indexes of columns to read as hexadecimal.

Returns
Indexes of columns to read as hexadecimal

Definition at line 426 of file csv.hpp.

◆ get_parse_hex_names()

std::vector<std::string> const& cudf::io::csv_reader_options::get_parse_hex_names ( ) const
inline

Returns names of columns to read as hexadecimal.

Returns
Names of columns to read as hexadecimal

Definition at line 416 of file csv.hpp.

◆ get_prefix()

std::string cudf::io::csv_reader_options::get_prefix ( ) const
inline

Returns prefix to be used for column ID.

Returns
Prefix to be used for column ID

Definition at line 242 of file csv.hpp.

◆ get_quotechar()

char cudf::io::csv_reader_options::get_quotechar ( ) const
inline

Returns quoting character.

Returns
Quoting character

Definition at line 371 of file csv.hpp.

◆ get_quoting()

quote_style cudf::io::csv_reader_options::get_quoting ( ) const
inline

Returns quoting style.

Returns
Quoting style

Definition at line 364 of file csv.hpp.

◆ get_skipfooter()

size_type cudf::io::csv_reader_options::get_skipfooter ( ) const
inline

Returns number of rows to skip from end.

Returns
Number of rows to skip from end

Definition at line 287 of file csv.hpp.

◆ get_skiprows()

size_type cudf::io::csv_reader_options::get_skiprows ( ) const
inline

Returns number of rows to skip from start.

Returns
Number of rows to skip from start

Definition at line 280 of file csv.hpp.

◆ get_source()

source_info const& cudf::io::csv_reader_options::get_source ( ) const
inline

Returns source info.

Returns
Source info

Definition at line 169 of file csv.hpp.

◆ get_thousands()

char cudf::io::csv_reader_options::get_thousands ( ) const
inline

Returns numeric data thousands separator.

Returns
Numeric data thousands separator

Definition at line 315 of file csv.hpp.

◆ get_timestamp_type()

data_type cudf::io::csv_reader_options::get_timestamp_type ( ) const
inline

Returns timestamp_type to which all timestamp columns will be cast.

Returns
timestamp_type to which all timestamp columns will be cast

Definition at line 486 of file csv.hpp.

◆ get_true_values()

std::vector<std::string> const& cudf::io::csv_reader_options::get_true_values ( ) const
inline

Returns additional values to recognize as boolean true values.

Returns
Additional values to recognize as boolean true values

Definition at line 444 of file csv.hpp.

◆ get_use_cols_indexes()

std::vector<int> const& cudf::io::csv_reader_options::get_use_cols_indexes ( ) const
inline

Returns indexes of columns to read.

Returns
Indexes of columns to read

Definition at line 266 of file csv.hpp.

◆ get_use_cols_names()

std::vector<std::string> const& cudf::io::csv_reader_options::get_use_cols_names ( ) const
inline

Returns names of the columns to be read.

Returns
Names of the columns to be read

Definition at line 256 of file csv.hpp.

◆ is_enabled_dayfirst()

bool cudf::io::csv_reader_options::is_enabled_dayfirst ( ) const
inline

Whether to parse dates as DD/MM versus MM/DD.

Returns
True if dates are parsed as DD/MM, false if MM/DD

Definition at line 479 of file csv.hpp.

◆ is_enabled_delim_whitespace()

bool cudf::io::csv_reader_options::is_enabled_delim_whitespace ( ) const
inline

Whether to treat whitespace as field delimiter.

Returns
true if whitespace is treated as field delimiter

Definition at line 343 of file csv.hpp.

◆ is_enabled_detect_whitespace_around_quotes()

bool cudf::io::csv_reader_options::is_enabled_detect_whitespace_around_quotes ( ) const
inline

Whether to detect quotes surrounded by spaces e.g. "data". This flag has no effect when _doublequote is true.

Returns
true if detect_whitespace_around_quotes is enabled

Definition at line 386 of file csv.hpp.

◆ is_enabled_doublequote()

bool cudf::io::csv_reader_options::is_enabled_doublequote ( ) const
inline

Whether a quote inside a value is double-quoted.

Returns
true if a quote inside a value is double-quoted

Definition at line 378 of file csv.hpp.

◆ is_enabled_keep_default_na()

bool cudf::io::csv_reader_options::is_enabled_keep_default_na ( ) const
inline

Whether to keep the built-in default NA values.

Returns
true if the built-in default NA values are kept

Definition at line 465 of file csv.hpp.

◆ is_enabled_mangle_dupe_cols()

bool cudf::io::csv_reader_options::is_enabled_mangle_dupe_cols ( ) const
inline

Whether to rename duplicate column names.

Returns
true if duplicate column names are renamed

Definition at line 249 of file csv.hpp.

◆ is_enabled_na_filter()

bool cudf::io::csv_reader_options::is_enabled_na_filter ( ) const
inline

Whether to disable null filter.

Returns
true if null filter is enabled

Definition at line 472 of file csv.hpp.

◆ is_enabled_skip_blank_lines()

bool cudf::io::csv_reader_options::is_enabled_skip_blank_lines ( ) const
inline

Whether to ignore empty lines or parse line values as invalid.

Returns
true if empty lines or parse line values are ignored as invalid

Definition at line 357 of file csv.hpp.

◆ is_enabled_skipinitialspace()

bool cudf::io::csv_reader_options::is_enabled_skipinitialspace ( ) const
inline

Whether to skip whitespace after the delimiter.

Returns
true if whitespace is skipped after the delimiter

Definition at line 350 of file csv.hpp.

◆ is_enabled_windowslinetermination()

bool cudf::io::csv_reader_options::is_enabled_windowslinetermination ( ) const
inline

Whether to treat \r\n as line terminator.

Returns
true if \r\n is treated as line terminator

Definition at line 336 of file csv.hpp.

◆ set_byte_range_offset()

void cudf::io::csv_reader_options::set_byte_range_offset ( std::size_t  offset)
inline

Sets number of bytes to skip from source start.

Parameters
offsetNumber of bytes of offset

Definition at line 500 of file csv.hpp.

◆ set_byte_range_size()

void cudf::io::csv_reader_options::set_byte_range_size ( std::size_t  size)
inline

Sets number of bytes to read.

Parameters
sizeNumber of bytes to read

Definition at line 515 of file csv.hpp.

◆ set_comment()

void cudf::io::csv_reader_options::set_comment ( char  val)
inline

Sets comment line start character.

Parameters
valA character that indicates comment

Definition at line 654 of file csv.hpp.

◆ set_compression()

void cudf::io::csv_reader_options::set_compression ( compression_type  comp)
inline

Sets compression format of the source.

Parameters
compCompression type

Definition at line 493 of file csv.hpp.

◆ set_decimal()

void cudf::io::csv_reader_options::set_decimal ( char  val)
inline

Sets decimal point character.

Parameters
valA character that indicates decimal values

Definition at line 647 of file csv.hpp.

◆ set_delimiter()

void cudf::io::csv_reader_options::set_delimiter ( char  delim)
inline

Sets field delimiter.

Parameters
delimA character to indicate delimiter

Definition at line 633 of file csv.hpp.

◆ set_dtypes() [1/2]

void cudf::io::csv_reader_options::set_dtypes ( std::map< std::string, data_type types)
inline

Sets per-column types.

Parameters
typesColumn name -> data type map specifying the columns' target data types

Definition at line 765 of file csv.hpp.

◆ set_dtypes() [2/2]

void cudf::io::csv_reader_options::set_dtypes ( std::vector< data_type types)
inline

Sets per-column types.

Parameters
typesVector specifying the columns' target data types

Definition at line 772 of file csv.hpp.

◆ set_false_values()

void cudf::io::csv_reader_options::set_false_values ( std::vector< std::string >  vals)
inline

Sets additional values to recognize as boolean false values.

Parameters
valsVector of values to be considered to be false

Definition at line 789 of file csv.hpp.

◆ set_header()

void cudf::io::csv_reader_options::set_header ( size_type  hdr)
inline

Sets header row index.

Parameters
hdrIndex where header row is located

Definition at line 619 of file csv.hpp.

◆ set_lineterminator()

void cudf::io::csv_reader_options::set_lineterminator ( char  term)
inline

Sets line terminator.

Parameters
termA character to indicate line termination

Definition at line 626 of file csv.hpp.

◆ set_na_values()

void cudf::io::csv_reader_options::set_na_values ( std::vector< std::string >  vals)
inline

Sets additional values to recognize as null values.

Parameters
valsVector of values to be considered to be null

Definition at line 799 of file csv.hpp.

◆ set_names()

void cudf::io::csv_reader_options::set_names ( std::vector< std::string >  col_names)
inline

Sets names of the column.

Parameters
col_namesVector of column names

Definition at line 530 of file csv.hpp.

◆ set_nrows()

void cudf::io::csv_reader_options::set_nrows ( size_type  nrows)
inline

Sets number of rows to read.

Parameters
nrowsNumber of rows to read

Definition at line 571 of file csv.hpp.

◆ set_parse_dates() [1/2]

void cudf::io::csv_reader_options::set_parse_dates ( std::vector< int >  col_indices)
inline

Sets indexes of columns to read as datetime.

Parameters
col_indicesVector of column indices to infer as datetime

Definition at line 738 of file csv.hpp.

◆ set_parse_dates() [2/2]

void cudf::io::csv_reader_options::set_parse_dates ( std::vector< std::string >  col_names)
inline

Sets names of columns to read as datetime.

Parameters
col_namesVector of column names to infer as datetime

Definition at line 728 of file csv.hpp.

◆ set_parse_hex() [1/2]

void cudf::io::csv_reader_options::set_parse_hex ( std::vector< int >  col_indices)
inline

Sets indexes of columns to parse as hexadecimal.

Parameters
col_indicesVector of column indices to parse as hexadecimal

Definition at line 758 of file csv.hpp.

◆ set_parse_hex() [2/2]

void cudf::io::csv_reader_options::set_parse_hex ( std::vector< std::string >  col_names)
inline

Sets names of columns to parse as hexadecimal.

Parameters
col_namesVector of column names to parse as hexadecimal

Definition at line 748 of file csv.hpp.

◆ set_prefix()

void cudf::io::csv_reader_options::set_prefix ( std::string  pfx)
inline

Sets prefix to be used for column ID.

Parameters
pfxString used as prefix in for each column name

Definition at line 537 of file csv.hpp.

◆ set_quotechar()

void cudf::io::csv_reader_options::set_quotechar ( char  ch)
inline

Sets quoting character.

Parameters
chA character to indicate quoting

Definition at line 706 of file csv.hpp.

◆ set_quoting()

void cudf::io::csv_reader_options::set_quoting ( quote_style  quoting)
inline

Sets the expected quoting style used in the input CSV data.

Note: Only the following quoting styles are supported:

  1. MINIMAL: String columns containing special characters like row-delimiters/ field-delimiter/quotes will be quoted.
  2. NONE: No quoting is done for any columns.
Parameters
quotingQuoting style used

Definition at line 694 of file csv.hpp.

◆ set_skipfooter()

void cudf::io::csv_reader_options::set_skipfooter ( size_type  skipfooter)
inline

Sets number of rows to skip from end.

Parameters
skipfooterNumber of rows to skip

Definition at line 601 of file csv.hpp.

◆ set_skiprows()

void cudf::io::csv_reader_options::set_skiprows ( size_type  skiprows)
inline

Sets number of rows to skip from start.

Parameters
skiprowsNumber of rows to skip

Definition at line 587 of file csv.hpp.

◆ set_thousands()

void cudf::io::csv_reader_options::set_thousands ( char  val)
inline

Sets numeric data thousands separator.

Parameters
valA character that separates thousands

Definition at line 640 of file csv.hpp.

◆ set_timestamp_type()

void cudf::io::csv_reader_options::set_timestamp_type ( data_type  type)
inline

Sets timestamp_type to which all timestamp columns will be cast.

Parameters
typeDtype to which all timestamp column will be cast

Definition at line 838 of file csv.hpp.

◆ set_true_values()

void cudf::io::csv_reader_options::set_true_values ( std::vector< std::string >  vals)
inline

Sets additional values to recognize as boolean true values.

Parameters
valsVector of values to be considered to be true

Definition at line 779 of file csv.hpp.

◆ set_use_cols_indexes()

void cudf::io::csv_reader_options::set_use_cols_indexes ( std::vector< int >  col_indices)
inline

Sets indexes of columns to read.

Parameters
col_indicesVector of column indices that are needed

Definition at line 561 of file csv.hpp.

◆ set_use_cols_names()

void cudf::io::csv_reader_options::set_use_cols_names ( std::vector< std::string >  col_names)
inline

Sets names of the columns to be read.

Parameters
col_namesVector of column names that are needed

Definition at line 551 of file csv.hpp.


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