Skip to main content

ScotchOptions

Struct ScotchOptions 

Source
pub struct ScotchOptions {
    pub compress: bool,
    pub compress_ratio: f64,
    pub amd_switch: u32,
    pub coarsen_floor: u32,
    pub n_sep_trials: u32,
    pub fm_move_cap: u32,
    pub fm_pass_cap: u32,
    pub max_imbalance: f64,
    pub seed: u64,
}
Expand description

Tunable parameters for SCOTCH nested-dissection ordering.

Defaults mirror SCOTCH 7.0’s vertex-separation ordering defaults as documented in the audit of dev/plans/ordering-scotch.md: cmin = 100 (coarsening floor), amd_switch = 120, n_sep_trials = 5, fm_move_cap = 200, bal = 0.05, compress_ratio = 0.7, seed = 0xDEAD_BEEF.

S1 status: only compress and compress_ratio are consumed by shipped code. The remaining fields are defined at the S1 boundary so that the public type does not drift between milestones.

Fields§

§compress: bool

Apply graph compression before partitioning.

§compress_ratio: f64

Compress only if n_compressed / n < compress_ratio (i.e., compress only when compression saves at least (1 - compress_ratio) * 100 % of vertices). SCOTCH uses 0.75; we follow the plan’s slightly more aggressive 0.7.

§amd_switch: u32

Switch from recursive ND to AMD on subproblems with at most this many vertices (SCOTCH default: 120).

§coarsen_floor: u32

Stop coarsening when the graph has fewer than this many vertices (SCOTCH cmin = 100 for vertex-separation contexts).

§n_sep_trials: u32

Number of separator trials at each recursion level (SCOTCH default: 5).

§fm_move_cap: u32

FM refinement: per-pass move cap (SCOTCH default: 200).

§fm_pass_cap: u32

FM refinement: per-call pass cap. SCOTCH’s default is “passes until no improvement”; we clamp at 32 for bounded runtime.

§max_imbalance: f64

Imbalance tolerance (SCOTCH default: 0.05).

§seed: u64

Deterministic RNG seed for coarsening matching.

Trait Implementations§

Source§

impl Clone for ScotchOptions

Source§

fn clone(&self) -> ScotchOptions

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 ScotchOptions

Source§

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

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

impl Default for ScotchOptions

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