Skip to main content

BetweennessCentralityConfig

Struct BetweennessCentralityConfig 

Source
pub struct BetweennessCentralityConfig {
    pub normalize: bool,
    pub direction: Direction,
    pub include_endpoints: bool,
    pub max_graph_nodes: Option<usize>,
}
Expand description

Configuration for Betweenness Centrality computation.

Fields§

§normalize: bool

Whether to normalize centrality values to [0, 1]. Default: true

§direction: Direction

Direction of edges to follow. Default: Both (treat as undirected)

§include_endpoints: bool

Whether to include endpoints in the centrality calculation. Default: false

§max_graph_nodes: Option<usize>

Maximum number of nodes allowed before returning an error. Set to None to disable the check. Default: 10,000,000 (10M nodes)

Implementations§

Source§

impl BetweennessCentralityConfig

Source

pub fn new() -> Self

Create a new configuration with default values.

Source

pub const fn with_normalize(self, normalize: bool) -> Self

Set whether to normalize centrality values.

When normalized, values are scaled to [0, 1] by dividing by (n-1)(n-2)/2 for undirected or (n-1)(n-2) for directed graphs.

Source

pub const fn with_direction(self, direction: Direction) -> Self

Set the direction to follow edges.

  • Outgoing: Follow edges in their natural direction
  • Incoming: Follow edges in reverse
  • Both: Treat graph as undirected (default)
Source

pub const fn with_include_endpoints(self, include: bool) -> Self

Set whether to include endpoints in centrality calculation.

When true, source and target nodes also contribute to the centrality of intermediate nodes.

Source

pub const fn with_max_graph_nodes(self, limit: Option<usize>) -> Self

Set the maximum number of nodes allowed.

If the graph has more nodes than this limit, the algorithm will return a GraphError::GraphTooLarge error instead of attempting to allocate potentially gigabytes of memory.

Set to None to disable the check (use with caution).

Trait Implementations§

Source§

impl Clone for BetweennessCentralityConfig

Source§

fn clone(&self) -> BetweennessCentralityConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BetweennessCentralityConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BetweennessCentralityConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more