pm_mathRootTest::func_type Type Reference

This is the base type func_type standing abstract function type to generate a variety of function test functions.
More...

Inheritance diagram for pm_mathRootTest::func_type:

Public Member Functions
procedure(get_proc), deferred	get

Public Attributes
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 base type func_type standing abstract function type to generate a variety of function test functions.

The abstract type minimally contains the function limits and deferred type-bound procedure get().
It is primarily meant to be used internally within the ParaMonte library for testing and illustration purposes.
In particular, the implementations may not be ideal for benchmarks and performance tests of the library integrators.
Nevertheless, all relevant types and function test objects are public in this repository and available to the end user.

Possible calling interfaces ⛓

use pm_mathRootTest, only: func_type
 
type, extends(func_type) :: Func_type
    ...
end type

See also

getQuadErr

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, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin

Definition at line 85 of file pm_mathRootTest.F90.

Member Function/Subroutine Documentation

get()

procedure(get_proc), deferred pm_mathRootTest::func_type::get

Definition at line 91 of file pm_mathRootTest.F90.

Member Data Documentation

desc

character(:, SK), allocatable pm_mathRootTest::func_type::desc

The scalar allocatable character of default kind SK containing a description of the function and function limits and difficulties.

Definition at line 89 of file pm_mathRootTest.F90.

lb

real(RKH) pm_mathRootTest::func_type::lb

The scalar of type real of the highest kind supported by the processor RKH, containing the lower limit of function.

Definition at line 86 of file pm_mathRootTest.F90.

root

real(RKH), dimension(:), allocatable pm_mathRootTest::func_type::root

The scalar of type real of the highest kind supported by the processor RKH, containing the true roots of function.

Definition at line 88 of file pm_mathRootTest.F90.

ub

real(RKH) pm_mathRootTest::func_type::ub

The scalar of type real of the highest kind supported by the processor RKH, containing the upper limit of function.

Definition at line 87 of file pm_mathRootTest.F90.

---

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

• src/fortran/main/pm_mathRootTest.F90