cudf-cxx 0.3.1

cxx-based FFI bridge between Rust and NVIDIA libcudf C++ API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

#pragma once

#include <cudf/sorting.hpp>
#include <cudf/types.hpp>
#include <memory>
#include <vector>
#include "rust/cxx.h"
#include "column_shim.h"
#include "table_shim.h"

namespace cudf_shims {

// ── Sorting ────────────────────────────────────────────────────

/// Returns a column of row indices that would sort the table.
std::unique_ptr<OwnedColumn> sorted_order(
    const OwnedTable& table,
    rust::Slice<const int32_t> column_order,
    rust::Slice<const int32_t> null_order);

/// Sort a table by its columns.
std::unique_ptr<OwnedTable> sort(
    const OwnedTable& table,
    rust::Slice<const int32_t> column_order,
    rust::Slice<const int32_t> null_order);

/// Sort `values` table by the rows of `keys` table.
std::unique_ptr<OwnedTable> sort_by_key(
    const OwnedTable& values,
    const OwnedTable& keys,
    rust::Slice<const int32_t> column_order,
    rust::Slice<const int32_t> null_order);

/// Stable sort `values` table by the rows of `keys` table.
std::unique_ptr<OwnedTable> stable_sort_by_key(
    const OwnedTable& values,
    const OwnedTable& keys,
    rust::Slice<const int32_t> column_order,
    rust::Slice<const int32_t> null_order);

/// Compute rank of each element in a column.
std::unique_ptr<OwnedColumn> rank(
    const OwnedColumn& col,
    int32_t method,
    int32_t column_order,
    int32_t null_order,
    int32_t null_handling,
    bool percentage);

/// Check whether a table is sorted.
bool is_sorted(
    const OwnedTable& table,
    rust::Slice<const int32_t> column_order,
    rust::Slice<const int32_t> null_order);

/// Returns a column of row indices that would stably sort the table.
std::unique_ptr<OwnedColumn> stable_sorted_order(
    const OwnedTable& table,
    rust::Slice<const int32_t> column_order,
    rust::Slice<const int32_t> null_order);

/// Stable sort a table by its columns.
std::unique_ptr<OwnedTable> stable_sort(
    const OwnedTable& table,
    rust::Slice<const int32_t> column_order,
    rust::Slice<const int32_t> null_order);

/// Return the top k values of a column.
std::unique_ptr<OwnedColumn> top_k(
    const OwnedColumn& col,
    int32_t k,
    int32_t order);

// ── Segmented Sorting ─────────────────────────────────────────

/// Returns row indices that would sort each segment of the table.
std::unique_ptr<OwnedColumn> segmented_sorted_order(
    const OwnedTable& table,
    const OwnedColumn& segment_offsets,
    rust::Slice<const int32_t> column_order,
    rust::Slice<const int32_t> null_order);

/// Stable version of segmented_sorted_order.
std::unique_ptr<OwnedColumn> stable_segmented_sorted_order(
    const OwnedTable& table,
    const OwnedColumn& segment_offsets,
    rust::Slice<const int32_t> column_order,
    rust::Slice<const int32_t> null_order);

/// Sort values by keys within each segment.
std::unique_ptr<OwnedTable> segmented_sort_by_key(
    const OwnedTable& values,
    const OwnedTable& keys,
    const OwnedColumn& segment_offsets,
    rust::Slice<const int32_t> column_order,
    rust::Slice<const int32_t> null_order);

/// Stable version of segmented_sort_by_key.
std::unique_ptr<OwnedTable> stable_segmented_sort_by_key(
    const OwnedTable& values,
    const OwnedTable& keys,
    const OwnedColumn& segment_offsets,
    rust::Slice<const int32_t> column_order,
    rust::Slice<const int32_t> null_order);

} // namespace cudf_shims