algeon-cugraph 0.1.2

Safe libcugraph execution component for Algeon
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

//! Similarity algorithms and the owned vertex-pair collection (`VertexPairs`).
//!
//! cuGraph similarity algorithms require symmetric graphs. Graph property
//! validation is performed by the native library to preserve C API diagnostics.

use std::num::NonZeroUsize;

mod algorithms;
mod result;
mod vertex_pairs;

pub use result::{CosineSimilarityResult, JaccardSimilarityResult, OverlapSimilarityResult, SorensenSimilarityResult};
pub use vertex_pairs::VertexPairs;

/// Parameters for pairwise similarity coefficient algorithms.
#[derive(Debug, Clone, Copy, Default)]
#[must_use]
pub struct SimilarityParams {
    /// Whether to use edge weights when computing the coefficient.
    pub use_weight: bool,
    /// Whether to run expensive input validation in the C library.
    pub do_expensive_check: bool,
}

/// Parameters for all-pairs similarity coefficient algorithms.
#[derive(Debug, Clone, Copy, Default)]
#[must_use]
pub struct AllPairsSimilarityParams {
    /// Whether to use edge weights when computing the coefficient.
    pub use_weight: bool,
    /// Maximum number of output pairs to return. `None` requests all values.
    pub topk: Option<NonZeroUsize>,
    /// Whether to run expensive input validation in the C library.
    pub do_expensive_check: bool,
}

pub(crate) use algorithms::{
    all_pairs_cosine_similarity_coefficients, all_pairs_jaccard_coefficients, all_pairs_overlap_coefficients,
    all_pairs_sorensen_coefficients, cosine_similarity_coefficients, create_vertex_pairs, jaccard_coefficients,
    overlap_coefficients, sorensen_coefficients,
};