pub struct IntegratorConfig<F: ComplexScalar> { /* private fields */ }Expand description
Configuration for an adaptive integration run.
IntegratorConfig contains user-facing options that control convergence,
quadrature order, diagnostic storage, error reduction, and singularity
handling.
The configuration is intentionally separate from the integrator state. The config describes how the algorithm should run; the state records what has happened during a particular run.
Implementations§
Source§impl<F> IntegratorConfig<F>
impl<F> IntegratorConfig<F>
Sourcepub fn with_indentation(
self,
point: F::Complex,
radius: F,
side: IndentSide,
) -> Self
pub fn with_indentation( self, point: F::Complex, radius: F, side: IndentSide, ) -> Self
Add an indentation to the contour at the given point
Sourcepub fn with_deformation_tolerance(self, tolerance: F) -> Self
pub fn with_deformation_tolerance(self, tolerance: F) -> Self
Set the tolerance for deformation.
Points within tolerance of the contour will be deformed around
Sourcepub fn store_segment_data(self) -> Self
pub fn store_segment_data(self) -> Self
Whether to retain samples
Sourcepub fn with_integrator_order(self, order: usize) -> Self
pub fn with_integrator_order(self, order: usize) -> Self
Set the quadrature order for integration
Sourcepub fn with_minimum_segment_width(self, width: F) -> Self
pub fn with_minimum_segment_width(self, width: F) -> Self
Set the minimum permitted segment width
Sourcepub fn with_error_norm(self, norm: ErrorNorm) -> Self
pub fn with_error_norm(self, norm: ErrorNorm) -> Self
Set the method for error norm reduction for non-scalar outputs
Sourcepub fn with_max_function_evalutions(
self,
max_function_evaluations: usize,
) -> Self
pub fn with_max_function_evalutions( self, max_function_evaluations: usize, ) -> Self
Set the maximum number of function evaluations permitted
Sourcepub fn with_singularity_handling(self, handling: SingularityHandling) -> Self
pub fn with_singularity_handling(self, handling: SingularityHandling) -> Self
Set the method of singularity handling
Sourcepub fn with_relative_tolerance(self, tolerance: F) -> Self
pub fn with_relative_tolerance(self, tolerance: F) -> Self
Set the relative tolerance at convergence
Sourcepub fn with_absolute_tolerance(self, tolerance: F) -> Self
pub fn with_absolute_tolerance(self, tolerance: F) -> Self
Set the absolute tolerance at convergence
Sourcepub fn with_tolerance_window(self, window: usize) -> Self
pub fn with_tolerance_window(self, window: usize) -> Self
Set the number of consecutive good samples required for convergence
Trait Implementations§
Source§impl<F: Clone + ComplexScalar> Clone for IntegratorConfig<F>
impl<F: Clone + ComplexScalar> Clone for IntegratorConfig<F>
Source§fn clone(&self) -> IntegratorConfig<F>
fn clone(&self) -> IntegratorConfig<F>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<F: Debug + ComplexScalar> Debug for IntegratorConfig<F>
impl<F: Debug + ComplexScalar> Debug for IntegratorConfig<F>
Source§impl<F> Default for IntegratorConfig<F>
impl<F> Default for IntegratorConfig<F>
Auto Trait Implementations§
impl<F> Freeze for IntegratorConfig<F>where
F: Freeze,
impl<F> RefUnwindSafe for IntegratorConfig<F>
impl<F> Send for IntegratorConfig<F>where
F: Send,
impl<F> Sync for IntegratorConfig<F>where
F: Sync,
impl<F> Unpin for IntegratorConfig<F>
impl<F> UnsafeUnpin for IntegratorConfig<F>where
F: UnsafeUnpin,
impl<F> UnwindSafe for IntegratorConfig<F>
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Proc> GenerateBuilder for Proc
impl<Proc> GenerateBuilder for Proc
Source§impl<Proc> GenerateBuilderFallible for Proc
impl<Proc> GenerateBuilderFallible for Proc
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.