Skip to main content

ExprGraph

Struct ExprGraph 

Source
pub struct ExprGraph { /* private fields */ }
Expand description

Topologically ordered, serializable representation of an Expr DAG.

Implementations§

Source§

impl ExprGraph

Source

pub fn fix_parameter(&self, name: &str, value: f64) -> ParamResult<Self>

Return a copy of this graph with the named scalar parameter fixed.

§Errors

Returns ParamError::UnknownName when the graph has no scalar parameter named name, or ParamError::FixedValueOutOfBounds when value is outside that parameter’s bounds.

Source

pub fn free_parameter(&self, name: &str) -> ParamResult<Self>

Return a copy of this graph with the named scalar parameter free.

§Errors

Returns ParamError::UnknownName when the graph has no scalar parameter named name.

Source

pub fn project_tags<'a>(&self, tags: impl IntoIterator<Item = &'a str>) -> Self

Replaces tagged components that match none of tags with zero.

Untagged nodes remain active, and a matching tagged node retains its entire subtree.

Source

pub fn from_parts( root: ExprId, nodes: Vec<ExprNode>, metadata: Vec<ExprMetadata>, ) -> Result<Self, ExprGraphError>

Validates and constructs a graph from its serialized parts.

Child nodes must precede their parents, metadata must have one entry per node, and root must identify an existing node.

§Errors

Returns ExprGraphError when the graph is empty, the metadata and node lengths differ, root is invalid, or a child identifier is invalid or does not precede its parent.

Source

pub fn root(&self) -> ExprId

Returns the root node identifier.

Source

pub fn node(&self, id: ExprId) -> Option<&ExprNode>

Returns the node identified by id, if it exists.

Source

pub fn nodes(&self) -> &[ExprNode]

Returns all nodes in topological order.

Source

pub fn metadata(&self, id: ExprId) -> Option<&ExprMetadata>

Returns the metadata associated with id, if it exists.

Source

pub fn display_tree(&self) -> ExprGraphTreeDisplay<'_>

Creates a configurable indented-tree display.

Source

pub fn display_dot(&self) -> ExprGraphDotDisplay<'_>

Creates a configurable Graphviz DOT display.

Trait Implementations§

Source§

impl Clone for ExprGraph

Source§

fn clone(&self) -> ExprGraph

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 ExprGraph

Source§

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

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

impl<'de> Deserialize<'de> for ExprGraph

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for ExprGraph

Source§

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

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

impl Serialize for ExprGraph

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.