UpperBtfStructure

nalgebra_block_triangularization

Struct UpperBtfStructure

pub struct UpperBtfStructure {
    pub row_order: Vec<usize>,
    pub col_order: Vec<usize>,
    pub block_sizes: Vec<usize>,
    pub matching_size: usize,
}

Expand description

Structural information from upper block triangular decomposition.

Contains the permutation orderings, block sizes, and matching information needed to understand and manipulate the block structure of a matrix.

Fields§

§row_order: Vec<usize>

Permutation mapping: new position → old row index.

§col_order: Vec<usize>

Permutation mapping: new position → old column index.

§block_sizes: Vec<usize>

Sizes of diagonal SCC blocks, in order from first to last.

§matching_size: usize

Number of matched row-column pairs found by maximum matching.

Implementations§

impl UpperBtfStructure

pub fn block_indices(&self) -> Vec<(Vec<usize>, Vec<usize>)>

Returns the row_order and col_order partitioned into blocks according to block_sizes; that is, returns a vector of (row_indices, col_indices) for each block.

Trait Implementations§

impl Clone for UpperBtfStructure

fn clone(&self) -> UpperBtfStructure

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for UpperBtfStructure

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for UpperBtfStructure

impl RefUnwindSafe for UpperBtfStructure

impl Send for UpperBtfStructure

impl Sync for UpperBtfStructure

impl Unpin for UpperBtfStructure

impl UnwindSafe for UpperBtfStructure

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.