公有成员函数 | 所有成员列表
cudf::io::csv_reader_options_builder 类参考

用于构建 read_csv() 选项的构建器。 更多...

#include <csv.hpp>

公有成员函数

 csv_reader_options_builder ()=default
 默认构造函数。 更多...
 
 csv_reader_options_builder (source_info src)
 从源信息构造的构造函数。 更多...
 
csv_reader_options_buildercompression (compression_type comp)
 设置源的压缩格式。 更多...
 
csv_reader_options_builderbyte_range_offset (std::size_t offset)
 设置从源开始跳过的字节数。 更多...
 
csv_reader_options_builderbyte_range_size (std::size_t size)
 设置要读取的字节数。 更多...
 
csv_reader_options_buildernames (std::vector< std::string > col_names)
 设置列的名称。 更多...
 
csv_reader_options_builderprefix (std::string pfx)
 设置用于列 ID 的前缀。 更多...
 
csv_reader_options_buildermangle_dupe_cols (bool val)
 设置是否重命名重复的列名。 更多...
 
csv_reader_options_builderuse_cols_names (std::vector< std::string > col_names)
 设置要读取的列的名称。 更多...
 
csv_reader_options_builderuse_cols_indexes (std::vector< int > col_indices)
 设置要读取的列的索引。 更多...
 
csv_reader_options_buildernrows (size_type rows)
 设置要读取的行数。 更多...
 
csv_reader_options_builderskiprows (size_type skip)
 设置从开始跳过的行数。 更多...
 
csv_reader_options_builderskipfooter (size_type skip)
 设置从末尾跳过的行数。 更多...
 
csv_reader_options_builderheader (size_type hdr)
 设置标题行索引。 更多...
 
csv_reader_options_builderlineterminator (char term)
 设置行终止符。 更多...
 
csv_reader_options_builderdelimiter (char delim)
 设置字段分隔符。 更多...
 
csv_reader_options_builderthousands (char val)
 设置数字数据的千位分隔符。 更多...
 
csv_reader_options_builderdecimal (char val)
 设置小数点字符。 更多...
 
csv_reader_options_buildercomment (char val)
 设置注释行起始字符。 更多...
 
csv_reader_options_builderwindowslinetermination (bool val)
 设置是否将 \r\n 视为行终止符。 更多...
 
csv_reader_options_builderdelim_whitespace (bool val)
 设置是否将空格视作字段分隔符。 更多...
 
csv_reader_options_builderskipinitialspace (bool val)
 设置是否跳过分隔符后的空格。 更多...
 
csv_reader_options_builderskip_blank_lines (bool val)
 设置是否忽略空行或将行值解析为无效值。 更多...
 
csv_reader_options_builderquoting (quote_style style)
 设置引用样式。 更多...
 
csv_reader_options_builderquotechar (char ch)
 设置引用字符。 更多...
 
csv_reader_options_builderdoublequote (bool val)
 设置值内的引号是否双重引用。 更多...
 
csv_reader_options_builderdetect_whitespace_around_quotes (bool val)
 设置是否检测被空格包围的引号,例如 "data"。当 _doublequote 为 true 时,此标志无效。 更多...
 
csv_reader_options_builderparse_dates (std::vector< std::string > col_names)
 设置要读取为日期时间类型的列名。 更多...
 
csv_reader_options_builderparse_dates (std::vector< int > col_indices)
 设置要读取为日期时间类型的列索引。 更多...
 
csv_reader_options_builderparse_hex (std::vector< std::string > col_names)
 设置要解析为十六进制的列名。 更多...
 
csv_reader_options_builderparse_hex (std::vector< int > col_indices)
 设置要解析为十六进制的列索引。 更多...
 
csv_reader_options_builderdtypes (std::map< std::string, data_type > types)
 设置每列类型。 更多...
 
csv_reader_options_builderdtypes (std::vector< data_type > types)
 设置每列类型。 更多...
 
csv_reader_options_buildertrue_values (std::vector< std::string > vals)
 设置要识别为布尔值 true 的附加值。 更多...
 
csv_reader_options_builderfalse_values (std::vector< std::string > vals)
 设置要识别为布尔值 false 的附加值。 更多...
 
csv_reader_options_builderna_values (std::vector< std::string > vals)
 设置要识别为空值的附加值。 更多...
 
csv_reader_options_builderkeep_default_na (bool val)
 设置是否保留内置的默认 NA 值。 更多...
 
