ndatafusion 0.1.0

Extensions and support for linear algebra in DataFusion
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
107

use datafusion::logical_expr::{DocSection, Documentation, DocumentationBuilder};

const CONSTRUCTORS_SECTION: DocSection = DocSection {
    include:     true,
    label:       "NDataFusion Constructors",
    description: Some("Canonical numerical constructors for DataFusion SQL."),
};

const VECTOR_SECTION: DocSection = DocSection {
    include:     true,
    label:       "NDataFusion Vector Functions",
    description: Some("Dense vector operations over canonical fixed-size vector batches."),
};

const MATRIX_SECTION: DocSection = DocSection {
    include:     true,
    label:       "NDataFusion Matrix Functions",
    description: Some("Dense matrix operations and configurable matrix functions."),
};

const DECOMPOSITION_SECTION: DocSection = DocSection {
    include:     true,
    label:       "NDataFusion Matrix Decompositions",
    description: Some("Matrix decompositions and related helpers."),
};

const ITERATIVE_SECTION: DocSection = DocSection {
    include:     true,
    label:       "NDataFusion Iterative Solvers",
    description: Some("Iterative linear solvers over canonical matrix and vector batches."),
};

const SPARSE_SECTION: DocSection = DocSection {
    include:     true,
    label:       "NDataFusion Sparse Functions",
    description: Some("Sparse CSR operations over canonical ndarrow sparse batches."),
};

const TENSOR_SECTION: DocSection = DocSection {
    include:     true,
    label:       "NDataFusion Tensor Functions",
    description: Some("Fixed-shape and variable-shape tensor operations over canonical batches."),
};

const ML_SECTION: DocSection = DocSection {
    include:     true,
    label:       "NDataFusion ML And Statistics",
    description: Some(
        "Statistical and machine learning functions over canonical numerical batches.",
    ),
};

pub(crate) fn constructor_doc(
    description: impl Into<String>,
    syntax_example: impl Into<String>,
) -> DocumentationBuilder {
    Documentation::builder(CONSTRUCTORS_SECTION, description, syntax_example)
}

pub(crate) fn vector_doc(
    description: impl Into<String>,
    syntax_example: impl Into<String>,
) -> DocumentationBuilder {
    Documentation::builder(VECTOR_SECTION, description, syntax_example)
}

pub(crate) fn matrix_doc(
    description: impl Into<String>,
    syntax_example: impl Into<String>,
) -> DocumentationBuilder {
    Documentation::builder(MATRIX_SECTION, description, syntax_example)
}

pub(crate) fn decomposition_doc(
    description: impl Into<String>,
    syntax_example: impl Into<String>,
) -> DocumentationBuilder {
    Documentation::builder(DECOMPOSITION_SECTION, description, syntax_example)
}

pub(crate) fn iterative_doc(
    description: impl Into<String>,
    syntax_example: impl Into<String>,
) -> DocumentationBuilder {
    Documentation::builder(ITERATIVE_SECTION, description, syntax_example)
}

pub(crate) fn sparse_doc(
    description: impl Into<String>,
    syntax_example: impl Into<String>,
) -> DocumentationBuilder {
    Documentation::builder(SPARSE_SECTION, description, syntax_example)
}

pub(crate) fn tensor_doc(
    description: impl Into<String>,
    syntax_example: impl Into<String>,
) -> DocumentationBuilder {
    Documentation::builder(TENSOR_SECTION, description, syntax_example)
}

pub(crate) fn ml_doc(
    description: impl Into<String>,
    syntax_example: impl Into<String>,
) -> DocumentationBuilder {
    Documentation::builder(ML_SECTION, description, syntax_example)
}