ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_polynomial::sgl_type Type Reference

This is a concrete derived type whose instances are exclusively used to signify the use of Skowron-Gould method of root-finding.
More...

Inheritance diagram for pm_polynomial::sgl_type:
Collaboration diagram for pm_polynomial::sgl_type:

Public Attributes

logical(LK) polished = .true._LK
 The scalar logical of default kind LK. If .true., the roots identified will be polished. More...
 
logical(LK) reckoned = .false._LK
 The scalar logical of default kind LK. If .true., the search will start from the user-specified values, otherwise, from zero for all roots. More...
 

Detailed Description

This is a concrete derived type whose instances are exclusively used to signify the use of Skowron-Gould method of root-finding.

See the root-finding section in the documentation of pm_polynomial for more details about this root-finding method.
Objects instantiated from this derived type are exclusively used to differentiate the procedures within the various generic interfaces of the ParaMonte library.
As such, this concrete derived type does not contain any attributes.

The approach of Skowron and Gould is outlined in their 2012 paper: General Complex Polynomial Root Solver and Its Further Optimization for Binary Microlenses.


Possible calling interfaces

type(sgl_type), allocatable :: method
method = sgl_type(polished = polished, informed = informed)
This module contains procedures and generic interfaces for performing various mathematical operations...
This is a concrete derived type whose instances are exclusively used to signify the use of Skowron-Go...
Note
This concrete derived type is not meant to be directly accessed by the end users.
Instead, the end users should use the specific object parameter instance of this derived type (e.g., sgl as directed by the documentation of the specific procedure they intend to use.
See also
sgl
eigen
jenkins
laguerre
sgl_type
eigen_type
jenkins_type
laguerre_type
method_type


Final Remarks


If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

  1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
  2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Author:
Fatemeh Bagheri, August 28, 2024, 6:12 PM, NASA Goddard Space Flight Center, Washington, D.C.

Definition at line 3247 of file pm_polynomial.F90.

Member Data Documentation

◆ polished

logical(LK) pm_polynomial::sgl_type::polished = .true._LK

The scalar logical of default kind LK. If .true., the roots identified will be polished.

Definition at line 3248 of file pm_polynomial.F90.

◆ reckoned

logical(LK) pm_polynomial::sgl_type::reckoned = .false._LK

The scalar logical of default kind LK. If .true., the search will start from the user-specified values, otherwise, from zero for all roots.

Definition at line 3249 of file pm_polynomial.F90.


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