Struct FaerVec 

pub struct FaerVec<T>
where
    T: FaerScalar,
{ /* private fields */ }

Implementations

impl<T> FaerVec<T>

where T: FaerScalar,

pub fn check_for_nan(&self, label: &str) -> bool

Trait Implementations

impl<T> Add for FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the + operator.

fn add(self, rhs: FaerVec<T>) -> <FaerVec<T> as Add>::Output

Performs the + operation.

impl<T> Add<&FaerVec<T>> for &FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the + operator.

fn add(self, rhs: &FaerVec<T>) -> <&FaerVec<T> as Add<&FaerVec<T>>>::Output

Performs the + operation.

impl<T> Add<&FaerVec<T>> for FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the + operator.

fn add(self, rhs: &FaerVec<T>) -> <FaerVec<T> as Add<&FaerVec<T>>>::Output

Performs the + operation.

impl<T> Add<&FaerVec<T>> for FaerVecRef<'_, T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the + operator.

fn add( self, rhs: &FaerVec<T>, ) -> <FaerVecRef<'_, T> as Add<&FaerVec<T>>>::Output

Performs the + operation.

impl<T> Add<&FaerVecRef<'_, T>> for &FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the + operator.

fn add( self, rhs: &FaerVecRef<'_, T>, ) -> <&FaerVec<T> as Add<&FaerVecRef<'_, T>>>::Output

Performs the + operation.

impl<T> Add<&FaerVecRef<'_, T>> for FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the + operator.

fn add( self, rhs: &FaerVecRef<'_, T>, ) -> <FaerVec<T> as Add<&FaerVecRef<'_, T>>>::Output

Performs the + operation.

impl<T> Add<FaerVec<T>> for &FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the + operator.

fn add(self, rhs: FaerVec<T>) -> <&FaerVec<T> as Add<FaerVec<T>>>::Output

Performs the + operation.

impl<T> Add<FaerVec<T>> for FaerVecRef<'_, T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the + operator.

fn add(self, rhs: FaerVec<T>) -> <FaerVecRef<'_, T> as Add<FaerVec<T>>>::Output

Performs the + operation.

impl<T> Add<FaerVecRef<'_, T>> for &FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the + operator.

fn add( self, rhs: FaerVecRef<'_, T>, ) -> <&FaerVec<T> as Add<FaerVecRef<'_, T>>>::Output

Performs the + operation.

impl<T> Add<FaerVecRef<'_, T>> for FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the + operator.

fn add( self, rhs: FaerVecRef<'_, T>, ) -> <FaerVec<T> as Add<FaerVecRef<'_, T>>>::Output

Performs the + operation.

impl<T> AddAssign for FaerVec<T>

where T: Scalar + FaerScalar,

fn add_assign(&mut self, rhs: FaerVec<T>)

Performs the += operation.

impl<T> AddAssign<&FaerVec<T>> for FaerVec<T>

where T: Scalar + FaerScalar,

fn add_assign(&mut self, rhs: &FaerVec<T>)

Performs the += operation.

impl<T> AddAssign<&FaerVec<T>> for FaerVecMut<'_, T>

where T: Scalar + FaerScalar,

fn add_assign(&mut self, rhs: &FaerVec<T>)

Performs the += operation.

impl<T> AddAssign<&FaerVecRef<'_, T>> for FaerVec<T>

where T: Scalar + FaerScalar,

fn add_assign(&mut self, rhs: &FaerVecRef<'_, T>)

Performs the += operation.

impl<T> AddAssign<FaerVec<T>> for FaerVecMut<'_, T>

where T: Scalar + FaerScalar,

fn add_assign(&mut self, rhs: FaerVec<T>)

Performs the += operation.

impl<T> AddAssign<FaerVecRef<'_, T>> for FaerVec<T>

where T: Scalar + FaerScalar,

fn add_assign(&mut self, rhs: FaerVecRef<'_, T>)

Performs the += operation.

impl<T> Clone for FaerVec<T>

where T: Clone + FaerScalar,

fn clone(&self) -> FaerVec<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for FaerVec<T>

where T: Debug + FaerScalar,

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

Formats the value using the given formatter.

impl<T> DefaultDenseMatrix for FaerVec<T>

where T: FaerScalar,

type M = FaerMat<T>

impl<'a, T> Div<Scale<T>> for FaerVec<T>

where T: FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the / operator.

fn div(self, rhs: Scale<T>) -> <FaerVec<T> as Div<Scale<T>>>::Output

Performs the / operation.

impl<T> From<Col<Own<T>>> for FaerVec<T>

where T: FaerScalar,

fn from(data: Col<Own<T>>) -> FaerVec<T>

Converts to this type from the input type.

impl<T> Index<usize> for FaerVec<T>

where T: Scalar + FaerScalar,

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &<FaerVec<T> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for FaerVec<T>

where T: Scalar + FaerScalar,

fn index_mut( &mut self, index: usize, ) -> &mut <FaerVec<T> as Index<usize>>::Output

Performs the mutable indexing (container[index]) operation.

impl<T> Mul<Scale<T>> for FaerVec<T>

where T: FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Scale<T>) -> <FaerVec<T> as Mul<Scale<T>>>::Output

Performs the * operation.

impl<T> Mul<Scale<T>> for &FaerVec<T>

where T: FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Scale<T>) -> <&FaerVec<T> as Mul<Scale<T>>>::Output

Performs the * operation.

impl<'a, T> MulAssign<Scale<T>> for FaerVec<T>

where T: FaerScalar,

fn mul_assign(&mut self, rhs: Scale<T>)

Performs the *= operation.

impl<T> PartialEq for FaerVec<T>

where T: PartialEq + FaerScalar,

fn eq(&self, other: &FaerVec<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T> StructuralPartialEq for FaerVec<T>

where T: PartialEq + FaerScalar,

impl<T> Sub for FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the - operator.

fn sub(self, rhs: FaerVec<T>) -> <FaerVec<T> as Sub>::Output

Performs the - operation.

impl<T> Sub<&FaerVec<T>> for &FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &FaerVec<T>) -> <&FaerVec<T> as Sub<&FaerVec<T>>>::Output

Performs the - operation.

impl<T> Sub<&FaerVec<T>> for FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the - operator.

fn sub(self, rhs: &FaerVec<T>) -> <FaerVec<T> as Sub<&FaerVec<T>>>::Output

Performs the - operation.

impl<T> Sub<&FaerVec<T>> for FaerVecRef<'_, T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the - operator.

fn sub( self, rhs: &FaerVec<T>, ) -> <FaerVecRef<'_, T> as Sub<&FaerVec<T>>>::Output

Performs the - operation.

impl<T> Sub<&FaerVecRef<'_, T>> for &FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the - operator.

fn sub( self, rhs: &FaerVecRef<'_, T>, ) -> <&FaerVec<T> as Sub<&FaerVecRef<'_, T>>>::Output

Performs the - operation.

impl<T> Sub<&FaerVecRef<'_, T>> for FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the - operator.

fn sub( self, rhs: &FaerVecRef<'_, T>, ) -> <FaerVec<T> as Sub<&FaerVecRef<'_, T>>>::Output

Performs the - operation.

impl<T> Sub<FaerVec<T>> for &FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the - operator.

fn sub(self, rhs: FaerVec<T>) -> <&FaerVec<T> as Sub<FaerVec<T>>>::Output

Performs the - operation.

impl<T> Sub<FaerVec<T>> for FaerVecRef<'_, T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the - operator.

fn sub(self, rhs: FaerVec<T>) -> <FaerVecRef<'_, T> as Sub<FaerVec<T>>>::Output

Performs the - operation.

impl<T> Sub<FaerVecRef<'_, T>> for &FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the - operator.

fn sub( self, rhs: FaerVecRef<'_, T>, ) -> <&FaerVec<T> as Sub<FaerVecRef<'_, T>>>::Output

Performs the - operation.

impl<T> Sub<FaerVecRef<'_, T>> for FaerVec<T>

where T: Scalar + FaerScalar,

type Output = FaerVec<T>

The resulting type after applying the - operator.

fn sub( self, rhs: FaerVecRef<'_, T>, ) -> <FaerVec<T> as Sub<FaerVecRef<'_, T>>>::Output

Performs the - operation.

impl<T> SubAssign for FaerVec<T>

where T: Scalar + FaerScalar,

fn sub_assign(&mut self, rhs: FaerVec<T>)

Performs the -= operation.

impl<T> SubAssign<&FaerVec<T>> for FaerVec<T>

where T: Scalar + FaerScalar,

fn sub_assign(&mut self, rhs: &FaerVec<T>)

Performs the -= operation.

impl<T> SubAssign<&FaerVec<T>> for FaerVecMut<'_, T>

where T: Scalar + FaerScalar,

fn sub_assign(&mut self, rhs: &FaerVec<T>)

Performs the -= operation.

impl<T> SubAssign<&FaerVecRef<'_, T>> for FaerVec<T>

where T: Scalar + FaerScalar,

fn sub_assign(&mut self, rhs: &FaerVecRef<'_, T>)

Performs the -= operation.

impl<T> SubAssign<FaerVec<T>> for FaerVecMut<'_, T>

where T: Scalar + FaerScalar,

fn sub_assign(&mut self, rhs: FaerVec<T>)

Performs the -= operation.

impl<T> SubAssign<FaerVecRef<'_, T>> for FaerVec<T>

where T: Scalar + FaerScalar,

fn sub_assign(&mut self, rhs: FaerVecRef<'_, T>)

Performs the -= operation.

impl<T> Vector for FaerVec<T>

where T: FaerScalar,

type View<'a> = FaerVecRef<'a, T>

type ViewMut<'a> = FaerVecMut<'a, T>

type Index = FaerVecIndex

fn context(&self) -> &<FaerVec<T> as VectorCommon>::C

Get the context associated with this vector (for device placement, threading, etc.).

fn inner_mut(&mut self) -> &mut <FaerVec<T> as VectorCommon>::Inner

Get a mutable reference to the inner representation of the vector.

fn len(&self) -> usize

Get the per-batch length (number of states) in this vector. For batched vectors, this returns nstates, not nstates * nbatch.

fn get_index(&self, index: usize) -> <FaerVec<T> as VectorCommon>::T

Get the value at the specified index.

fn set_index(&mut self, index: usize, value: <FaerVec<T> as VectorCommon>::T)

Set the value at the specified index to value.

fn norm(&self, k: i32) -> T

Compute the $\ell_k$ norm: $(\sum_i |x_i|^k)^{1/k}$

fn squared_norm( &self, y: &FaerVec<T>, atol: &FaerVec<T>, rtol: <FaerVec<T> as VectorCommon>::T, ) -> <FaerVec<T> as VectorCommon>::T

Compute the squared weighted norm for error control: $\sum_i (x_i / (|y_i| \cdot \text{rtol} + \text{atol}_i))^2$

fn as_view(&self) -> <FaerVec<T> as Vector>::View<'_>

Create an immutable view of this vector.

fn as_view_mut(&mut self) -> <FaerVec<T> as Vector>::ViewMut<'_>

Create a mutable view of this vector.

fn get_batch(&self, batch: usize) -> <FaerVec<T> as Vector>::View<'_>

Get an immutable view of a single batch (with nbatch=1 context).

fn get_batch_mut(&mut self, batch: usize) -> <FaerVec<T> as Vector>::ViewMut<'_>

Get a mutable view of a single batch (with nbatch=1 context).

fn copy_from(&mut self, other: &FaerVec<T>)

Copy all values from other into this vector.

fn copy_from_view(&mut self, other: &<FaerVec<T> as Vector>::View<'_>)

Copy all values from a vector view into this vector.

fn fill(&mut self, value: <FaerVec<T> as VectorCommon>::T)

Fill all elements of this vector with value.

fn from_element( nstates: usize, value: <FaerVec<T> as VectorCommon>::T, ctx: <FaerVec<T> as VectorCommon>::C, ) -> FaerVec<T>

Create a vector of length nstates with all elements initialized to value.

fn from_vec( vec: Vec<<FaerVec<T> as VectorCommon>::T>, ctx: <FaerVec<T> as VectorCommon>::C, ) -> FaerVec<T>

Create a vector from a Rust Vec.

fn from_slice( slice: &[<FaerVec<T> as VectorCommon>::T], ctx: <FaerVec<T> as VectorCommon>::C, ) -> FaerVec<T>

Create a vector from a slice.

fn clone_as_vec(&self) -> Vec<<FaerVec<T> as VectorCommon>::T>

Clone this vector as a Rust Vec.

fn zeros(nstates: usize, ctx: <FaerVec<T> as VectorCommon>::C) -> FaerVec<T>

Create a vector of length nstates with all elements set to zero.

fn axpy( &mut self, alpha: <FaerVec<T> as VectorCommon>::T, x: &FaerVec<T>, beta: <FaerVec<T> as VectorCommon>::T, )

Compute the AXPY operation: self = alpha * x + beta * self

fn axpy_v( &mut self, alpha: <FaerVec<T> as VectorCommon>::T, x: &<FaerVec<T> as Vector>::View<'_>, beta: <FaerVec<T> as VectorCommon>::T, )

Compute the AXPY operation with a vector view: self = alpha * x + beta * self

fn batched_axpy( &mut self, alpha: &[<FaerVec<T> as VectorCommon>::T], x: &FaerVec<T>, beta: <FaerVec<T> as VectorCommon>::T, )

Per-batch AXPY: self[i]_b = alpha[b] * x[i]_b + beta * self[i]_b

fn component_mul_assign(&mut self, other: &FaerVec<T>)

Element-wise multiplication: self_i *= other_i

fn component_div_assign(&mut self, other: &FaerVec<T>)

Element-wise division: self_i /= other_i

fn root_finding( &self, g1: &FaerVec<T>, ) -> (bool, <FaerVec<T> as VectorCommon>::T, i32)

Detect roots (zero crossings) between this vector (as g0) and another vector (g1).

fn assign_at_indices( &mut self, indices: &<FaerVec<T> as Vector>::Index, value: <FaerVec<T> as VectorCommon>::T, )

Assign value to all elements at the specified indices.

fn copy_from_indices( &mut self, other: &FaerVec<T>, indices: &<FaerVec<T> as Vector>::Index, )

Copy values from other at the specified indices: self[indices[i]] = other[indices[i]]

fn gather( &mut self, other: &FaerVec<T>, indices: &<FaerVec<T> as Vector>::Index, )

Gather values from other at indices: self[i] = other[indices[i]]

fn scatter( &self, indices: &<FaerVec<T> as Vector>::Index, other: &mut FaerVec<T>, )

Scatter values to other at indices: other[indices[i]] = self[i]

fn total_len(&self) -> usize

Get the total number of elements stored, including all batches. Returns self.len() * self.context().nbatch().

fn is_empty(&self) -> bool

Check if the vector is empty.

fn assert_eq_st(&self, other: &Self, tol: Self::T)

Assert that this vector equals other within a scalar tolerance tol.

fn assert_eq_norm( &self, other: &Self, atol: &Self, rtol: Self::T, factor: Self::T, )

Assert that this vector equals other using a weighted norm (same as used by ODE solvers).

fn assert_eq(&self, other: &Self, tol: &Self)

Assert that this vector equals other using a vector of per-element tolerances.

fn assert_eq_vec(s: Vec<Self::T>, other: Vec<Self::T>, tol: Vec<Self::T>)

impl<T> VectorCommon for FaerVec<T>

where T: Scalar + FaerScalar,

type T = T

type C = FaerContext

type Inner = Col<Own<T>>

fn inner(&self) -> &<FaerVec<T> as VectorCommon>::Inner

impl<T> VectorHost for FaerVec<T>

where T: FaerScalar,

fn as_mut_slice(&mut self) -> &mut [<FaerVec<T> as VectorCommon>::T]

Get the vector data as a mutable slice.

fn as_slice(&self) -> &[<FaerVec<T> as VectorCommon>::T]

Get the vector data as an immutable slice.