gradient_descent::check Interface Reference

Interface for checking the results of the unit tests. More...

Public Member Functions
logical function	check_log (expected, received, testNum, name)
	Check a logical value. More...
logical function	check_real (expected, received, testNum, name)
	Check a real value. More...

Detailed Description

Interface for checking the results of the unit tests.

Member Function/Subroutine Documentation

check_log()

logical function gradient_descent::check::check_log	(	logical, intent(in)	expected,
		logical, intent(in)	received,
		integer, intent(in)	testNum,
		character (len=*), intent(in)	name
	)

Check a logical value.

Checks that the expected value matches the recieved. Otherwise report an error.

Parameters

[in]	expected	The known value.
[in]	received	The known test value.
[in]	testNum	The number of the test.
[in]	name	The name of the test.

Returns

True if the check passes and false otherwise.

check_real()

logical function gradient_descent::check::check_real	(	real(rprec), intent(in)	expected,
		real(rprec), intent(in)	received,
		integer, intent(in)	testNum,
		character (len=*), intent(in)	name
	)

Check a real value.

Checks that the expected value matches the recieved. Otherwise report an error.

Parameters

[in]	expected	The known value.
[in]	received	The known test value.
[in]	testNum	The number of the test.
[in]	name	The name of the test.

Returns

True if the check passes and false otherwise.

---

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

• LIBSTELL/Sources/Modules/gradient_descent.f