Struct GraphBuilder 

pub struct GraphBuilder<'a> { /* private fields */ }

Builder for constructing a Graph from edge lists.

Provides a fluent by-value API for setting optional arrays and configuration flags. All setters consume self and return Self.

Constructs a Graph from device edge lists represented as DeviceArrayView columns. High-level cuDF table ingress is provided by crate::cudf_interop.

Required parameters

• src: source vertex ids (device array view)
• dst: destination vertex ids (device array view)

Properties default to a directed simple graph. Use properties() to override.

Example

let src_view = src.view().unwrap();
let dst_view = dst.view().unwrap();
let wgt_view = wgt.view().unwrap();
let graph = GraphBuilder::new(&src_view, &dst_view)
    .weights(&wgt_view)
    .renumber()
    .build::<Transposed>(&entered)?;

Implementations

impl<'a> GraphBuilder<'a>

pub fn new<V: CugraphElement>( src: &'a DeviceArrayView<'a, V>, dst: &'a DeviceArrayView<'a, V>, ) -> Self

Create a new builder with the required edge arrays.

Properties default to a directed simple graph. All optional arrays default to None and all boolean flags default to false.

Example

let src = DeviceArray::from_slice(&entered, &[0i32, 1, 2]).unwrap();
let dst = DeviceArray::from_slice(&entered, &[1i32, 2, 0]).unwrap();

let src_view = src.view().unwrap();
let dst_view = dst.view().unwrap();
let graph = GraphBuilder::new(&src_view, &dst_view)
    .renumber()
    .build::<Forward>(&entered)
    .unwrap();

pub fn properties(self, properties: GraphProperties) -> Self

Set the graph properties (symmetric / multigraph).

Defaults to GraphProperties::directed() if not called.

pub fn weights<W: CugraphElement>( self, weights: &'a DeviceArrayView<'a, W>, ) -> Self

Set the optional edge weights array.

Must have the same length as src/dst.

pub fn edge_ids<E: CugraphElement>( self, edge_ids: &'a DeviceArrayView<'a, E>, ) -> Self

Set the optional edge ids array.

Must have the same length as src/dst.

pub fn edge_type_ids<E: CugraphElement>( self, edge_type_ids: &'a DeviceArrayView<'a, E>, ) -> Self

Set the optional edge type ids array.

Must have the same length as src/dst.

pub fn vertices<V: CugraphElement>( self, vertices: &'a DeviceArrayView<'a, V>, ) -> Self

Set the optional vertex array.

When None (the default), vertices are auto-detected from the edge list.

pub fn edge_start_time_ids<E: CugraphElement>( self, times: &'a DeviceArrayView<'a, E>, ) -> Self

Set the optional edge start time ids array.

Must have the same length as src/dst.

pub fn edge_end_time_ids<E: CugraphElement>( self, times: &'a DeviceArrayView<'a, E>, ) -> Self

Set the optional edge end time ids array.

Must have the same length as src/dst.

pub fn renumber(self) -> Self

Enable vertex renumbering (default: disabled).

Compresses non-contiguous or sparse vertex IDs into a contiguous zero-based index range.

pub fn drop_self_loops(self) -> Self

Enable dropping self-loop edges during graph construction (default: disabled).

pub fn drop_multi_edges(self) -> Self

Enable dropping multi-edges during graph construction (default: disabled).

pub fn symmetrize(self) -> Self

Enable graph symmetrization (default: disabled).

Cannot be combined with edge_ids or edge_type_ids.

pub fn do_expensive_check(self) -> Self

Enable expensive validation checks (default: disabled).

pub fn build<T: Transposition>( &self, handle: &EnteredContext<'_>, ) -> Result<Graph<T>>

Validate inputs and construct a Graph<T> on the GPU.

The type parameter T determines the transposition state:

• build::<Forward>: forward form, for Graph::bfs
• build::<Transposed>: transposed form, for Graph::pagerank

Errors

Returns an error if:

• array lengths are inconsistent
• symmetrize is combined with edge_ids or edge_type_ids
• only one of edge_start_time_ids / edge_end_time_ids is set
• the C API rejects the inputs

Trait Implementations

impl Clone for GraphBuilder<'_>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for GraphBuilder<'_>

impl<'a> Debug for GraphBuilder<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.