Struct rgsl::types::vector::VectorF64

pub struct VectorF64 { /* private fields */ }

Implementations

impl VectorF64

pub fn new(size: usize) -> Option<VectorF64>

create a new VectorF64 with all elements set to zero

pub fn from_slice(slice: &[f64]) -> Option<VectorF64>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn as_slice(&self) -> Option<&[f64]>

pub fn as_slice_mut(&mut self) -> Option<&mut [f64]>

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

This function returns the i-th element of a vector v. If i lies outside the allowed range of 0 to n-1 then the error handler is invoked and 0 is returned.

pub fn set(&mut self, i: usize, x: f64) -> &mut VectorF64

This function sets the value of the i-th element of a vector v to x. If i lies outside the allowed range of 0 to n-1 then the error handler is invoked.

pub fn set_all(&mut self, x: f64) -> &mut VectorF64

This function sets all the elements of the vector v to the value x.

pub fn set_zero(&mut self) -> &mut VectorF64

This function sets all the elements of the vector v to zero.

pub fn set_basis(&mut self, i: usize) -> &mut VectorF64

This function makes a basis vector by setting all the elements of the vector v to zero except for the i-th element which is set to one.

pub fn copy_from(&mut self, other: &VectorF64) -> Result<(), Value>

This function copies the elements of the other vector into the self vector. The two vectors must have the same length.

pub fn copy_to(&self, other: &mut VectorF64) -> Result<(), Value>

This function copies the elements of the self vector into the other vector. The two vectors must have the same length.

pub fn swap(&mut self, other: &mut VectorF64) -> Result<(), Value>

This function exchanges the elements of the vectors by copying. The two vectors must have the same length.

pub fn swap_elements(&mut self, i: usize, j: usize) -> Result<(), Value>

This function exchanges the i-th and j-th elements of the vector v in-place.

pub fn reverse(&mut self) -> Result<(), Value>

This function reverses the order of the elements of the vector v.

pub fn add(&mut self, other: &VectorF64) -> Result<(), Value>

This function adds the elements of the other vector to the elements of the self vector. The result a_i <- a_i + b_i is stored in self and other remains unchanged. The two vectors must have the same length.

pub fn sub(&mut self, other: &VectorF64) -> Result<(), Value>

This function subtracts the elements of the self vector from the elements of the other vector. The result a_i <- a_i - b_i is stored in self and other remains unchanged. The two vectors must have the same length.

pub fn mul(&mut self, other: &VectorF64) -> Result<(), Value>

This function multiplies the elements of the self vector a by the elements of the other vector. The result a_i <- a_i * b_i is stored in self and other remains unchanged. The two vectors must have the same length.

pub fn div(&mut self, other: &VectorF64) -> Result<(), Value>

This function divides the elements of the self vector by the elements of the other vector. The result a_i <- a_i / b_i is stored in self and other remains unchanged. The two vectors must have the same length.

pub fn scale(&mut self, x: f64) -> Result<(), Value>

This function multiplies the elements of the self vector by the constant factor x. The result a_i <- a_i is stored in self.

pub fn add_constant(&mut self, x: f64) -> Result<(), Value>

This function adds the constant value x to the elements of the self vector. The result a_i <- a_i + x is stored in self.

pub fn max(&self) -> f64

This function returns the maximum value in the self vector.

pub fn min(&self) -> f64

This function returns the minimum value in the self vector.

pub fn minmax(&self) -> (f64, f64)

This function returns the minimum and maximum values in the self vector.

pub fn max_index(&self) -> usize

This function returns the index of the maximum value in the self vector. When there are several equal maximum elements then the lowest index is returned.

pub fn min_index(&self) -> usize

This function returns the index of the minimum value in the self vector. When there are several equal minimum elements then the lowest index is returned.

pub fn minmax_index(&self) -> (usize, usize)

This function returns the indices of the minimum and maximum values in the self vector. When there are several equal minimum or maximum elements then the lowest indices are returned.

pub fn is_null(&self) -> bool

This function returns true if all the elements of the self vector are equal to 0.

pub fn is_pos(&self) -> bool

This function returns true if all the elements of the self vector are stricly positive.

pub fn is_neg(&self) -> bool

This function returns true if all the elements of the self vector are stricly negative.

pub fn is_non_neg(&self) -> bool

This function returns true if all the elements of the self vector are stricly non-negative.

pub fn equal(&self, other: &VectorF64) -> bool

pub fn clone(&self) -> Option<VectorF64>

pub fn subvector(&mut self, offset: usize, n: usize) -> VectorF64View<'_>

Trait Implementations

impl Debug for VectorF64

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

Formats the value using the given formatter.

impl Drop for VectorF64

fn drop(&mut self)

Executes the destructor for this type.