pylibhipgraph.generate_rmat_edgelists

2025-05-20

3 min read time

Applies to Linux

generate_rmat_edgelists (ResourceHandle resource_handle, random_state, size_t n_edgelists, size_t min_scale, size_t max_scale, size_t edge_factor, size_distribution, edge_distribution, bool_t clip_and_flip, bool_t scramble_vertex_ids, bool_t include_edge_weights, minimum_weight, maximum_weight, dtype, bool_t include_edge_ids, bool_t include_edge_types, min_edge_type_value, max_edge_type_value, bool_t multi_gpu)

Generate multiple RMAT edge lists

Parameters

resource_handleResourceHandle

Handle to the underlying device resources needed for referencing data and running algorithms.

random_stateint , optional

Random state to use when generating samples. Optional argument, defaults to a hash of process id, time, and hostname. (See pylibhipgraph.random.HipGraphRandomState)

n_edgelistssize_t

Number of edge lists (graphs) to generate

min_scalesize_t

Scale factor to set the minimum number of vertices in the graph

max_scalesize_t

Scale factor to set the maximum number of vertices in the graph

edge_factorsize_t

Average number of edges per vertex to generate

size_distributionint

Distribution of the graph sizes, impacts the scale parameter of the R-MAT generator. ‘0’ for POWER_LAW distribution and ‘1’ for UNIFORM distribution

edge_distributionint

Edges distribution for each graph, impacts how R-MAT parameters a,b,c,d, are set. ‘0’ for POWER_LAW distribution and ‘1’ for UNIFORM distribution

clip_and_flipbool

Flag controlling whether to generate edges only in the lower triangular part (including the diagonal) of the graph adjacency matrix (if set to ‘true’) or not (if set to ‘false’)

scramble_vertex_idsbool

Flag controlling whether to scramble vertex ID bits (if set to true) or not (if set to false); scrambling vertex ID bits breaks correlation between vertex ID values and vertex degrees.

include_edge_weightsbool

Flag controlling whether to generate edges with weights (if set to ‘true’) or not (if set to ‘false’).

minimum_weightdouble

Minimum weight value to generate (if ‘include_edge_weights’ is ‘true’)

maximum_weightdouble

Maximum weight value to generate (if ‘include_edge_weights’ is ‘true’)

dtypestring

The type of weight to generate (“FLOAT32” or “FLOAT64”), ignored unless include_weights is true

include_edge_idsbool

Flag controlling whether to generate edges with ids (if set to ‘true’) or not (if set to ‘false’).

include_edge_typesbool

Flag controlling whether to generate edges with types (if set to ‘true’) or not (if set to ‘false’).

min_edge_type_valueint

Minimum edge type to generate if ‘include_edge_types’ is ‘true’ otherwise, this parameter is ignored.

max_edge_type_valueint

Maximum edge type to generate if ‘include_edge_types’ is ‘true’ otherwise, this parameter is ignored.

Returns

return a list of tuple containing the sources and destinations with their corresponding weights, ids and types if the flags ‘include_edge_weights’, ‘include_edge_ids’ and ‘include_edge_types’ are respectively set to ‘true’