Struct rusty_machine::prelude::Vector [−] [src]

pub struct Vector<T> {
    // some fields omitted
}

The Vector struct.

Can be instantiated with any type.

Methods

`impl<T> Vector<T>`

`fn new<U>(data: U) -> Vector<T> where U: Into<Vec<T>>`

Constructor for Vector struct.

Requires the vector data.

Examples

use rulinalg::vector::Vector;

let vec = Vector::new(vec![1.0,2.0,3.0,4.0]);

`fn size(&self) -> usize`

Returns the size of the Vector.

`fn data(&self) -> &Vec<T>`

Returns a non-mutable reference to the underlying data.

`fn mut_data(&mut self) -> &mut [T]`

Returns a mutable slice of the underlying data.

`fn into_vec(self) -> Vec<T>`

Consumes the Vector and returns the Vec of data.

`impl<T> Vector<T> where T: Copy`

`fn apply(self, f: &Fn(T)) -> Vector<T>`

Applies a function to each element in the vector.

Examples

use rulinalg::vector::Vector;
fn add_two(a: f64) -> f64 {
    a + 2f64
}

let a = Vector::new(vec![0.;4]);

let b = a.apply(&add_two);

assert_eq!(b.into_vec(), vec![2.0; 4]);

`impl<T> Vector<T> where T: Copy + PartialOrd<T>`

`fn argmax(&self) -> (usize, T)`

Find the argmax of the Vector.

Returns the index of the largest value in the vector.

Examples

use rulinalg::vector::Vector;

let a = Vector::new(vec![1.0,2.0,0.0,5.0]);
let b = a.argmax();
assert_eq!(b.0, 3);
assert_eq!(b.1, 5.0);

`fn argmin(&self) -> (usize, T)`

Find the argmin of the Vector.

Returns the index of the smallest value in the vector.

Examples

use rulinalg::vector::Vector;

let a = Vector::new(vec![1.0,2.0,0.0,5.0]);
let b = a.argmin();
assert_eq!(b.0, 2);
assert_eq!(b.1, 0.0);

`fn select(&self, idxs: &[usize]) -> Vector<T>`

Select elements from the Vector and form a new Vector from them.

Examples

use rulinalg::vector::Vector;

let a = Vector::new(vec![1.0,2.0,3.0,4.0,5.0]);

let a_lower = a.select(&[2,3,4]);

// Prints [3,4,5]
println!("{:?}", a_lower.data());

`impl<T> Vector<T> where T: Clone + Zero`

`fn zeros(size: usize) -> Vector<T>`

Constructs Vector of all zeros.

Requires the size of the vector.

Examples

use rulinalg::vector::Vector;

let vec = Vector::<f64>::zeros(10);

`impl<T> Vector<T> where T: Clone + One`

`fn ones(size: usize) -> Vector<T>`

Constructs Vector of all ones.

Requires the size of the vector.

Examples

use rulinalg::vector::Vector;

let vec = Vector::<f64>::ones(10);

`impl<T> Vector<T> where T: Add<T, Output=T> + Mul<T, Output=T> + Zero + Copy`

`fn dot(&self, v: &Vector<T>) -> T`

Compute dot product with specified Vector.

Examples

use rulinalg::vector::Vector;

let a = Vector::new(vec![1.0,2.0,3.0,4.0]);
let b = Vector::new(vec![2.0; 4]);

let c = a.dot(&b);
assert_eq!(c, 20.0);

`impl<T> Vector<T> where T: Copy + Add<T, Output=T> + Zero`

`fn sum(&self) -> T`

The sum of the vector.

Returns the sum of all elements in the vector.

Examples

use rulinalg::vector::Vector;

let a = Vector::new(vec![1.0,2.0,3.0,4.0]);

let c = a.sum();
assert_eq!(c, 10.0);

`impl<T> Vector<T> where T: Copy + Mul<T, Output=T>`

`fn elemul(&self, v: &Vector<T>) -> Vector<T>`

The elementwise product of two vectors.

Examples

use rulinalg::vector::Vector;

let a = Vector::new(vec![1.0,2.0,3.0,4.0]);
let b = Vector::new(vec![1.0,2.0,3.0,4.0]);

let c = &a.elemul(&b);
assert_eq!(*c.data(), vec![1.0, 4.0, 9.0, 16.0]);

