Struct AdTensor 

pub struct AdTensor<T: Scalar>(pub AdValue<Tensor<T>>);

Tensor newtype carrying AD mode information.

Examples

use ad_tensors_rs::{AdMode, AdTensor};
use tenferro_tensor::{MemoryOrder, Tensor};

let t = Tensor::<f64>::from_slice(&[1.0, 2.0], &[2], MemoryOrder::ColumnMajor).unwrap();
let x: AdTensor<f64> = t.into();
assert_eq!(x.mode(), AdMode::Primal);

Tuple Fields

0: AdValue<Tensor<T>>

Implementations

impl<T: Scalar> AdTensor<T>

pub fn new_primal(tensor: Tensor<T>) -> Self

Creates a primal tensor.

Examples

use ad_tensors_rs::AdTensor;
use tenferro_tensor::{MemoryOrder, Tensor};

let t = Tensor::<f64>::from_slice(&[1.0], &[1], MemoryOrder::ColumnMajor).unwrap();
let x = AdTensor::new_primal(t);
assert_eq!(x.dims(), &[1]);

pub fn new_forward(primal: Tensor<T>, tangent: Tensor<T>) -> Self

Creates a forward-mode tensor.

Examples

use ad_tensors_rs::{AdMode, AdTensor};
use tenferro_tensor::{MemoryOrder, Tensor};

let primal = Tensor::<f64>::from_slice(&[1.0], &[1], MemoryOrder::ColumnMajor).unwrap();
let tangent = Tensor::<f64>::from_slice(&[0.1], &[1], MemoryOrder::ColumnMajor).unwrap();
let x = AdTensor::new_forward(primal, tangent);
assert_eq!(x.mode(), AdMode::Forward);

pub fn new_reverse( primal: Tensor<T>, node: NodeId, tape: TapeId, tangent: Option<Tensor<T>>, ) -> Self

Creates a reverse-mode tensor.

Examples

use ad_tensors_rs::{AdMode, AdTensor, NodeId, TapeId};
use tenferro_tensor::{MemoryOrder, Tensor};

let primal = Tensor::<f64>::from_slice(&[1.0], &[1], MemoryOrder::ColumnMajor).unwrap();
let x = AdTensor::new_reverse(primal, NodeId(8), TapeId(3), None);
assert_eq!(x.mode(), AdMode::Reverse);

pub fn mode(&self) -> AdMode

Returns AD mode.

Examples

use ad_tensors_rs::{AdMode, AdTensor};
use tenferro_tensor::{MemoryOrder, Tensor};

let t = Tensor::<f64>::from_slice(&[1.0], &[1], MemoryOrder::ColumnMajor).unwrap();
let x = AdTensor::new_primal(t);
assert_eq!(x.mode(), AdMode::Primal);

pub fn as_value(&self) -> &AdValue<Tensor<T>>

Returns reference to underlying AdValue.

Examples

use ad_tensors_rs::{AdTensor, AdValue};
use tenferro_tensor::{MemoryOrder, Tensor};

let t = Tensor::<f64>::from_slice(&[1.0], &[1], MemoryOrder::ColumnMajor).unwrap();
let x = AdTensor::new_primal(t);
assert!(matches!(x.as_value(), AdValue::Primal(_)));

pub fn into_value(self) -> AdValue<Tensor<T>>

Consumes wrapper and returns the underlying AdValue.

Examples

use ad_tensors_rs::{AdTensor, AdValue};
use tenferro_tensor::{MemoryOrder, Tensor};

let t = Tensor::<f64>::from_slice(&[1.0], &[1], MemoryOrder::ColumnMajor).unwrap();
let x = AdTensor::new_primal(t).into_value();
assert!(matches!(x, AdValue::Primal(_)));

pub fn primal(&self) -> &Tensor<T>

Returns primal tensor reference.

Examples

use ad_tensors_rs::AdTensor;
use tenferro_tensor::{MemoryOrder, Tensor};

