commondata::is_within Interface Reference

Logical function to check if a value is within a specific range, lower <= X <= upper. More...

Collaboration diagram for commondata::is_within:

Public Member Functions
elemental logical function	is_within_r (x, lower, upper)
	Logical function to check if a value is within a specific range, lower <= X <= upper. The reverse (upper <= x <= lower) range limits can also be used; a corrective adjustment is automatically made. More...
elemental logical function	is_within_i (x, lower, upper)
	Logical function to check if a value is within a specific range, lower <= X <= upper. The reverse (upper <= x <= lower) range limits can also be used; a corrective adjustment is automatically made. More...

Detailed Description

Logical function to check if a value is within a specific range, lower <= X <= upper.

Note

See commondata::is_within_operator_r() and commondata::is_within_operator_i() for a related user-defined operator .within..

Definition at line 5362 of file m_common.f90.

Member Function/Subroutine Documentation

is_within_r()

elemental logical function commondata::is_within::is_within_r	(	real(srp), intent(in)	x,
		real(srp), intent(in)	lower,
		real(srp), intent(in)	upper
	)

Logical function to check if a value is within a specific range, lower <= X <= upper. The reverse (upper <= x <= lower) range limits can also be used; a corrective adjustment is automatically made.

Note

This is the real type version.

See commondata::is_within_operator_r() and commondata::is_within_operator_i() for a related user-defined operator .within..

Parameters

[in]	x	the value to test
[in]	lower	the lower limit for the range tested.
[in]	upper	the upper limit of the range tested.

Returns

Returns TRUE if x lies within [lower,upper] and FALSE otherwise.

Definition at line 5831 of file m_common.f90.

is_within_i()

elemental logical function commondata::is_within::is_within_i	(	integer, intent(in)	x,
		integer, intent(in)	lower,
		integer, intent(in)	upper
	)

Logical function to check if a value is within a specific range, lower <= X <= upper. The reverse (upper <= x <= lower) range limits can also be used; a corrective adjustment is automatically made.

Note

This is the integer type version.

See commondata::is_within_operator_r() and commondata::is_within_operator_i() for a related user-defined operator .within..

Parameters

[in]	x	the value to test
[in]	lower	the lower limit for the range tested.
[in]	upper	the upper limit of the range tested.

Returns

Returns TRUE if x lies within [lower,upper] and FALSE otherwise.

Definition at line 5868 of file m_common.f90.

---

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

• m_common.f90