pm_mathRootTest::func1_type Type Reference

This is the derived type for generating test function objects of the algebraic form as described below. More...

Inheritance diagram for pm_mathRootTest::func1_type:

Collaboration diagram for pm_mathRootTest::func1_type:

Public Member Functions
procedure	get => getFunc1
Public Member Functions inherited from pm_mathRootTest::func_type
procedure(get_proc), deferred	get

Additional Inherited Members
Public Attributes inherited from pm_mathRootTest::func_type
real(RKH)	lb
	The scalar of type real of the highest kind supported by the processor RKH, containing the lower limit of function. More...
real(RKH)	ub
	The scalar of type real of the highest kind supported by the processor RKH, containing the upper limit of function. More...
real(RKH), dimension(:), allocatable	root
	The scalar of type real of the highest kind supported by the processor RKH, containing the true roots of function. More...
character(:, SK), allocatable	desc
	The scalar allocatable character of default kind SK containing a description of the function and function limits and difficulties. More...

Detailed Description

This is the derived type for generating test function objects of the algebraic form as described below.

The full function is defined as,

\begin{equation} f(x) = x (x^2 - 1)(x^2 - 4) ~,~ x \in (\ms{lb}, \ms{ub}) \end{equation}

where the function bounds could be infinities.
The real roots of the function are -2, -1, 0, 1, 2.

Parameters

[in]	lb	: The input scalar of type real of kind RKH, containing the lower limit of the root search bracket. (optional, default = -3.)
[in]	ub	: The input scalar of the same type and kind as lb, containing the upper limit of the root search bracket. (optional, default = +3.)

Possible calling interfaces ⛓

use pm_mathRootTest, only: func1_type
type(func1_type) :: Func
 
Func = func1_type(lb = lb, ub = ub)
print *, "description: ", Func%desc
print *, "lower search limit: ", Func%lb
print *, "upper search limit: ", Func%ub
print *, "Example function value: ", Func%get(x)

See also

func_type

Test:

test_pm_quadPack

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.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, Oct 16, 2009, 11:14 AM, Michigan

Definition at line 161 of file pm_mathRootTest.F90.

Member Function/Subroutine Documentation

get()

procedure pm_mathRootTest::func1_type::get

Definition at line 163 of file pm_mathRootTest.F90.

References pm_kind::RKH.

---

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

• src/fortran/main/pm_mathRootTest.F90