Struct JointDegreeDistributionOptions 

pub struct JointDegreeDistributionOptions {
    pub from_mode: NeighborMode,
    pub to_mode: NeighborMode,
    pub directed_neighbors: bool,
    pub normalized: bool,
    pub max_from_degree: Option<usize>,
    pub max_to_degree: Option<usize>,
}

Options of Graph::joint_degree_distribution.

The defaults describe the classical joint degree distribution: for each directed connection u -> v, the out-degree of u and the in-degree of v, normalized so that the entries sum to one, with automatically sized rows and columns.

Fields

from_mode: NeighborMode

How to compute the degree of source vertices (NeighborMode::Out, NeighborMode::In or NeighborMode::All). Ignored for undirected graphs. Default: NeighborMode::Out.

to_mode: NeighborMode

How to compute the degree of target vertices. Ignored for undirected graphs. Default: NeighborMode::In.

directed_neighbors: bool

Whether to consider u -> v connections as directed. When false, every edge is counted in both directions. Ignored for undirected graphs. Default: true.

normalized: bool

Whether to normalize the matrix so that its entries sum to 1. If false, entries are connection counts (or total weights). Default: true.

max_from_degree: Option<usize>

Largest source degree to consider (the result has one more row); None uses the largest source degree in the graph. Default: None.

max_to_degree: Option<usize>

Largest target degree to consider (the result has one more column); None uses the largest target degree in the graph. Default: None.

Implementations

impl JointDegreeDistributionOptions

pub fn with_modes(self, from_mode: NeighborMode, to_mode: NeighborMode) -> Self

Sets how source and target degrees are computed.

pub fn with_directed_neighbors(self, directed_neighbors: bool) -> Self

Sets directed_neighbors.

pub fn with_normalized(self, normalized: bool) -> Self

Sets normalized.

pub fn with_max_degrees( self, max_from: Option<usize>, max_to: Option<usize>, ) -> Self

Sets the largest source and target degrees to consider.

Trait Implementations

impl Clone for JointDegreeDistributionOptions

fn clone(&self) -> JointDegreeDistributionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for JointDegreeDistributionOptions

impl Debug for JointDegreeDistributionOptions

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

Formats the value using the given formatter.

impl Default for JointDegreeDistributionOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for JointDegreeDistributionOptions

impl PartialEq for JointDegreeDistributionOptions

fn eq(&self, other: &JointDegreeDistributionOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for JointDegreeDistributionOptions