nabla_ml::nab_array

Struct NDArray

Source 
pub struct NDArray {
    pub data: Vec<f64>,
    pub shape: Vec<usize>,
}

Fields§

§data: Vec<f64>§shape: Vec<usize>

Implementations§

Source§

impl NDArray

Source

pub fn new(data: Vec<f64>, shape: Vec<usize>) -> Self

Source

pub fn from_vec(data: Vec<f64>) -> Self

Source

pub fn from_matrix(data: Vec<Vec<f64>>) -> Self

Source

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

Source

pub fn ndim(&self) -> usize

Source

pub fn data(&self) -> &[f64]

Returns a reference to the data of the array

Source

pub fn rand_2d(rows: usize, cols: usize) -> Self

Creates a 2D array (matrix) of random numbers between 0 and 1

§Arguments
  • rows - The number of rows in the matrix.
  • cols - The number of columns in the matrix.
§Returns

A 2D NDArray filled with random numbers.

Source

pub fn randn(size: usize) -> Self

Creates a 1D array of random numbers following a normal distribution

§Arguments
  • size - The number of elements in the array.
§Returns

A 1D NDArray filled with random numbers from a normal distribution.

Source

pub fn randn_2d(rows: usize, cols: usize) -> Self

Creates a 2D array (matrix) of random numbers following a normal distribution

§Arguments
  • rows - The number of rows in the matrix.
  • cols - The number of columns in the matrix.
§Returns

A 2D NDArray filled with random numbers from a normal distribution.

Source

pub fn randint(low: i32, high: i32, size: usize) -> Self

Creates a 1D array of random integers between low and high

§Arguments
  • low - The lower bound (inclusive).
  • high - The upper bound (exclusive).
  • size - The number of elements in the array.
§Returns

A 1D NDArray filled with random integers.

Source

pub fn randint_2d(low: i32, high: i32, rows: usize, cols: usize) -> Self

Creates a 2D array (matrix) of random integers between low and high

§Arguments
  • low - The lower bound (inclusive).
  • high - The upper bound (exclusive).
  • rows - The number of rows in the matrix.
  • cols - The number of columns in the matrix.
§Returns

A 2D NDArray filled with random integers.

Source

pub fn reshape(&self, new_shape: &[usize]) -> Result<Self, &'static str>

Reshapes the array to the specified shape, allowing one dimension to be inferred

§Arguments
  • new_shape - A vector representing the new shape, with at most one dimension as -1.
§Returns

A new NDArray with the specified shape.

Source

pub fn max(&self) -> f64

Returns the maximum value in the array

§Returns

The maximum value as an f64.

Source

pub fn argmax(&self, axis: Option<usize>) -> Vec<usize>

Returns the index of the maximum value in the array

§Returns

The index of the maximum value. Returns the indices of maximum values For 1D arrays: returns a single index For 2D arrays: returns indices along the specified axis

Source

pub fn min(&self) -> f64

Returns the minimum value in the array

§Returns

The minimum value as an f64.

Source

pub fn from_vec_reshape(data: Vec<f64>, shape: Vec<usize>) -> Self

Creates an NDArray from a flat vector and a specified shape

§Arguments
  • data - A vector of f64 values representing the array’s data.
  • shape - A vector of usize values representing the dimensions of the array.
§Returns

A new NDArray instance.

Source

pub fn extract_sample(&self, sample_index: usize) -> Self

Extracts a single sample from a batch of N-dimensional arrays

§Arguments
  • sample_index - The index of the sample to extract
§Returns

A new NDArray containing just the specified sample with N-1 dimensions

Source

pub fn pretty_print(&self, precision: usize)

Pretty prints an N-dimensional array

§Arguments
  • precision - The number of decimal places to round each value to.
Source

pub fn get(&self, index: usize) -> f64

Returns a specific element from the array

§Arguments
  • index - The index of the element to retrieve.
§Returns

The element at the specified index.

Source

pub fn arange(start: f64, stop: f64, step: f64) -> Self

Creates a 1D array with a range of numbers

§Arguments
  • start - The starting value of the range (inclusive).
  • stop - The stopping value of the range (exclusive).
  • step - The step size between each value in the range.
§Returns

A 1D NDArray containing the range of numbers.