let t = Tensor::<f64>::from_slice(&[1.0, 2.0], &[2], MemoryOrder::ColumnMajor).unwrap();
let x = AdTensor::new_primal(t);
assert_eq!(x.primal().dims(), &[2]);

pub fn tangent(&self) -> Option<&Tensor<T>>

Returns tangent tensor reference when available.

Examples

use ad_tensors_rs::AdTensor;
use tenferro_tensor::{MemoryOrder, Tensor};

let primal = Tensor::<f64>::from_slice(&[1.0], &[1], MemoryOrder::ColumnMajor).unwrap();
let tangent = Tensor::<f64>::from_slice(&[0.5], &[1], MemoryOrder::ColumnMajor).unwrap();
let x = AdTensor::new_forward(primal, tangent);
assert_eq!(x.tangent().unwrap().dims(), &[1]);

pub fn dims(&self) -> &[usize]

Returns dimensions of the primal tensor.

Examples

use ad_tensors_rs::AdTensor;
use tenferro_tensor::{MemoryOrder, Tensor};

let t = Tensor::<f64>::from_slice(&[1.0, 2.0], &[2], MemoryOrder::ColumnMajor).unwrap();
let x = AdTensor::new_primal(t);
assert_eq!(x.dims(), &[2]);

pub fn ndim(&self) -> usize

Returns number of dimensions of the primal tensor.

Examples

use ad_tensors_rs::AdTensor;
use tenferro_tensor::{MemoryOrder, Tensor};

let t = Tensor::<f64>::from_slice(&[1.0, 2.0], &[2], MemoryOrder::ColumnMajor).unwrap();
let x = AdTensor::new_primal(t);
assert_eq!(x.ndim(), 1);

pub fn len(&self) -> usize

Returns total number of elements in the primal tensor.

Examples

use ad_tensors_rs::AdTensor;
use tenferro_tensor::{MemoryOrder, Tensor};

let t = Tensor::<f64>::from_slice(&[1.0, 2.0], &[2], MemoryOrder::ColumnMajor).unwrap();
let x = AdTensor::new_primal(t);
assert_eq!(x.len(), 2);

pub fn is_empty(&self) -> bool

Returns true when primal tensor has zero elements.

Examples

use ad_tensors_rs::AdTensor;
use tenferro_tensor::{MemoryOrder, Tensor};

let t = Tensor::<f64>::from_slice(&[], &[0], MemoryOrder::ColumnMajor).unwrap();
let x = AdTensor::new_primal(t);
assert!(x.is_empty());

Trait Implementations

impl<T: Clone + Scalar> Clone for AdTensor<T>

fn clone(&self) -> AdTensor<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Clone + Scalar> Differentiable for AdTensor<T>

type Primal = Tensor<T>

Underlying primal payload type.

fn ad_value(&self) -> &AdValue<Tensor<T>>

Borrow as an AdValue.

impl From<AdTensor<Complex<f32>>> for DynAdTensor

fn from(value: AdTensor<Complex32>) -> Self

Converts to this type from the input type.

impl From<AdTensor<Complex<f64>>> for DynAdTensor

fn from(value: AdTensor<Complex64>) -> Self

Converts to this type from the input type.

impl<T: Scalar> From<AdTensor<T>> for AdValue<Tensor<T>>

fn from(value: AdTensor<T>) -> Self

Converts to this type from the input type.

impl From<AdTensor<f32>> for DynAdTensor

fn from(value: AdTensor<f32>) -> Self

Converts to this type from the input type.

impl From<AdTensor<f64>> for DynAdTensor

fn from(value: AdTensor<f64>) -> Self

Converts to this type from the input type.

impl<T: Scalar> From<AdValue<Tensor<T>>> for AdTensor<T>

fn from(value: AdValue<Tensor<T>>) -> Self

Converts to this type from the input type.

impl<T: Scalar> From<Tensor<T>> for AdTensor<T>

fn from(value: Tensor<T>) -> Self

Converts to this type from the input type.