ftorch_test_utils Module

Utils module for FTorch containing value comparisons for testing

  • License FTorch is released under an MIT license. See the LICENSE file for details.

Uses

  • module~~ftorch_test_utils~~UsesGraph module~ftorch_test_utils ftorch_test_utils iso_fortran_env iso_fortran_env module~ftorch_test_utils->iso_fortran_env

Interfaces

public interface allclose

  • 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?

public interface assert_allclose

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

    Alias for allclose_real32_1d

    This version is deprecated and is only included for backwards compatibility. It will be removed in FTorch version 2.0.

    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 assertion pass?

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

    Alias for allclose_real32_2d

    This version is deprecated and is only included for backwards compatibility. It will be removed in FTorch version 2.0.

    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 assertion pass?

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

    Alias for allclose_real32_3d

    This version is deprecated and is only included for backwards compatibility. It will be removed in FTorch version 2.0.

    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 assertion pass?

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

    Alias for allclose_real64_1d

    This version is deprecated and is only included for backwards compatibility. It will be removed in FTorch version 2.0.

    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 assertion pass?

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

    Alias for allclose_real64_2d

    This version is deprecated and is only included for backwards compatibility. It will be removed in FTorch version 2.0.

    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 assertion pass?

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

    Alias for allclose_real64_3d

    This version is deprecated and is only included for backwards compatibility. It will be removed in FTorch version 2.0.

    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 assertion pass?

public interface assert_isclose

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

    Alias for isclose_real32

    This version is deprecated and is only included for backwards compatibility. It will be removed in FTorch version 2.0.

    Arguments

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

    The value to be tested
    real(kind=real32), intent(in) :: expect

    The expected value
    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 assertion pass?

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

    Alias for isclose_real64

    This version is deprecated and is only included for backwards compatibility. It will be removed in FTorch version 2.0.

    Arguments

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

    The value to be tested
    real(kind=real64), intent(in) :: expect

    The expected value
    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 assertion pass?

public interface isclose

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

    Determines whether two real32 values coincide to a given relative tolerance

    Arguments

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

    The value to be tested
    real(kind=real32), intent(in) :: expect

    The expected value
    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 isclose_real64(got, expect, test_name, rtol, print_result) result(test_pass)

    Determines whether two real64 values coincide to a given relative tolerance

    Arguments

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

    The value to be tested
    real(kind=real64), intent(in) :: expect

    The expected value
    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?


Functions

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?

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

Alias for allclose_real32_1d

Read more…

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 assertion pass?

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

Alias for allclose_real32_2d

Read more…

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 assertion pass?

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

Alias for allclose_real32_3d

Read more…

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 assertion pass?

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

Alias for allclose_real64_1d

Read more…

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 assertion pass?

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

Alias for allclose_real64_2d

Read more…

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 assertion pass?

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

Alias for allclose_real64_3d

Read more…

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 assertion pass?

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

Alias for isclose_real32

Read more…

Arguments

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

The value to be tested
real(kind=real32), intent(in) :: expect

The expected value
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 assertion pass?

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

Alias for isclose_real64

Read more…

Arguments

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

The value to be tested
real(kind=real64), intent(in) :: expect

The expected value
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 assertion pass?

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

Determines whether two real32 values coincide to a given relative tolerance

Arguments

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

The value to be tested
real(kind=real32), intent(in) :: expect

The expected value
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 isclose_real64(got, expect, test_name, rtol, print_result) result(test_pass)

Determines whether two real64 values coincide to a given relative tolerance

Arguments

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

The value to be tested
real(kind=real64), intent(in) :: expect

The expected value
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?


Subroutines

public subroutine test_print(test_name, message, test_pass)

Print the result of a test to the terminal

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: test_name

Name of the test being run
character(len=*), intent(in) :: message

Message to print
logical, intent(in) :: test_pass

Result of the value comparison