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

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]	value	The value to check
[in]	array	The array to check within.
[in]	tolerance	Optional tolerance threshold.

Definition at line 7459 of file m_common.f90.

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]	value	The value to check
[in]	array	The array to check within.

Definition at line 7497 of file m_common.f90.

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