DagAnalysis

bevy_ecs::schedule::graph

Struct DagAnalysis 

Source 
pub struct DagAnalysis<N: GraphNodeId, S: BuildHasher = FixedHasher> { /* private fields */ }
Expand description

Stores the results of a call to Dag::analyze.

Implementations§

Source§

impl<N: GraphNodeId, S: BuildHasher> DagAnalysis<N, S>

Source

pub fn new(graph: &DiGraph<N, S>, topological_order: &[N]) -> Self
where S: Default,

Processes a DAG and computes its:

  • transitive reduction (along with the set of removed edges)
  • transitive closure
  • reachability matrix (as a bitset)
  • pairs of nodes connected by a path
  • pairs of nodes not connected by a path

The algorithm implemented comes from “On the calculation of transitive reduction-closure of orders” by Habib, Morvan and Rampon.

Source

pub fn reachable(&self) -> &FixedBitSet

Returns the reachability matrix.

Source

pub fn connected(&self) -> &HashSet<(N, N), S>

Returns the set of node pairs that are connected by a path.

Source

pub fn disconnected(&self) -> &[(N, N)]

Returns the list of node pairs that are not connected by a path.

Source

pub fn transitive_edges(&self) -> &[(N, N)]

Returns the list of redundant edges because a longer path exists.

Source

pub fn transitive_reduction(&self) -> &DiGraph<N, S>

Returns the transitive reduction of the graph.

Source

pub fn transitive_closure(&self) -> &DiGraph<N, S>

Returns the transitive closure of the graph.

Source

pub fn check_for_redundant_edges(&self) -> Result<(), DagRedundancyError<N>>
where S: Clone,

Checks if the graph has any redundant (transitive) edges.

§Errors

If there are redundant edges, returns a DagRedundancyError containing the list of redundant edges.

Source

pub fn check_for_cross_dependencies( &self, other: &Self, ) -> Result<(), DagCrossDependencyError<N>>

Checks if there are any pairs of nodes that have a path in both this graph and another graph.

§Errors

Returns DagCrossDependencyError if any node pair is connected in both graphs.

Source

pub fn check_for_overlapping_groups<K, V>( &self, groups: &DagGroups<K, V>, ) -> Result<(), DagOverlappingGroupError<K>>
where N: TryInto<K>, K: Eq + Hash, V: Eq + Hash,

Checks if any connected node pairs that are both keys have overlapping groups.

§Errors

If there are overlapping groups, returns a DagOverlappingGroupError containing the first pair of keys that have overlapping groups.

Trait Implementations§

Source§

impl<N: GraphNodeId, S: BuildHasher> Debug for DagAnalysis<N, S>

Source§

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

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

impl<N: GraphNodeId, S: BuildHasher + Default> Default for DagAnalysis<N, S>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<N, S> Freeze for DagAnalysis<N, S>
where S: Freeze,

§

impl<N, S> RefUnwindSafe for DagAnalysis<N, S>
where S: RefUnwindSafe, N: RefUnwindSafe, <N as GraphNodeId>::Edge: RefUnwindSafe, <N as GraphNodeId>::Adjacent: RefUnwindSafe,

§

impl<N, S> Send for DagAnalysis<N, S>
where S: Send, N: Send, <N as GraphNodeId>::Edge: Send, <N as GraphNodeId>::Adjacent: Send,

§

impl<N, S> Sync for DagAnalysis<N, S>
where S: Sync, N: Sync, <N as GraphNodeId>::Edge: Sync, <N as GraphNodeId>::Adjacent: Sync,

§

impl<N, S> Unpin for DagAnalysis<N, S>
where S: Unpin, N: Unpin, <N as GraphNodeId>::Edge: Unpin, <N as GraphNodeId>::Adjacent: Unpin,

§

impl<N, S> UnwindSafe for DagAnalysis<N, S>
where S: UnwindSafe, N: UnwindSafe, <N as GraphNodeId>::Edge: UnwindSafe, <N as GraphNodeId>::Adjacent: UnwindSafe,

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. 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.
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
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

Source§

impl<T> WasmNotSync for T
where T: Sync,