Rib

Struct Rib 

Source
pub struct Rib {
    pub iter_count: usize,
    pub tolerance: f64,
}
Expand description

§Recursive Inertial Bisection algorithm

Partitions a mesh based on the nodes coordinates and coresponding weights.

A variant of the Recursive Coordinate Bisection algorithm where a basis change is performed beforehand so that the first coordinate of the new basis is colinear to the inertia axis of the set of points. This has the goal of producing better shaped partition than RCB.

§Example

use coupe::Partition as _;
use coupe::Point2D;

// Here, the inertia axis is the y axis.
// We thus expect Rib to split horizontally first.
let points = [
    Point2D::new(1., 10.),
    Point2D::new(-1., 10.),
    Point2D::new(1., -10.),
    Point2D::new(-1., -10.),
];
let weights = [1; 4];
let mut partition = [0; 4];

// Generate a partition of 2 parts (1 split).
coupe::Rib { iter_count: 1, ..Default::default() }
    .partition(&mut partition, (&points, weights))
    .unwrap();

// The two points at the top are in the same part.
assert_eq!(partition[0], partition[1]);

// The two points at the bottom are in the same part.
assert_eq!(partition[2], partition[3]);

// There are two different parts.
assert_ne!(partition[1], partition[2]);

§Reference

Williams, Roy D., 1991. Performance of dynamic load balancing algorithms for unstructured mesh calculations. Concurrency: Practice and Experience, 3(5):457–481. doi:10.1002/cpe.4330030502.

Fields§

§iter_count: usize

The number of iterations of the algorithm. This will yield a partition of at most 2^num_iter parts.

§tolerance: f64

Same meaning as Rcb::tolerance.

Trait Implementations§

Source§

impl Default for Rib

Source§

fn default() -> Rib

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

impl<'a, const D: usize, W> Partition<(&'a [Matrix<f64, Const<D>, Const<1>, ArrayStorage<f64, D, 1>>], W)> for Rib

Source§

type Metadata = ()

Diagnostic data returned for a specific run of the algorithm.
Source§

type Error = Error

Error details, should the algorithm fail to run.
Source§

fn partition( &mut self, part_ids: &mut [usize], (points, weights): (&'a [PointND<D>], W), ) -> Result<Self::Metadata, Self::Error>

Partition the given data and output the part ID of each element in part_ids. Read more

Auto Trait Implementations§

§

impl Freeze for Rib

§

impl RefUnwindSafe for Rib

§

impl Send for Rib

§

impl Sync for Rib

§

impl Unpin for Rib

§

impl UnwindSafe for Rib

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> 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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