Skip to main content

Tensor

Enum Tensor 

Source
pub enum Tensor {
    Scalar(f64),
    Array(Vec<Tensor>),
}
Expand description

A multi-dimensional numerical array.

Tensors can be scalars (single values) or arrays of nested tensors. All leaf values are stored as f64.

§Examples

use hedl_core::lex::{parse_tensor, Tensor};

// Scalar
let scalar = Tensor::Scalar(42.0);
assert_eq!(scalar.shape(), vec![]);
assert_eq!(scalar.flatten(), vec![42.0]);

// 1D array
let vec = parse_tensor("[1, 2, 3]").unwrap();
assert_eq!(vec.shape(), vec![3]);
assert!(vec.is_integer());

// 2D matrix
let matrix = parse_tensor("[[1.5, 2.5], [3.5, 4.5]]").unwrap();
assert_eq!(matrix.shape(), vec![2, 2]);
assert!(!matrix.is_integer());

Variants§

§

Scalar(f64)

A scalar number (integer or float).

§

Array(Vec<Tensor>)

A nested array of tensors.

Implementations§

Source§

impl Tensor

Source

pub fn is_integer(&self) -> bool

Returns true if this tensor contains only integers (no decimal points).

A number is considered an integer if its fractional part is zero.

§Examples
use hedl_core::lex::{parse_tensor, Tensor};

let integers = parse_tensor("[1, 2, 3]").unwrap();
assert!(integers.is_integer());

let floats = parse_tensor("[1.5, 2.5]").unwrap();
assert!(!floats.is_integer());
Source

pub fn shape(&self) -> Vec<usize>

Returns the shape of the tensor as a vector of dimensions.

§Examples
use hedl_core::lex::{parse_tensor, Tensor};

let scalar = Tensor::Scalar(42.0);
assert_eq!(scalar.shape(), vec![]);

let vec = parse_tensor("[1, 2, 3]").unwrap();
assert_eq!(vec.shape(), vec![3]);

let matrix = parse_tensor("[[1, 2], [3, 4]]").unwrap();
assert_eq!(matrix.shape(), vec![2, 2]);
Source

pub fn flatten(&self) -> Vec<f64>

Flattens the tensor into a 1D vector of f64 values in row-major order.

§Examples
use hedl_core::lex::parse_tensor;

let matrix = parse_tensor("[[1, 2], [3, 4]]").unwrap();
assert_eq!(matrix.flatten(), vec![1.0, 2.0, 3.0, 4.0]);
Source

pub fn is_scalar(&self) -> bool

Returns true if this is a scalar value.

Source

pub fn is_array(&self) -> bool

Returns true if this is an array.

Source

pub fn ndim(&self) -> usize

Returns the number of dimensions (0 for scalar).

Source

pub fn len(&self) -> usize

Returns the total number of elements.

Source

pub fn is_empty(&self) -> bool

Returns true if the tensor has no elements.

Trait Implementations§

Source§

impl Clone for Tensor

Source§

fn clone(&self) -> Tensor

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Tensor

Source§

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

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

impl<'de> Deserialize<'de> for Tensor

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 Tensor

Source§

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

Formats the tensor as a parseable HEDL tensor literal.

This produces output that can be parsed back by parse_tensor().

Source§

impl PartialEq for Tensor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Tensor

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
Source§

impl StructuralPartialEq for Tensor

Auto Trait Implementations§

§

impl Freeze for Tensor

§

impl RefUnwindSafe for Tensor

§

impl Send for Tensor

§

impl Sync for Tensor

§

impl Unpin for Tensor

§

impl UnwindSafe for Tensor

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,