Struct GraphIndex 

pub struct GraphIndex {
    pub topology: Arc<Topology>,
    pub ids: Arc<IdMap>,
    /* private fields */
}

A built graph: its topology, and the map from dense node indexes back to the edges’ ids.

A graph with a vertex table has the vertex table’s keys as its nodes, in the table’s order, and only the edges whose endpoints are both keys (see ursa_core::EdgeInterner): its edge ids number the edges kept, and Self::edge_row maps them back to rows of the edge table.

Fields

topology: Arc<Topology>

ids: Arc<IdMap>

Implementations

impl GraphIndex

pub fn new(topology: Arc<Topology>, ids: Arc<IdMap>) -> Self

pub fn with_dropped(self, n_dropped: u64, kept: Option<BooleanBuffer>) -> Self

This index, built from edge rows of which kept says which were kept (None: all of them), n_dropped having been dropped.

pub fn n_dropped(&self) -> u64

Edge rows dropped because an endpoint is not a node of the graph’s vertex table.

pub fn kept_rows(&self) -> Option<&BooleanBuffer>

Which rows of the edge plan were kept, one bit per row, if any was dropped.

pub fn edge_row(&self, edge: u32) -> u64

The row of the edge plan edge edge was read from: the edge id itself when no row was dropped.

pub fn with_stored_weights( self, keys: Vec<String>, read: Box<dyn Fn(&str) -> Option<Vec<Vec<f64>>> + Send + Sync>, ) -> Self

This index, with the weight sets stored on disk under keys, which read reads when one is first asked for.

pub fn weights(&self, key: &str) -> Option<Weights>

The weight columns stored under key in memory, if they are.

pub fn has_stored_weights(&self, key: &str) -> bool

Whether weights are stored under key on disk.

pub fn stored_weights(&self, key: &str, n_columns: usize) -> Option<Weights>

The weight columns stored under key, in memory or else on disk, if they are and have n_columns columns of one value per edge row. Read from disk, they are kept in memory too. Blocking: it may read a file.

pub fn weight_sets(&self) -> Vec<(String, Weights)>

Every set of weight columns held in memory, with its key.

pub fn store_weights(&self, key: String, weights: Weights)

Store weight columns under key. They must be one per edge row of this index, in its edge-row order.

Trait Implementations

impl Debug for GraphIndex

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

Formats the value using the given formatter.