allclose Interface

public interface allclose

Calls

interface~~allclose~~CallsGraph interface~allclose allclose proc~allclose_real32_1d allclose_real32_1d interface~allclose->proc~allclose_real32_1d proc~allclose_real32_2d allclose_real32_2d interface~allclose->proc~allclose_real32_2d proc~allclose_real32_3d allclose_real32_3d interface~allclose->proc~allclose_real32_3d proc~allclose_real64_1d allclose_real64_1d interface~allclose->proc~allclose_real64_1d proc~allclose_real64_2d allclose_real64_2d interface~allclose->proc~allclose_real64_2d proc~allclose_real64_3d allclose_real64_3d interface~allclose->proc~allclose_real64_3d proc~test_print test_print proc~allclose_real32_1d->proc~test_print proc~allclose_real32_2d->proc~test_print proc~allclose_real32_3d->proc~test_print proc~allclose_real64_1d->proc~test_print proc~allclose_real64_2d->proc~test_print proc~allclose_real64_3d->proc~test_print

Module Procedures

public function allclose_real32_1d(got, expect, test_name, rtol, print_result) result(test_pass)

Determines whether two real32-valued 1D arrays coincide to a given relative tolerance

Arguments

Type IntentOptional Attributes Name
real(kind=real32), intent(in), dimension(:) :: got

The array of values to be tested
real(kind=real32), intent(in), dimension(:) :: expect

The array of expected values
character(len=*), intent(in) :: test_name

Name of the test being run
real(kind=real32), intent(in), optional :: rtol

Optional relative tolerance (defaults to 1e-5)
logical, intent(in), optional :: print_result

Optionally print test result to screen (defaults to .true.)

Return Value logical

Did the comparison pass?

public function allclose_real32_2d(got, expect, test_name, rtol, print_result) result(test_pass)

Determines whether two real32-valued 2D arrays coincide to a given relative tolerance

Arguments

Type IntentOptional Attributes Name
real(kind=real32), intent(in), dimension(:,:) :: got

The array of values to be tested
real(kind=real32), intent(in), dimension(:,:) :: expect

The array of expected values
character(len=*), intent(in) :: test_name

Name of the test being run
real(kind=real32), intent(in), optional :: rtol

Optional relative tolerance (defaults to 1e-5)
logical, intent(in), optional :: print_result

Optionally print test result to screen (defaults to .true.)

Return Value logical

Did the comparison pass?

public function allclose_real32_3d(got, expect, test_name, rtol, print_result) result(test_pass)

Determines whether two real32-valued 3D arrays coincide to a given relative tolerance

Arguments

Type IntentOptional Attributes Name
real(kind=real32), intent(in), dimension(:,:,:) :: got

The array of values to be tested
real(kind=real32), intent(in), dimension(:,:,:) :: expect

The array of expected values
character(len=*), intent(in) :: test_name

Name of the test being run
real(kind=real32), intent(in), optional :: rtol

Optional relative tolerance (defaults to 1e-5)
logical, intent(in), optional :: print_result

Optionally print test result to screen (defaults to .true.)

Return Value logical

Did the comparison pass?

public function allclose_real64_1d(got, expect, test_name, rtol, print_result) result(test_pass)

Determines whether two real64-valued 1D arrays coincide to a given relative tolerance

Arguments

Type IntentOptional Attributes Name
real(kind=real64), intent(in), dimension(:) :: got

The array of values to be tested
real(kind=real64), intent(in), dimension(:) :: expect

The array of expected values
character(len=*), intent(in) :: test_name

Name of the test being run
real(kind=real64), intent(in), optional :: rtol

Optional relative tolerance (defaults to 1e-5)
logical, intent(in), optional :: print_result

Optionally print test result to screen (defaults to .true.)

Return Value logical

Did the comparison pass?

public function allclose_real64_2d(got, expect, test_name, rtol, print_result) result(test_pass)

Determines whether two real64-valued 2D arrays coincide to a given relative tolerance

Arguments

Type IntentOptional Attributes Name
real(kind=real64), intent(in), dimension(:,:) :: got

The array of values to be tested
real(kind=real64), intent(in), dimension(:,:) :: expect

The array of expected values
character(len=*), intent(in) :: test_name

Name of the test being run
real(kind=real64), intent(in), optional :: rtol

Optional relative tolerance (defaults to 1e-5)
logical, intent(in), optional :: print_result

Optionally print test result to screen (defaults to .true.)

Return Value logical

Did the comparison pass?

public function allclose_real64_3d(got, expect, test_name, rtol, print_result) result(test_pass)

Determines whether two real64-valued 3D arrays coincide to a given relative tolerance

Arguments

Type IntentOptional Attributes Name
real(kind=real64), intent(in), dimension(:,:,:) :: got

The array of values to be tested
real(kind=real64), intent(in), dimension(:,:,:) :: expect

The array of expected values
character(len=*), intent(in) :: test_name

Name of the test being run
real(kind=real64), intent(in), optional :: rtol

Optional relative tolerance (defaults to 1e-5)
logical, intent(in), optional :: print_result

Optionally print test result to screen (defaults to .true.)

Return Value logical

Did the comparison pass?