Struct SolverOptionsBuilder

Source
pub struct SolverOptionsBuilder(/* private fields */);

Implementations§

Source§

impl SolverOptionsBuilder

Source

pub fn new() -> Self

Source

pub fn build(self) -> Result<SolverOptions, SolverOptionsBuildingError>

Source

pub fn validate(&self) -> Result<(), SolverOptionsBuildingError>

Source

pub fn is_valid(&self) -> bool

Source

pub fn minimizer_type(self, minimizer_type: MinimizerType) -> Self

Source

pub fn line_search_direction_type( self, line_search_direction_type: LineSearchDirectionType, ) -> Self

Source

pub fn line_search_type(self, line_search_type: LineSearchType) -> Self

Source

pub fn nonlinear_conjugate_gradient_type( self, nonlinear_conjugate_gradient_type: NonlinearConjugateGradientType, ) -> Self

Source

pub fn max_lbfgs_rank(self, max_rank: i32) -> Self

Source

pub fn use_approximate_eigenvalue_bfgs_scaling(self, yes: bool) -> Self

Source

pub fn line_search_interpolation_type( self, line_search_interpolation_type: LineSearchInterpolationType, ) -> Self

Source

pub fn min_line_search_step_size(self, step_size: f64) -> Self

Source

pub fn line_search_sufficient_function_decrease( self, sufficient_decrease: f64, ) -> Self

Source

pub fn max_line_search_step_contraction(self, max_step_contraction: f64) -> Self

Source

pub fn min_line_search_step_contraction(self, min_step_contraction: f64) -> Self

Source

pub fn max_num_line_search_direction_restarts( self, max_num_restarts: i32, ) -> Self

Source

pub fn line_search_sufficient_curvature_decrease( self, sufficient_curvature_decrease: f64, ) -> Self

Source

pub fn max_line_search_step_expansion(self, max_step_expansion: f64) -> Self

Source

pub fn trust_region_strategy_type( self, trust_region_strategy_type: TrustRegionStrategyType, ) -> Self

Source

pub fn dogleg_type(self, dogleg_type: DoglegType) -> Self

Source

pub fn use_nonmonotonic_steps(self, yes: bool) -> Self

Source

pub fn max_consecutive_nonmonotonic_steps( self, max_consecutive_nonmonotonic_steps: i32, ) -> Self

Source

pub fn max_num_iterations(self, max_num_iterations: i32) -> Self

Source

pub fn max_solver_time_in_seconds(self, max_solver_time_in_seconds: f64) -> Self

Source

pub fn num_threads(self, num_threads: i32) -> Self

Source

pub fn initial_trust_region_radius( self, initial_trust_region_radius: f64, ) -> Self

Source

pub fn max_trust_region_radius(self, max_trust_region_radius: f64) -> Self

Source

pub fn min_trust_region_radius(self, min_trust_region_radius: f64) -> Self

Source

pub fn min_relative_decrease(self, min_relative_decrease: f64) -> Self

Source

pub fn min_lm_diagonal(self, min_lm_diagonal: f64) -> Self

Source

pub fn max_lm_diagonal(self, max_lm_diagonal: f64) -> Self

Source

pub fn max_num_consecutive_invalid_steps( self, max_num_consecutive_invalid_steps: i32, ) -> Self

Source

pub fn function_tolerance(self, function_tolerance: f64) -> Self

Source

pub fn gradient_tolerance(self, gradient_tolerance: f64) -> Self

Source

pub fn parameter_tolerance(self, parameter_tolerance: f64) -> Self

Source

pub fn linear_solver_type(self, linear_solver_type: LinearSolverType) -> Self

Source

pub fn preconditioner_type( self, preconditioner_type: PreconditionerType, ) -> Self

Source

pub fn visibility_clustering_type( self, visibility_clustering_type: VisibilityClusteringType, ) -> Self

Source

pub fn residual_blocks_for_subset_preconditioner( self, residual_blocks: &[ResidualBlockId], ) -> Self

Source

pub fn dense_linear_algebra_library_type( self, dense_linear_algebra_library_type: DenseLinearAlgebraLibraryType, ) -> Self

Source

pub fn sparse_linear_algebra_library_type( self, sparse_linear_algebra_library_type: SparseLinearAlgebraLibraryType, ) -> Self

Source

pub fn logging_type(self, logging_type: LoggingType) -> Self

Source

pub fn minimizer_progress_to_stdout(self, yes: bool) -> Self

Source

pub fn trust_region_minimizer_iterations_to_dump( self, iterations_to_dump: &[i32], ) -> Self

Source

pub fn trust_region_problem_dump_directory( self, directory: impl AsRef<Path>, ) -> Self

Source

pub fn trust_region_problem_dump_format_type( self, trust_region_problem_dump_format_type: DumpFormatType, ) -> Self

Source

pub fn check_gradients(self, yes: bool) -> Self

Source

pub fn gradient_check_relative_precision( self, gradient_check_relative_precision: f64, ) -> Self

Source

pub fn gradient_check_numeric_derivative_relative_step_size( self, gradient_check_numeric_derivative_relative_step_size: f64, ) -> Self

Source

pub fn update_state_every_iteration(self, yes: bool) -> Self

Trait Implementations§

Source§

impl Default for SolverOptionsBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.