csv_reader_options_builderna_filter (bool val)
 设置是否禁用空值过滤。 更多...
 
csv_reader_options_builderdayfirst (bool val)
 设置是否将日期解析为 DD/MM 格式,而不是 MM/DD 格式。 更多...
 
csv_reader_options_buildertimestamp_type (data_type type)
 设置所有时间戳列将被转换为的时间戳类型。 更多...
 
 operator csv_reader_options && ()
 csv_reader_options 成员一旦构建完毕,将其移动。
 
csv_reader_options && build ()
 csv_reader_options 成员一旦构建完毕,将其移动。 更多...
 

详细描述

用于构建 read_csv() 选项的构建器。

定义于文件 csv.hpp 的第 845 行。

构造函数和析构函数文档

◆ csv_reader_options_builder() [1/2]

cudf::io::csv_reader_options_builder::csv_reader_options_builder ( )
默认

默认构造函数。

由于 Cython 需要一个默认构造函数来在栈上创建对象,因此添加了此构造函数。

◆ csv_reader_options_builder() [2/2]

cudf::io::csv_reader_options_builder::csv_reader_options_builder ( source_info  src)
内联

从源信息构造的构造函数。

参数
src用于读取 csv 文件的源信息

定义于文件 csv.hpp 的第 861 行。

成员函数文档

◆ build()

csv_reader_options&& cudf::io::csv_reader_options_builder::build ( )
内联

csv_reader_options 成员一旦构建完毕,将其移动。

由于 Cython 不支持转换运算符重载,因此添加了此方法。

返回
构建的 csv_reader_options 对象的右值引用

定义于文件 csv.hpp 的第 1332 行。

◆ byte_range_offset()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::byte_range_offset ( std::size_t  offset)
内联

设置从源开始跳过的字节数。

参数
offset偏移字节数
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 881 行。

◆ byte_range_size()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::byte_range_size ( std::size_t  size)
内联

设置要读取的字节数。

参数
size要读取的字节数
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 893 行。

◆ comment()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::comment ( char  val)
内联

设置注释行起始字符。

参数
val表示注释的字符
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1061 行。

◆ compression()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::compression ( compression_type  comp)
内联

设置源的压缩格式。

参数
comp压缩类型
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 869 行。

◆ dayfirst()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::dayfirst ( bool  val)
内联

设置是否将日期解析为 DD/MM 格式,而不是 MM/DD 格式。

参数
val用于启用/禁用的布尔值
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1302 行。

◆ decimal()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::decimal ( char  val)
内联

设置小数点字符。

参数
val表示十进制值的字符
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1049 行。

◆ delim_whitespace()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::delim_whitespace ( bool  val)
内联

设置是否将空格视作字段分隔符。

参数
val用于启用/禁用的布尔值
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1085 行。

◆ delimiter()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::delimiter ( char  delim)
内联

设置字段分隔符。

参数
delim表示分隔符的字符
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1025 行。

◆ detect_whitespace_around_quotes()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::detect_whitespace_around_quotes ( bool  val)
内联

设置是否检测被空格包围的引号,例如 "data"。当 _doublequote 为 true 时,此标志无效。

参数
val用于启用/禁用的布尔值
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1158 行。

◆ doublequote()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::doublequote ( bool  val)
内联

设置值内的引号是否双重引用。

参数
val用于启用/禁用的布尔值
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1145 行。

◆ dtypes() [1/2]

csv_reader_options_builder& cudf::io::csv_reader_options_builder::dtypes ( std::map< std::string, data_type types)
内联

设置每列类型。

参数
types列名 -> 数据类型映射,指定列的目标数据类型
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1218 行。

◆ dtypes() [2/2]

csv_reader_options_builder& cudf::io::csv_reader_options_builder::dtypes ( std::vector< data_type types)
内联

设置每列类型。

参数
types列需要读取的数据类型向量
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1230 行。

◆ false_values()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::false_values ( std::vector< std::string >  vals)
内联

设置要识别为布尔值 false 的附加值。

参数
vals要被视为 false 的值向量
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1254 行。

◆ header()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::header ( size_type  hdr)
内联

设置标题行索引。

参数
hdr标题行所在的索引
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1001 行。

◆ keep_default_na()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::keep_default_na ( bool  val)
内联

设置是否保留内置的默认 NA 值。

参数
val用于启用/禁用的布尔值
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1278 行。

◆ lineterminator()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::lineterminator ( char  term)
内联

