Struct burn::tensor::Data

pub struct Data<E, const D: usize> {
    pub value: Vec<E>,
    pub shape: Shape<D>,
}

Data structure for tensors.

Fields

value: Vec<E>

The values of the tensor.

shape: Shape<D>

The shape of the tensor.

Implementations

impl<E, const D: usize> Data<E, D>

pub fn new(value: Vec<E>, shape: Shape<D>) -> Data<E, D>

Constructs a new Data.

impl<const D: usize, E> Data<E, D>

where E: Element,

pub fn convert<EOther>(self) -> Data<EOther, D>

where EOther: Element,

Converts the data to a different element type.

pub fn assert_within_range<EOther>(&self, range: Range<EOther>)

where EOther: Element,

Asserts each value is within a given range.

Arguments

• range - The range.

Panics

If any value is not within the half-open range bounded inclusively below and exclusively above (start..end).

impl<const D: usize> Data<bool, D>

pub fn convert<E>(self) -> Data<E, D>

where E: Element,

Converts the data to a different element type.

impl<E, const D: usize> Data<E, D>

where E: Element,

pub fn random<R>( shape: Shape<D>, distribution: Distribution, rng: &mut R ) -> Data<E, D>

where R: RngCore,

Populates the data with random values.

impl<E, const D: usize> Data<E, D>

where E: Debug + Element,

pub fn zeros<S>(shape: S) -> Data<E, D>

where S: Into<Shape<D>>,

Populates the data with zeros.

impl<E, const D: usize> Data<E, D>

where E: Debug + Element,

pub fn ones(shape: Shape<D>) -> Data<E, D>

Populates the data with ones.

impl<E, const D: usize> Data<E, D>

where E: Debug + Element,

pub fn full(shape: Shape<D>, fill_value: E) -> Data<E, D>

Populates the data with the given value

impl<E, const D: usize> Data<E, D>

where E: Debug + Copy,

pub fn serialize(&self) -> DataSerialize<E>

Serializes the data.

Returns

The serialized data.

impl<E, const D: usize> Data<E, D>

where E: Into<f64> + Clone + Debug + PartialEq,

pub fn assert_approx_eq(&self, other: &Data<E, D>, precision: usize)

Asserts the data is approximately equal to another data.

Arguments

• other - The other data.
• precision - The precision of the comparison.

Panics

Panics if the data is not approximately equal.

pub fn assert_approx_eq_diff(&self, other: &Data<E, D>, tolerance: f64)

Asserts the data is approximately equal to another data.

Arguments

• other - The other data.
• tolerance - The tolerance of the comparison.

Panics

Panics if the data is not approximately equal.

impl<const D: usize> Data<usize, D>

pub fn from_usize<O>(self) -> Data<O, D>

where O: FromPrimitive,

Converts the usize data to a different element type.

Trait Implementations

impl<E, const D: usize> Clone for Data<E, D>

where E: Clone,

fn clone(&self) -> Data<E, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E, const D: usize> Debug for Data<E, D>

where E: Debug,

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

Formats the value using the given formatter.

impl<E, const D: usize> Display for Data<E, D>

where E: Debug,

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

Formats the value using the given formatter.

impl<E> From<&[E]> for Data<E, 1>

where E: Debug + Copy,

fn from(elems: &[E]) -> Data<E, 1>

Converts to this type from the input type.

impl<E, const D: usize> From<&DataSerialize<E>> for Data<E, D>

where E: Clone,

fn from(data: &DataSerialize<E>) -> Data<E, D>

Converts to this type from the input type.

impl<E, const A: usize, const B: usize, const C: usize, const D: usize> From<[[[[E; D]; C]; B]; A]> for Data<E, 4>

where E: Debug + Copy,

fn from(elems: [[[[E; D]; C]; B]; A]) -> Data<E, 4>

Converts to this type from the input type.

impl<E, const A: usize, const B: usize, const C: usize> From<[[[E; C]; B]; A]> for Data<E, 3>

where E: Debug + Copy,

fn from(elems: [[[E; C]; B]; A]) -> Data<E, 3>

Converts to this type from the input type.

impl<E, const A: usize, const B: usize> From<[[E; B]; A]> for Data<E, 2>

where E: Debug + Copy,

fn from(elems: [[E; B]; A]) -> Data<E, 2>

Converts to this type from the input type.

impl<E, const A: usize> From<[E; A]> for Data<E, 1>

where E: Debug + Copy,

fn from(elems: [E; A]) -> Data<E, 1>

Converts to this type from the input type.

impl<E, const D: usize> From<DataSerialize<E>> for Data<E, D>

fn from(data: DataSerialize<E>) -> Data<E, D>

Converts to this type from the input type.

impl<E, const D: usize> PartialEq for Data<E, D>

where E: PartialEq,

fn eq(&self, other: &Data<E, D>) -> 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<E, const D: usize> Eq for Data<E, D>

where E: Eq,

impl<E, const D: usize> StructuralPartialEq for Data<E, D>