Source

pub fn zeros(shape: Vec<usize>) -> Self

Creates a 1D array filled with zeros

§Arguments
  • size - The number of elements in the array.
§Returns

A 1D NDArray filled with zeros.

Source

pub fn zeros_2d(rows: usize, cols: usize) -> Self

Creates a 2D array (matrix) filled with zeros

§Arguments
  • rows - The number of rows in the matrix.
  • cols - The number of columns in the matrix.
§Returns

A 2D NDArray filled with zeros.

Source

pub fn ones(size: usize) -> Self

Creates a 1D array filled with ones

§Arguments
  • size - The number of elements in the array.
§Returns

A 1D NDArray filled with ones.

Source

pub fn ones_2d(rows: usize, cols: usize) -> Self

Creates a 2D array (matrix) filled with ones

§Arguments
  • rows - The number of rows in the matrix.
  • cols - The number of columns in the matrix.
§Returns

A 2D NDArray filled with ones.

Source

pub fn linspace(start: f64, end: f64, num: usize, precision: usize) -> Self

Creates a 1D array with evenly spaced numbers over a specified interval

§Arguments
  • start - The starting value of the interval.
  • end - The ending value of the interval.
  • num - The number of evenly spaced samples to generate.
  • precision - The number of decimal places to round each value to.
§Returns

A 1D NDArray containing the evenly spaced numbers.

Source

pub fn eye(n: usize) -> Self

Creates an identity matrix of size n x n

§Arguments
  • n - The size of the identity matrix.
§Returns

An n x n identity matrix as an NDArray.

Source

pub fn rand(size: usize) -> Self

Creates a 1D array of random numbers between 0 and 1

§Arguments
  • size - The number of elements in the array.
§Returns

A 1D NDArray filled with random numbers.

Source

pub fn sub_matrix( &self, row_start: usize, row_end: usize, col_start: usize, col_end: usize, ) -> Self

Returns a sub-matrix from a 2D array

§Arguments
  • row_start - The starting row index of the sub-matrix.
  • row_end - The ending row index of the sub-matrix (exclusive).
  • col_start - The starting column index of the sub-matrix.
  • col_end - The ending column index of the sub-matrix (exclusive).
§Returns

A new NDArray representing the specified sub-matrix.

Source

pub fn set(&mut self, index: usize, value: f64)

Sets a specific element in the array

§Arguments
  • index - The index of the element to set.
  • value - The value to set the element to.
Source

pub fn set_range(&mut self, start: usize, end: usize, value: f64)

Sets a range of elements in the array to a specific value

§Arguments
  • start - The starting index of the range.
  • end - The ending index of the range (exclusive).
  • value - The value to set the elements to.
Source

pub fn copy(&self) -> Self

Returns a copy of the array

§Returns

A new NDArray that is a copy of the original.

Source

pub fn view(&self, start: usize, end: usize) -> &[f64]

Returns a view (slice) of the array from start to end (exclusive)

§Arguments
  • start - The starting index of the view.
  • end - The ending index of the view (exclusive).
§Returns

A slice of f64 values representing the specified view.

Source

pub fn view_mut(&mut self, start: usize, end: usize) -> &mut [f64]

Returns a mutable view (slice) of the array from start to end (exclusive)

§Arguments
  • start - The starting index of the view.
  • end - The ending index of the view (exclusive).
§Returns

A mutable slice of f64 values representing the specified view.

Source

pub fn get_2d(&self, row: usize, col: usize) -> f64

Returns a specific element from a 2D array

§Arguments
  • row - The row index of the element.
  • col - The column index of the element.
§Returns

The element at the specified row and column.

Source

pub fn set_2d(&mut self, row: usize, col: usize, value: f64)

Sets a specific element in a 2D array

§Arguments
  • row - The row index of the element.
  • col - The column index of the element.
  • value - The value to set the element to.
Source

pub fn new_axis(&self, axis: usize) -> Self

Adds a new axis to the array at the specified position

§Arguments
  • axis - The position at which to add the new axis.
§Returns

A new NDArray with an additional axis.

Source

pub fn expand_dims(&self, axis: usize) -> Self

Expands the dimensions of the array by adding a new axis at the specified index

