Struct Graph

pub struct Graph {
    pub vertices: RefCell<Vec<Vertex>>,
}

Struct to contain the graph (Wengert list), as a vector of Vertexs.

Fields

vertices: RefCell<Vec<Vertex>>

Vector containing the vertices in the Wengert List.

Implementations

impl Graph

Implementation for the Graph struct.

pub const fn new() -> Graph

Instantiate a new graph.

pub fn with_capacity(capacity: usize) -> Graph

Instantiate a new graph with a capacity.

pub fn join(&self, other: &Graph) -> Graph

Join two graphs together.

pub fn var(&self, value: f64) -> Variable<'_>

Add a new variable to the graph. Returns a new Variable instance (the contents of a vertex).

pub fn vars<'v>(&'v self, values: &[f64]) -> Vec<Variable<'v>>

Add multiple variables (a slice) to the graph. Useful for larger functions with many inputs.

pub fn len(&self) -> usize

Returns the length of the graph so new vertices can index to the correct position.

pub fn is_empty(&self) -> bool

Returns true/false depending on whether the graph is empty or not.

pub fn clear(&self)

Clears the entire graph.

pub fn zero(&self)

Zeroes the adjoints in the graph.

pub fn push(&self, arity: Arity, parents: &[usize], partials: &[f64]) -> usize

Pushes a vertex to the graph.

Trait Implementations

impl Clone for Graph

fn clone(&self) -> Graph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Graph

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

Formats the value using the given formatter.

impl Default for Graph

fn default() -> Graph

Returns the “default value” for a type.