pub struct HSFunction<R: RealScalar, const D: DifferentiationLevel> { /* private fields */ }Trait Implementations§
Source§impl<R: RealScalar, const D: DifferentiationLevel> CostFunction<R> for HSFunction<R, D>
impl<R: RealScalar, const D: DifferentiationLevel> CostFunction<R> for HSFunction<R, D>
Source§impl<R: RealScalar, const D: DifferentiationLevel> Function for HSFunction<R, D>
impl<R: RealScalar, const D: DifferentiationLevel> Function for HSFunction<R, D>
fn num_params(&self) -> usize
Source§impl<R: RealScalar, const D: DifferentiationLevel> Gradient<R> for HSFunction<R, D>
impl<R: RealScalar, const D: DifferentiationLevel> Gradient<R> for HSFunction<R, D>
Source§fn gradient_into(&mut self, params: &[R], grad_out: RowMut<'_, R>)
fn gradient_into(&mut self, params: &[R], grad_out: RowMut<'_, R>)
Calculates the gradient for the given parameters.
Source§fn cost_and_gradient_into(&mut self, params: &[R], grad_out: RowMut<'_, R>) -> R
fn cost_and_gradient_into(&mut self, params: &[R], grad_out: RowMut<'_, R>) -> R
Calculates the cost and gradient for the given parameters.
fn allocate_gradient(&self) -> Row<R>
Source§impl<R: RealScalar, const D: DifferentiationLevel> Hessian<R> for HSFunction<R, D>
impl<R: RealScalar, const D: DifferentiationLevel> Hessian<R> for HSFunction<R, D>
Source§fn hessian_into(&mut self, _params: &[R], _hess_out: MatMut<'_, R>)
fn hessian_into(&mut self, _params: &[R], _hess_out: MatMut<'_, R>)
Calculates the Hessian for the given parameters.
Source§fn cost_gradient_and_hessian_into(
&mut self,
_params: &[R],
_grad_out: RowMut<'_, R>,
_hess_out: MatMut<'_, R>,
) -> R
fn cost_gradient_and_hessian_into( &mut self, _params: &[R], _grad_out: RowMut<'_, R>, _hess_out: MatMut<'_, R>, ) -> R
Calculates the cost, gradient, and Hessian for the given parameters.
fn allocate_hessian(&self) -> Mat<R>
Source§impl<R: RealScalar, const D: DifferentiationLevel> Jacobian<R> for HSFunction<R, D>
impl<R: RealScalar, const D: DifferentiationLevel> Jacobian<R> for HSFunction<R, D>
Source§fn residuals_and_jacobian_into(
&mut self,
params: &[R],
residuals_out: ColMut<'_, R>,
jacobian_out: MatMut<'_, R>,
)
fn residuals_and_jacobian_into( &mut self, params: &[R], residuals_out: ColMut<'_, R>, jacobian_out: MatMut<'_, R>, )
Calculates the residuals and Jacobian for the given parameters.
Source§fn jacobian_into(&mut self, params: &[R], jacobian_out: MatMut<'_, R>)
fn jacobian_into(&mut self, params: &[R], jacobian_out: MatMut<'_, R>)
Calculates the Jacobian for the given parameters.
fn allocate_jacobian(&self) -> Mat<R>
Source§impl<R: RealScalar, const D: DifferentiationLevel> ResidualFunction<R> for HSFunction<R, D>
impl<R: RealScalar, const D: DifferentiationLevel> ResidualFunction<R> for HSFunction<R, D>
fn num_residuals(&self) -> usize
Source§fn residuals_into(&mut self, params: &[R], residuals_out: ColMut<'_, R>)
fn residuals_into(&mut self, params: &[R], residuals_out: ColMut<'_, R>)
Calculates the residuals for the given parameters.
fn allocate_residual(&self) -> Col<R>
Auto Trait Implementations§
impl<R, const D: usize> Freeze for HSFunction<R, D>where
R: Freeze,
impl<R, const D: usize> RefUnwindSafe for HSFunction<R, D>
impl<R, const D: usize> !Send for HSFunction<R, D>
impl<R, const D: usize> !Sync for HSFunction<R, D>
impl<R, const D: usize> Unpin for HSFunction<R, D>where
R: Unpin,
impl<R, const D: usize> UnwindSafe for HSFunction<R, D>
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
Source§impl<T> DistributionExt for Twhere
T: ?Sized,
impl<T> DistributionExt for Twhere
T: ?Sized,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more