§Arguments
  • axis - The index at which to add the new axis.
§Returns

A new NDArray with expanded dimensions.

Source

pub fn greater_than(&self, threshold: f64) -> Vec<bool>

Returns a boolean array indicating whether each element satisfies the condition

§Arguments
  • threshold - The threshold value to compare each element against.
§Returns

A vector of boolean values indicating whether each element is greater than the threshold.

Source

pub fn filter(&self, condition: impl Fn(&f64) -> bool) -> Self

Returns a new array containing only the elements that satisfy the condition

§Arguments
  • condition - A closure that takes an f64 and returns a boolean.
§Returns

A new NDArray containing only the elements that satisfy the condition.

Source

pub fn dtype(&self) -> &'static str

Returns the data type of the elements in the array

§Returns

A string representing the data type of the elements.

Source

pub fn size(&self) -> usize

Returns the total number of elements in the array

§Returns

The total number of elements in the array.

Source

pub fn argmin(&self) -> usize

Returns the index of the minimum value in the array

§Returns

The index of the minimum value.

Source

pub fn slice(&self, start: usize, end: usize) -> Self

Returns a slice of the array from start to end (exclusive)

§Arguments
  • start - The starting index of the slice.
  • end - The ending index of the slice (exclusive).
§Returns

A new NDArray containing the specified slice.

Source

pub fn one_hot_encode(labels: &NDArray) -> Self

Converts an NDArray of labels into a one-hot encoded NDArray

§Arguments
  • labels - An NDArray containing numerical labels
§Returns

A new NDArray with one-hot encoded labels where each row corresponds to one label

§Panics

Panics if the input contains non-integer values

Source

pub fn transpose(&self) -> Result<Self, &'static str>

Transposes a 2D array (matrix)

§Returns

A new NDArray with transposed dimensions.

Source

pub fn dot(&self, other: &NDArray) -> Self

Performs matrix multiplication (dot product) between two 2D arrays

§Arguments
  • other - The other NDArray to multiply with.
§Returns

A new NDArray resulting from the matrix multiplication.

Source

pub fn multiply(&self, other: &NDArray) -> Self

Performs element-wise multiplication between two arrays

§Arguments
  • other - The other NDArray to multiply with.
§Returns

A new NDArray resulting from the element-wise multiplication.

Source

pub fn scalar_sub(&self, scalar: f64) -> Self

Subtracts a scalar from each element in the array

§Arguments
  • scalar - The scalar value to subtract.
§Returns

A new NDArray with the scalar subtracted from each element.

Source

pub fn multiply_scalar(&self, scalar: f64) -> Self

Multiplies each element in the array by a scalar

§Arguments
  • scalar - The scalar value to multiply.
§Returns

A new NDArray with each element multiplied by the scalar.

Source

pub fn clip(&self, min: f64, max: f64) -> Self

Clips the values in the array to a specified range

§Arguments
  • min - The minimum value to clip to.
  • max - The maximum value to clip to.
§Returns

A new NDArray with values clipped to the specified range.

Source

pub fn divide(&self, other: &NDArray) -> Self

Performs element-wise division between two arrays

§Arguments
  • other - The other NDArray to divide by.
§Returns

A new NDArray resulting from the element-wise division.

Source

pub fn divide_scalar(&self, scalar: f64) -> Self

Divides each element in the array by a scalar

§Arguments
  • scalar - The scalar value to divide by.
§Returns

A new NDArray with each element divided by the scalar.

Source

pub fn sum_axis(&self, axis: usize) -> Self

Sums the elements of the array along a specified axis

§Arguments
  • axis - The axis along which to sum the elements.
§Returns

A new NDArray with the summed elements along the specified axis.

Source

pub fn subtract(&self, other: &NDArray) -> Self

Performs element-wise subtraction between two arrays

§Arguments
  • other - The other NDArray to subtract.
§Returns

A new NDArray resulting from the element-wise subtraction.

Source

pub fn add_scalar(&self, scalar: f64) -> Self

Adds a scalar to each element in the array

§Arguments
  • scalar - The scalar value to add.
§Returns

A new NDArray with the scalar added to each element.

Source

pub fn log(&self) -> Self

Calculates the natural logarithm of each element in the array

