SparseGradient

Struct SparseGradient 

Source
pub struct SparseGradient<A: Float + ScalarOperand + Debug> {
    pub indices: Vec<usize>,
    pub values: Vec<A>,
    pub dim: usize,
}
Expand description

A struct representing a sparse gradient with indices and values

This provides a convenient interface for working with sparse gradients where most elements are zero.

Fields§

§indices: Vec<usize>

The indices of non-zero elements

§values: Vec<A>

The values at the non-zero elements

§dim: usize

The total dimension of the gradient (including zero elements)

Implementations§

Source§

impl<A: Float + ScalarOperand + Debug + Send + Sync> SparseGradient<A>

Source

pub fn new(indices: Vec<usize>, values: Vec<A>, dim: usize) -> Self

Create a new sparse gradient from indices and values

Source

pub fn from_array(array: &Array<A, Ix1>) -> Self

Create a sparse gradient from a dense array, keeping only non-zero entries

Source

pub fn to_array(&self) -> Array<A, Ix1>

Convert the sparse gradient to a dense array

Source

pub fn is_empty(&self) -> bool

Check if this sparse gradient is empty (all zeros)

Auto Trait Implementations§

§

impl<A> Freeze for SparseGradient<A>

§

impl<A> RefUnwindSafe for SparseGradient<A>
where A: RefUnwindSafe,

§

impl<A> Send for SparseGradient<A>
where A: Send,

§

impl<A> Sync for SparseGradient<A>
where A: Sync,

§

impl<A> Unpin for SparseGradient<A>
where A: Unpin,

§

impl<A> UnwindSafe for SparseGradient<A>
where A: UnwindSafe,

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

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V