The AHA Model  Revision: 12809
Reference implementation 04 (HEDG02_04)
commondata::is_maxval Interface Reference

Check if a value is the maximum value of an array. More...

Collaboration diagram for commondata::is_maxval:

Public Member Functions

pure logical function is_maxval_r (value, array, tolerance)
 Function to check if the value is the maximum value of an array (returns TRUE), or not (return FALSE). More...
 
pure logical function is_maxval_i (value, array)
 Function to check if the value is the maximum value of an array (returns TRUE), or not (return FALSE). Integer version. More...
 

Detailed Description

Check if a value is the maximum value of an array.

Definition at line 5499 of file m_common.f90.

Member Function/Subroutine Documentation

◆ is_maxval_r()

pure logical function commondata::is_maxval::is_maxval_r ( real(srp), intent(in)  value,
real(srp), dimension(:), intent(in)  array,
real(srp), intent(in), optional  tolerance 
)

Function to check if the value is the maximum value of an array (returns TRUE), or not (return FALSE).

Returns
TRUE if value is indeed the maximum value of the array and FALSE otherwise.
Parameters
[in]valueThe value to check
[in]arrayThe array to check within.
[in]toleranceOptional tolerance threshold.

Definition at line 7459 of file m_common.f90.

◆ is_maxval_i()

pure logical function commondata::is_maxval::is_maxval_i ( integer, intent(in)  value,
integer, dimension(:), intent(in)  array 
)

Function to check if the value is the maximum value of an array (returns TRUE), or not (return FALSE). Integer version.

Returns
TRUE if value is indeed the maximum value of the array and FALSE otherwise.
Parameters
[in]valueThe value to check
[in]arrayThe array to check within.

Definition at line 7497 of file m_common.f90.


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