§Returns

A new NDArray with the natural logarithm of each element.

Source

pub fn sum(&self) -> f64

Sums all elements in the array

§Returns

The sum of all elements as an f64.

Source

pub fn pad_to_size(&self, target_size: usize) -> Self

Source

pub fn layer_normalize(&self) -> Self

Add layer normalization

Source

pub fn batch_normalize(&self) -> Self

Add batch normalization

Source

pub fn add(self, other: &NDArray) -> Self

Source

pub fn mean(&self) -> f64

Returns the mean of the array

Source

pub fn std(&self) -> f64

Returns the standard deviation of the array

Source

pub fn min_axis(&self, axis: usize) -> Result<Self, &'static str>

Returns the minimum value along the specified axis

Source

pub fn concatenate( &self, other: &Self, axis: usize, ) -> Result<Self, &'static str>

Concatenates two arrays along the specified axis

Source

pub fn map<F>(&self, f: F) -> Self
where F: Fn(f64) -> f64,

Source

pub fn abs(&self) -> Self

Returns the absolute values of array elements

§Returns

A new NDArray with absolute values

Source

pub fn power(&self, n: f64) -> Self

Returns the exponential power of array elements

§Returns

A new NDArray with exponential values

Source

pub fn cumsum(&self) -> Self

Returns the cumulative sum of array elements

§Returns

A new NDArray with cumulative sums

Source

pub fn round(&self, decimals: i32) -> Self

Returns array with elements rounded to specified decimals

§Arguments
  • decimals - Number of decimal places to round to
§Returns

A new NDArray with rounded values

Source

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

Returns indices that would sort the array

§Returns

A vector of indices that would sort the array

Source

pub fn unique(&self) -> Self

Returns unique elements of the array

§Returns

A new NDArray containing unique elements in sorted order

Source

pub fn where_cond<F>(&self, condition: F, x: f64, y: f64) -> Self
where F: Fn(f64) -> bool,

Applies a condition element-wise and returns a new array

§Arguments
  • condition - Function that returns true/false for each element
  • x - Value to use where condition is true
  • y - Value to use where condition is false
§Returns

A new NDArray with values chosen based on condition

Source

pub fn median(&self) -> f64

Returns the median value of the array

§Returns

The median value as f64

Source

pub fn max_axis(&self, axis: usize) -> Self

Returns the maximum values along the specified axis

§Arguments
  • axis - Axis along which to find maximum values
§Returns

NDArray containing maximum values along specified axis

Source

pub fn display(&self) -> String

Returns a string representation of the array

Source

pub fn rand_uniform(shape: &[usize]) -> Self

Creates a new NDArray with random uniform values between 0 and 1

§Arguments
  • shape - Shape of the array
§Example
use nabla_ml::nab_array::NDArray;
 
let arr = NDArray::rand_uniform(&[2, 3]);
assert_eq!(arr.shape(), vec![2, 3]);
Source

pub fn mean_axis(&self, axis: usize) -> Self

Calculates the mean along the specified axis

§Arguments
  • axis - Axis along which to calculate mean (0 for columns, 1 for rows)
Source

pub fn var_axis(&self, axis: usize) -> Self

Calculates the variance along the specified axis

§Arguments
  • axis - Axis along which to calculate variance (0 for columns, 1 for rows)
Source

pub fn to_categorical(&self, num_classes: Option<usize>) -> Self

Converts a class vector (integers) to binary class matrix (one-hot encoding)

§Arguments
  • num_classes - Optional number of classes. If None, it will be inferred from the data
§Returns

A 2D NDArray where each row is a one-hot encoded vector

§Example
use nabla_ml::nab_array::NDArray;
 
let labels = NDArray::from_vec(vec![0.0, 1.0, 2.0]);
let categorical = labels.to_categorical(None);
assert_eq!(categorical.shape(), &[3, 3]);
assert_eq!(categorical.data(), &[1.0, 0.0, 0.0,
                                0.0, 1.0, 0.0,
                                0.0, 0.0, 1.0]);
Source§

impl NDArray

Source

pub fn sqrt(&self) -> Self

Calculates the square root of each element in the array

§Returns

A new NDArray with the square root of each element.

Source

pub fn exp(&self) -> Self

