pub struct Matrix { /* private fields */ }
Expand description

A matrix implementation that supports basic matrix operations.

Implementations§

source§

impl Matrix

source

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

Creates a new matrix with the given dimensions.

Example
let matrix = Matrix::new(3, 2);
source

pub fn from_vec(vec: Vec<f64>, rows: usize, cols: usize) -> Self

Creates a new matrix with the given dimensions and fills it with the given value.

Example
use fast_neural_network::matrix::*;

let matrix = Matrix::from_vec(
    vec![0.03, 0.62, 0.85, 0.60, 0.62, 0.64],
    3,
    2,);

assert_eq!(matrix.get(0, 1), 0.62);
assert_eq!(matrix.rows(), 3);
assert_eq!(matrix.cols(), 2);
source

pub fn from_json(json: &str) -> Self

Creates a new matrix from the given JSON string.

Example
use fast_neural_network::matrix::*;

let matrix = Matrix::from_json(
   r#"{
      "data": [
        0.03,
        0.62,
        0.85,
        0.60,
        0.62,
        0.64
        ],
        "rows": 3,
        "cols": 2
    }"#);

assert_eq!(matrix.get(0, 1), 0.62);
source

pub fn to_json(&self) -> String

transforms the matrix into a JSON string.

Example
use fast_neural_network::matrix::*;

let matrix = Matrix::from_vec(
    vec![0.03, 0.62, 0.85, 0.60, 0.62, 0.64],
    3,
    2,);

assert_eq!(matrix.to_json(), r#"{"data":[0.03,0.62,0.85,0.6,0.62,0.64],"rows":3,"cols":2}"#);
source

pub fn save(&self, path: &str)

Saves the matrix to the given path.

Example
use fast_neural_network::matrix::*;

let matrix = Matrix::from_vec(
    vec![0.03, 0.62, 0.85, 0.60, 0.62, 0.64],
    3,
    2,);

matrix.save("matrix.json");
source

pub fn transpose(&self) -> Matrix

Transposes the matrix.

source

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

Gets the value at the given row and column.

source

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

Sets the value at the given row and column.

source

pub fn rows(&self) -> usize

Returns the number of rows

source

pub fn cols(&self) -> usize

Returns the number of columns

source

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

Multiplies the matrix with the given matrix.

source

pub fn dot_vec(&self, other: &Vec<f64>) -> Vec<f64>

Multiplies the matrix with the given vector.

source

pub fn scalar_mul(&self, scalar: f64) -> Matrix

Multiplies the matrix with the given vector.

source

pub fn sub(&self, other: &Self) -> Matrix

Subptracts the given matrix from the matrix.

source

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

transforms the matrix into a vector.

Trait Implementations§

source§

impl Clone for Matrix

source§

fn clone(&self) -> Matrix

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 Matrix

source§

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

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

impl<'de> Deserialize<'de> for Matrix

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 Matrix

source§

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

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

impl Serialize for Matrix

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

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

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