设置行终止符。

参数
term表示行终止的字符
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1013 行。

◆ mangle_dupe_cols()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::mangle_dupe_cols ( bool  val)
内联

设置是否重命名重复的列名。

参数
val用于启用/禁用的布尔值
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 929 行。

◆ na_filter()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::na_filter ( bool  val)
内联

设置是否禁用空值过滤。

参数
val用于启用/禁用的布尔值
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1290 行。

◆ na_values()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::na_values ( std::vector< std::string >  vals)
内联

设置要识别为空值的附加值。

参数
vals要被视为 null 的值向量
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1266 行。

◆ names()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::names ( std::vector< std::string >  col_names)
内联

设置列的名称。

参数
col_names列名向量
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 905 行。

◆ nrows()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::nrows ( size_type  rows)
内联

设置要读取的行数。

参数
rows要读取的行数
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 965 行。

◆ parse_dates() [1/2]

csv_reader_options_builder& cudf::io::csv_reader_options_builder::parse_dates ( std::vector< int >  col_indices)
内联

设置要读取为日期时间类型的列索引。

参数
col_indices要读取为日期时间类型的列索引向量
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1182 行。

◆ parse_dates() [2/2]

csv_reader_options_builder& cudf::io::csv_reader_options_builder::parse_dates ( std::vector< std::string >  col_names)
内联

设置要读取为日期时间类型的列名。

参数
col_names要读取为日期时间类型的列名向量
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1170 行。

◆ parse_hex() [1/2]

csv_reader_options_builder& cudf::io::csv_reader_options_builder::parse_hex ( std::vector< int >  col_indices)
内联

设置要解析为十六进制的列索引。

参数
col_indices要解析为十六进制的列索引向量
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1206 行。

◆ parse_hex() [2/2]

csv_reader_options_builder& cudf::io::csv_reader_options_builder::parse_hex ( std::vector< std::string >  col_names)
内联

设置要解析为十六进制的列名。

参数
col_names要解析为十六进制的列名向量
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1194 行。

◆ prefix()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::prefix ( std::string  pfx)
内联

设置用于列 ID 的前缀。

参数
pfx用作每列名前缀的字符串
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 917 行。

◆ quotechar()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::quotechar ( char  ch)
内联

设置引用字符。

参数
ch表示引用的字符
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1133 行。

◆ quoting()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::quoting ( quote_style  style)
内联

设置引用样式。

参数
style使用的引用样式
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1121 行。

◆ skip_blank_lines()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::skip_blank_lines ( bool  val)
内联

设置是否忽略空行或将行值解析为无效值。

参数
val用于启用/禁用的布尔值
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1109 行。

◆ skipfooter()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::skipfooter ( size_type  skip)
内联

设置从末尾跳过的行数。

参数
skip要跳过的行数
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 989 行。

◆ skipinitialspace()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::skipinitialspace ( bool  val)
内联

设置是否跳过分隔符后的空格。

参数
val用于启用/禁用的布尔值
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1097 行。

◆ skiprows()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::skiprows ( size_type  skip)
内联

设置从开始跳过的行数。

参数
skip要跳过的行数
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 977 行。

◆ thousands()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::thousands ( char  val)
内联

设置数字数据的千位分隔符。

参数
val分隔千位的字符
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1037 行。

◆ timestamp_type()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::timestamp_type ( data_type  type)
内联

设置所有时间戳列将被转换为的时间戳类型。

参数
type所有时间戳列将被转换为的数据类型
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1314 行。

◆ true_values()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::true_values ( std::vector< std::string >  vals)
内联

设置要识别为布尔值 true 的附加值。

参数
vals要被视为 true 的值向量
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1242 行。

◆ use_cols_indexes()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::use_cols_indexes ( std::vector< int >  col_indices)
内联

设置要读取的列的索引。

参数
col_indices需要的列索引向量
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 953 行。

◆ use_cols_names()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::use_cols_names ( std::vector< std::string >  col_names)
内联

设置要读取的列的名称。

参数
col_names需要的列名向量
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 941 行。

◆ windowslinetermination()

csv_reader_options_builder& cudf::io::csv_reader_options_builder::windowslinetermination ( bool  val)
内联

设置是否将 \r\n 视为行终止符。

参数
val用于启用/禁用的布尔值
返回
返回自身以支持链式调用

定义于文件 csv.hpp 的第 1073 行。


此类的文档由以下文件生成