Struct RustQuant::autodiff::vertex::Vertex

pub struct Vertex {
    pub partials: [f64; 2],
    pub parents: [usize; 2],
}

Struct defining the vertex of the computational graph.

Operations are assumed to be binary (e.g. x + y), thus the arrays have two elements. To deal with unary or nullary operations, we just adjust the weights (partials) and the dependencies (parents).

Fields

partials: [f64; 2]

Array that contains the partial derivatives wrt to x and y.

parents: [usize; 2]

Array that contains the indices of the parent vertices.

Implementations

impl Vertex

pub fn get_partials(&self) -> [f64; 2]

Get the partials of the vertex.

pub fn get_parents(&self) -> [usize; 2]

Get the parents of the vertex.

pub fn new_binary( partial_x: f64, parent_x: usize, partial_y: f64, parent_y: usize ) -> Self

Instantiate a new vertex from a binary operation.

pub fn new_unary(partial_x: f64, parent_x: usize) -> Self

Instantiate a new vertex from a unary operation.

pub fn new_nullary() -> Self

Instantiate a new vertex from a nullary operation.

Trait Implementations

impl Clone for Vertex

fn clone(&self) -> Vertex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vertex

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

Formats the value using the given formatter.

impl Display for Vertex

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

Formats the value using the given formatter.

impl PartialEq for Vertex

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Vertex

impl Eq for Vertex