pub struct JacobianBatch { /* private fields */ }Expand description
The result of jacobian_batch — one JacobianSolution per lane.
Implementations§
Source§impl JacobianBatch
impl JacobianBatch
Sourcepub fn solutions(&self) -> &[JacobianSolution]
pub fn solutions(&self) -> &[JacobianSolution]
Every lane’s solution, in the order the points were supplied.
Sourcepub fn into_solutions(self) -> Vec<JacobianSolution>
pub fn into_solutions(self) -> Vec<JacobianSolution>
Consume the batch, yielding the per-lane solutions.
Sourcepub fn get(&self, i: usize) -> Option<&JacobianSolution>
pub fn get(&self, i: usize) -> Option<&JacobianSolution>
Lane i’s solution, or None if i is out of range.
Sourcepub fn failure_count(&self) -> usize
pub fn failure_count(&self) -> usize
How many lanes failed.
Sourcepub fn first_failure(&self) -> Option<(usize, DiffStatus)>
pub fn first_failure(&self) -> Option<(usize, DiffStatus)>
The first failing lane index and its status, if any.
Sourcepub fn matrices(self) -> Result<Vec<SquareMatrix>, DiffBatchFailure>
pub fn matrices(self) -> Result<Vec<SquareMatrix>, DiffBatchFailure>
Every lane’s Jacobian, all or nothing.
§Errors
DiffBatchFailure naming the failure count and the first failing lane
if any lane failed. A Vec containing a partially-NaN matrix is never
returned.
Sourcepub fn check_all_ok(&self) -> Result<(), DiffBatchFailure>
pub fn check_all_ok(&self) -> Result<(), DiffBatchFailure>
Err describing the first failure, if any lane failed.
§Errors
DiffBatchFailure as for Self::matrices.
Trait Implementations§
Source§impl Clone for JacobianBatch
impl Clone for JacobianBatch
Auto Trait Implementations§
impl Freeze for JacobianBatch
impl RefUnwindSafe for JacobianBatch
impl Send for JacobianBatch
impl Sync for JacobianBatch
impl Unpin for JacobianBatch
impl UnsafeUnpin for JacobianBatch
impl UnwindSafe for JacobianBatch
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more