Calculates the exponential (e^x) of each element in the array

§Returns

A new NDArray with the exponential of each element.

Source

pub fn sin(&self) -> Self

Calculates the sine of each element in the array

§Returns

A new NDArray with the sine of each element.

Source

pub fn cos(&self) -> Self

Calculates the cosine of each element in the array

§Returns

A new NDArray with the cosine of each element.

Source

pub fn ln(&self) -> Self

Calculates the natural logarithm of each element in the array

§Returns

A new NDArray with the natural logarithm of each element.

Trait Implementations§

Source§

impl<'a, 'b> Add<&'b NDArray> for &'a NDArray

Implements element-wise addition between two NDArray references

§Arguments

  • self - The first NDArray reference
  • other - The second NDArray reference to add to the first

§Returns

A new NDArray containing the element-wise sum

§Panics

Panics if the shapes of the two arrays don’t match

Source§

type Output = NDArray

The resulting type after applying the + operator.
Source§

fn add(self, other: &'b NDArray) -> NDArray

Performs the + operation. Read more
Source§

impl Add<&NDArray> for NDArray

Source§

type Output = NDArray

The resulting type after applying the + operator.
Source§

fn add(self, other: &NDArray) -> Self::Output

Performs the + operation. Read more
Source§

impl Add<f64> for NDArray

Source§

type Output = NDArray

The resulting type after applying the + operator.
Source§

fn add(self, scalar: f64) -> Self::Output

Performs the + operation. Read more
Source§

impl Add for NDArray

Source§

type Output = NDArray

The resulting type after applying the + operator.
Source§

fn add(self, other: Self) -> Self::Output

Performs the + operation. Read more
Source§

impl Clone for NDArray

Source§

fn clone(&self) -> NDArray

Returns a copy 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 NDArray

Source§

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

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

impl Display for NDArray

Source§

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

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

impl<'a, 'b> Div<&'b NDArray> for &'a NDArray

Implements element-wise division between two NDArray references

§Arguments

  • self - The first NDArray reference (numerator)
  • other - The second NDArray reference (denominator)

§Returns

A new NDArray containing the element-wise quotient

§Panics

Panics if the shapes of the two arrays don’t match

Source§

type Output = NDArray

The resulting type after applying the / operator.
Source§

fn div(self, other: &'b NDArray) -> NDArray

Performs the / operation. Read more
Source§

impl<'a, 'b> Mul<&'b NDArray> for &'a NDArray

Implements element-wise multiplication between two NDArray references

§Arguments

  • self - The first NDArray reference
  • other - The second NDArray reference to multiply with the first

§Returns

A new NDArray containing the element-wise product

§Panics

Panics if the shapes of the two arrays don’t match

Source§

type Output = NDArray

The resulting type after applying the * operator.
Source§

fn mul(self, other: &'b NDArray) -> NDArray

Performs the * operation. Read more
Source§

impl Mul<&NDArray> for f64

Source§

type Output = NDArray

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &NDArray) -> NDArray

Performs the * operation. Read more
Source§

impl Mul<f64> for NDArray

Source§

type Output = NDArray

The resulting type after applying the * operator.
Source§

fn mul(self, scalar: f64) -> Self::Output

Performs the * operation. Read more
Source§

impl<'a, 'b> Sub<&'b NDArray> for &'a NDArray

Implements element-wise subtraction between two NDArray references

§Arguments

  • self - The first NDArray reference
  • other - The second NDArray reference to subtract from the first

§Returns

A new NDArray containing the element-wise difference

§Panics

Panics if the shapes of the two arrays don’t match

Source§

type Output = NDArray

The resulting type after applying the - operator.
Source§

fn sub(self, other: &'b NDArray) -> NDArray

Performs the - operation. Read more
Source§

impl Sub<&NDArray> for NDArray

Source§

type Output = NDArray

The resulting type after applying the - operator.
Source§

fn sub(self, other: &NDArray) -> Self::Output

Performs the - operation. Read more
Source§

impl Sub for NDArray

Source§

type Output = NDArray

The resulting type after applying the - operator.
Source§

fn sub(self, other: Self) -> Self::Output

Performs the - operation. Read more

Auto Trait Implementations§

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V