Skip to main content

WeightedCliqueOptions

Struct WeightedCliqueOptions 

Source
pub struct WeightedCliqueOptions {
    pub maximal: bool,
    pub min_weight: Option<f64>,
    pub max_weight: Option<f64>,
    pub max_results: Option<usize>,
}
Expand description

Options of Graph::weighted_cliques.

The default finds all cliques of any weight, without limits.

Cliquer only supports integer weights, so both bounds are truncated to their integer part. Unlike in C, where a non-positive maximum means “no bound”, here None means “no bound” and a maximum below 1 (which no clique can meet, as vertex weights are at least 1) is rejected as an empty range.

use igraph::cliques::WeightedCliqueOptions;
let opts = WeightedCliqueOptions::default().with_maximal(true).with_min_weight(7.0);
assert!(opts.maximal && opts.max_weight.is_none());

Fields§

§maximal: bool

Only return maximal cliques (default false).

§min_weight: Option<f64>

Minimum total weight of a returned clique (inclusive), None for no lower bound. Truncated to its integer part; values of at most 1 are the same as no bound.

§max_weight: Option<f64>

Maximum total weight of a returned clique (inclusive), None for no upper bound. Truncated to its integer part.

§max_results: Option<usize>

Stop after this many cliques were found, None for no limit (Some(0) returns nothing).

Implementations§

Source§

impl WeightedCliqueOptions

Source

pub fn with_maximal(self, maximal: bool) -> Self

Sets the maximal field.

Source

pub fn with_min_weight(self, weight: f64) -> Self

Sets the min_weight field.

Source

pub fn with_max_weight(self, weight: f64) -> Self

Sets the max_weight field.

Source

pub fn with_max_results(self, max_results: usize) -> Self

Sets the max_results field.

Source

pub fn maximal(self, maximal: bool) -> Self

👎Deprecated:

use with_maximal

Sets the maximal field; use with_maximal instead.

Source

pub fn min_weight(self, weight: f64) -> Self

👎Deprecated:

use with_min_weight

Sets the min_weight field; use with_min_weight instead.

Source

pub fn max_weight(self, weight: f64) -> Self

👎Deprecated:

use with_max_weight

Sets the max_weight field; use with_max_weight instead.

Source

pub fn max_results(self, max_results: usize) -> Self

👎Deprecated:

use with_max_results

Sets the max_results field; use with_max_results instead.

Trait Implementations§

Source§

impl Clone for WeightedCliqueOptions

Source§

fn clone(&self) -> WeightedCliqueOptions

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 Copy for WeightedCliqueOptions

Source§

impl Debug for WeightedCliqueOptions

Source§

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

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

impl Default for WeightedCliqueOptions

Source§

fn default() -> WeightedCliqueOptions

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

impl PartialEq for WeightedCliqueOptions

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for WeightedCliqueOptions

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, 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.