Skip to main content

MetisOptions

Struct MetisOptions 

Source
pub struct MetisOptions {
    pub seed: u64,
    pub niparts: u32,
    pub coarsen_floor: u32,
    pub nd_to_amd_switch: u32,
    pub two_hop_ratio_threshold: f64,
    pub max_imbalance: f64,
    pub fm_passes: u32,
    pub dense_quotient_enabled: bool,
    pub dense_quotient_threshold: Option<usize>,
}
Expand description

Tunable parameters for METIS nested-dissection ordering.

Defaults mirror METIS 5.2.0’s METIS_NodeND defaults as documented in dev/plans/ordering-metis.md audit (MUMPS uses stock METIS defaults for KKT problems: METIS_OPTION_NUMBERING = 1, all other options at library default).

Fields§

§seed: u64

Deterministic RNG seed. Defaults to 1. Two runs with the same seed on the same input must produce the same permutation.

§niparts: u32

Number of initial-bisection trials at the coarsest level (METIS 5.2.0 default: 7). Each trial alternates GGP and random BFS and is scored on its post-FM cut.

§coarsen_floor: u32

Stop coarsening when the graph has fewer than this many vertices (METIS 5.2.0 default: 120).

§nd_to_amd_switch: u32

Switch from recursive ND to AMD on uncoarsened subproblems of at most this many vertices (METIS 5.2.0 default: 200).

§two_hop_ratio_threshold: f64

Reduction-ratio threshold below which SHEM falls back to 2-hop matching (METIS 5.2.0 default: 0.85).

§max_imbalance: f64

Maximum partition imbalance factor (ufactor in METIS terms, encoded as a fraction here). METIS 5.2.0 uses 200, which corresponds to 1.20 load balance tolerance; expressed as the fractional deviation 0.20.

§fm_passes: u32

Number of FM passes at each uncoarsening level (METIS 5.2.0 default: 10).

§dense_quotient_enabled: bool

Pull near-dense columns out of the ND graph before recursive bisection and append them at the end of the returned permutation.

Default: false. The technique was implemented to mimic what we believed MUMPS’s ICNTL(6) and SSIDS did, but expert review of the MUMPS and SPRAL sources (2026-04-27) found: (a) ICNTL(6) is MC64 matching, not dense-row removal; (b) MUMPS handles dense rows inside its AMD/AMF (MUMPS_QAMD in ana_orderings.F:5226+ with the THRESM parameter and HEAD(N) quasi-dense list); and (c) SSIDS does not special-case dense rows at all — it relies on METIS placing them in the top separator and supernodal amalgamation collapsing the resulting chain into one dense BLAS-3 root frontal. Neither solver pre-strips the graph. Empirically, on ORBIT2_0000 (n=4795, one column of off-degree 1794) Fix A increased nnz_L from 1.54M to 2.25M because removing the dense column destroys the structural signal that makes it the natural top separator. The opt-in path is kept for diagnostic experimentation; the correct fix lives in feral-amd (a QAMD-style deferral, future work).

References (kept for the opt-in code path):

  • Davis & Hager, “Dynamic supernodes in sparse Cholesky update/downdate and triangular solves” (2009), §3.2.
  • Davis (1996) AMD paper, §5 (“dense rows / Alpha parameter”).
  • MUMPS source: ana_orderings.F:5226-5650 (QAMD).
§dense_quotient_threshold: Option<usize>

Override the off-diagonal-degree threshold above which a column is treated as quasi-dense.

When None (the default) the threshold is computed as max(40, ceil(10 * sqrt(n))) per Davis & Hager / AMD §5. Set to Some(usize::MAX) to effectively disable the quotient without flipping dense_quotient_enabled (useful for regression sweeps).

Trait Implementations§

Source§

impl Clone for MetisOptions

Source§

fn clone(&self) -> MetisOptions

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 MetisOptions

Source§

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

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

impl Default for MetisOptions

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.