chore: cleanup autodiff

Author: avhz

crates/RustQuant_autodiff/src/accumulate.rs

@@ -17,7 +17,7 @@
 //! - `DVector<Variable<'v>>`       <- Currently not possible due to lifetimes
 //! - `Array<Variable<'v>, Ix2>`    <- Work in progress
 
-use super::variables::variable::Variable;
+use super::variable::Variable;
 
 /// Trait to reverse accumulate the gradient for different types.
 pub trait Accumulate<OUT> {
@@ -50,18 +50,3 @@ impl Accumulate<Vec<f64>> for Variable<'_> {
         adjoints
     }
 }
-
-// impl<'v> Accumulate<Array2<Vec<f64>>> for VariableArray<'v> {
-//     /// Function to reverse accumulate the gradient
-//     /// for an `Array2<Variable<'v>>`.
-//     #[inline]
-//     fn accumulate(&self) -> Array2<Vec<f64>> {
-//         let mut adjoints = Array2::from_elem(self.data.dim(), Vec::new());
-
-//         for ((row, col), variable) in self.data.indexed_iter() {
-//             adjoints[(row, col)] = variable.accumulate();
-//         }
-
-//         adjoints
-//     }
-// }

crates/RustQuant_autodiff/src/gradient.rs

@@ -14,7 +14,7 @@
 // IMPORTS
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-use crate::variables::variable::Variable;
+use crate::variable::Variable;
 
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 // GRADIENT TRAIT AND IMPLEMENTATIONS

crates/RustQuant_autodiff/src/graph.rs

@@ -17,7 +17,7 @@
 // IMPORTS
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-use crate::{variables::variable::Variable, Arity, Vertex};
+use crate::{variable::Variable, Arity, Vertex};
 use std::cell::RefCell;
 
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -185,70 +185,3 @@ impl Graph {
         len
     }
 }
-
-// /// Nullary operator pushback.
-// ///
-// /// The vertex pushed to the graph is the result of a **nullary** operation.
-// /// e.g. `x.neg()` ($-x$)
-// /// Thus no partials and only the current index are added to the new vertex.
-// ///
-// /// 1. Constructs the vertex,
-// /// 2. Pushes the new vertex onto the graph,
-// /// 3. Returns the index of the new vertex.
-// #[inline]
-// pub fn push_nullary(&self) -> usize {
-//     let mut vertices = self.vertices.borrow_mut();
-//     let len = vertices.len();
-//     vertices.push(Vertex {
-//         partials: [0.0, 0.0],
-//         parents: [len, len],
-//     });
-//     len
-// }
-
-// /// Unary operator pushback.
-// ///
-// /// The vertex pushed to the graph is the result of a **unary** operation.
-// /// e.g. `x.sin()` ($sin(x)$)
-// /// Thus one partial and one parent are added to the new vertex.
-// ///
-// /// 1. Constructs the vertex,
-// /// 2. Pushes the new vertex onto the graph,
-// /// 3. Returns the index of the new vertex.
-// #[inline]
-// pub fn push_unary(&self, parent0: usize, partial0: f64) -> usize {
-//     let mut vertices = self.vertices.borrow_mut();
-//     let len = vertices.len();
-//     vertices.push(Vertex {
-//         partials: [partial0, 0.0],
-//         parents: [parent0, len],
-//     });
-//     len
-// }
-
-// /// Binary operator pushback.
-// ///
-// /// The vertex pushed to the graph is the result of a **binary** operation.
-// /// e.g. `x + y`
-// /// Thus two partials and two parents are added to the new vertex.
-// ///
-// /// 1. Constructs the vertex,
-// /// 2. Pushes the new vertex onto the graph,
-// /// 3. Returns the index of the new vertex.
-// #[inline]
-// pub fn push_binary(
-//     &self,
-//     parent0: usize,
-//     partial0: f64,
-//     parent1: usize,
-//     partial1: f64,
-// ) -> usize {
-//     let mut vertices = self.vertices.borrow_mut();
-//     let len = vertices.len();
-//     vertices.push(Vertex {
-//         partials: [partial0, partial1],
-//         parents: [parent0, parent1],
-//     });
-//     len
-// }
-// }

crates/RustQuant_autodiff/src/graphviz.rs

@@ -15,7 +15,7 @@
 //! language. At the moment, I'm simply trying to make a function that outputs
 //! `dot` code for a given graph.
 
-use crate::{variables::variable::Variable, Graph};
+use crate::{variable::Variable, Graph};
 
 // impl std::fmt::Display for Graph {
 //     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {

crates/RustQuant_autodiff/src/lib.rs

@@ -21,7 +21,7 @@
 //!     - i.e. for functions $f:\mathbb{R}^n \rightarrow \mathbb{R}^m$, where $m \gg n$
 //!
 //! ```
-//! use RustQuant::autodiff::*;
+//! # use RustQuant_autodiff::*;
 //!
 //! // Create a new Graph to store the computations.
 //! let g = Graph::new();
@@ -91,44 +91,6 @@ pub use vertex::*;
 pub mod overload;
 pub use overload::*;
 
-// /// Operator/function overloading.
-// /// This module contains the overloaded operators and primitive functions.
-// /// In Griewank and Walther - Evaluating Derivatives, they refer to this
-// /// as the "elemental library".
-// /// Operations such as `+` and `*` are redefined, along with primitive
-// /// functions such as `sin`, `exp`, and `log`.
-// /// Each overload has an associated test to ensure functionality.
-// pub mod overloading {
-//     /// Overload the standard addition operator (`+`).
-//     pub mod add;
-//     /// Overload the standard division operator (`/`).
-//     pub mod div;
-//     /// Overload the standard f64 type methods.
-//     pub mod f64;
-//     /// Overload the iterator traits.
-//     pub mod iter;
-//     /// Overload the standard logarithm function (`log`).
-//     pub mod log;
-//     /// Overload the standard min/max functions (`min` and `max`).
-//     pub mod minmax;
-//     /// Overload the standard multiplication operator (`*`).
-//     pub mod mul;
-//     /// Overload the power functions.
-//     pub mod pow;
-//     /// Overloading functions from `statrs`.
-//     pub mod statrs;
-//     /// Overload the standard subtraction operator (`-`).
-//     pub mod sub;
-// }
-// pub use overloading::{log::*, minmax::*, pow::*};
-
 /// `Variable`s for `autodiff`.
-pub mod variables {
-    // /// Implements `Variable`s for `nalgebra`.
-    // pub mod nalgebra;
-    // /// Implements `Variable`s for `ndarray`.
-    // pub mod ndarray;
-    /// Base trait for all `Variable`s.
-    pub mod variable;
-}
-pub use variables::variable::*;
+pub mod variable;
+pub use variable::*;