`impl<T> Vector<T> where T: Copy + Div<T, Output=T>`

`fn elediv(&self, v: &Vector<T>) -> Vector<T>`

The elementwise division of two vectors.

Examples

use rulinalg::vector::Vector;

let a = Vector::new(vec![1.0,2.0,3.0,4.0]);
let b = Vector::new(vec![1.0,2.0,3.0,4.0]);

let c = &a.elediv(&b);
assert_eq!(*c.data(), vec![1.0; 4]);

`impl<T> Vector<T> where T: Float + FromPrimitive`

`fn mean(&self) -> T`

The mean of the vector.

Returns the arithmetic mean of the vector.

Examples

use rulinalg::vector::Vector;

let a = Vector::<f32>::new(vec![1.0,2.0,3.0,4.0]);

let c = a.mean();
assert_eq!(c, 2.5);

`fn variance(&self) -> T`

The variance of the vector.

Returns the unbiased sample variance of the vector.

Examples

use rulinalg::vector::Vector;

let a = Vector::<f32>::new(vec![1.0,2.0,3.0,4.0]);

let c = a.variance();
assert_eq!(c, 5.0/3.0);

Trait Implementations

`impl<T> Hash for Vector<T> where T: Hash`

`fn hash<HT>(&self, arg_0: &mut HT) where HT: Hasher`

`impl<T> Eq for Vector<T> where T: Eq`

`impl<T> PartialEq<Vector<T>> for Vector<T> where T: PartialEq<T>`

`fn eq(&self, __arg_0: &Vector<T>) -> bool`

`fn ne(&self, __arg_0: &Vector<T>) -> bool`

`impl<T> Debug for Vector<T> where T: Debug`

`fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>`

Formats the value using the given formatter.

`impl<T> Clone for Vector<T> where T: Clone`

`fn clone(&self) -> Vector<T>`

Clones the Vector.

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

Performs copy-assignment from source. Read more

`impl<T> Mul<T> for Vector<T> where T: Copy + Mul<T, Output=T>`

Multiplies vector by scalar.

`type Output = Vector<T>`

The resulting type after applying the * operator

`fn mul(self, f: T) -> Vector<T>`

The method for the * operator

`impl<'a, T> Mul<T> for &'a Vector<T> where T: Copy + Mul<T, Output=T>`

Multiplies vector by scalar.

`type Output = Vector<T>`

The resulting type after applying the * operator

`fn mul(self, f: T) -> Vector<T>`

The method for the * operator

`impl<'a, T> Mul<&'a T> for Vector<T> where T: Copy + Mul<T, Output=T>`

Multiplies vector by scalar.

`type Output = Vector<T>`

The resulting type after applying the * operator

`fn mul(self, f: &T) -> Vector<T>`

The method for the * operator

`impl<'a, 'b, T> Mul<&'b T> for &'a Vector<T> where T: Copy + Mul<T, Output=T>`

Multiplies vector by scalar.

`type Output = Vector<T>`

The resulting type after applying the * operator

`fn mul(self, f: &T) -> Vector<T>`

The method for the * operator

`impl<T> Div<T> for Vector<T> where T: Copy + Div<T, Output=T> + PartialEq<T> + Zero`

Divides vector by scalar.

`type Output = Vector<T>`

`fn div(self, f: T) -> Vector<T>`

`impl<'a, T> Div<T> for &'a Vector<T> where T: Copy + Div<T, Output=T> + PartialEq<T> + Zero`

Divides vector by scalar.

`type Output = Vector<T>`

`fn div(self, f: T) -> Vector<T>`

`impl<'a, T> Div<&'a T> for Vector<T> where T: Copy + Div<T, Output=T> + PartialEq<T> + Zero`

Divides vector by scalar.

`type Output = Vector<T>`

`fn div(self, f: &T) -> Vector<T>`

`impl<'a, 'b, T> Div<&'b T> for &'a Vector<T> where T: Copy + Div<T, Output=T> + PartialEq<T> + Zero`

Divides vector by scalar.

`type Output = Vector<T>`

`fn div(self, f: &T) -> Vector<T>`

`impl<T> Add<T> for Vector<T> where T: Copy + Add<T, Output=T>`

Adds scalar to vector.