Alexandria 2.31.0
SDC-CH common library for the Euclid project
Loading...
Searching...
No Matches
Public Attributes | List of all members
Euclid::MathUtils::SecantParams Struct Reference

#include <SecantMethod.h>

Collaboration diagram for Euclid::MathUtils::SecantParams:
Collaboration graph
[legend]

Public Attributes

std::size_t max_iter = 1000
 Maximum number of iterations.
 
double atol = 1e-8
 
double min = -std::numeric_limits<double>::infinity()
 If the gradient moves the next iteration below this limit, clip the result.
 
double max = std::numeric_limits<double>::infinity()
 If the gradient moves the next iteration above this limit, clip the result.
 

Detailed Description

Definition at line 30 of file SecantMethod.h.

Member Data Documentation

◆ atol

double Euclid::MathUtils::SecantParams::atol = 1e-8

The method will finish once func(root) <= atol

Definition at line 32 of file SecantMethod.h.

◆ max

double Euclid::MathUtils::SecantParams::max = std::numeric_limits<double>::infinity()

If the gradient moves the next iteration above this limit, clip the result.

Definition at line 36 of file SecantMethod.h.

◆ max_iter

std::size_t Euclid::MathUtils::SecantParams::max_iter = 1000

Maximum number of iterations.

Definition at line 31 of file SecantMethod.h.

◆ min

double Euclid::MathUtils::SecantParams::min = -std::numeric_limits<double>::infinity()

If the gradient moves the next iteration below this limit, clip the result.

Definition at line 34 of file SecantMethod.h.


The documentation for this struct was generated from the following file: