allclose Interface

  1. utils_math_m.f90
  2. utils_math_m
  3. allclose

public interface allclose

Checks if two arrays are elementwise close within tolerance

Calls

interface~~allclose~~CallsGraph interface~allclose allclose proc~allclose_rank1 allclose_rank1 interface~allclose->proc~allclose_rank1 proc~allclose_rank3 allclose_rank3 interface~allclose->proc~allclose_rank3 proc~allclose_rank2 allclose_rank2 interface~allclose->proc~allclose_rank2 proc~isclose isclose proc~allclose_rank1->proc~isclose proc~allclose_rank3->proc~isclose proc~allclose_rank2->proc~isclose

Contents

Module Procedures


Module Procedures

public function allclose_rank1(a, b, rel_tol, abs_tol)

Checks if two rank-1 floating point arrays of type double are close within tolerance.

Arguments

Type IntentOptional AttributesName
real(kind=rp), intent(in), dimension(:):: a

(m,) array
real(kind=rp), intent(in), dimension(:):: b

(m,) array
real(kind=rp), intent(in), optional :: rel_tol

Relative tolerance; default 1e-10
real(kind=rp), intent(in), optional :: abs_tol

Absolute tolerance; default 0.0

Return Value logical

public function allclose_rank2(a, b, rel_tol, abs_tol)

Checks if two rank-2 floating point arrays of type double are close within tolerance.

Arguments

Type IntentOptional AttributesName
real(kind=rp), intent(in), dimension(:,:):: a

(m,n) array
real(kind=rp), intent(in), dimension(:,:):: b

(m,n) array
real(kind=rp), intent(in), optional :: rel_tol

Relative tolerance; default 1e-10
real(kind=rp), intent(in), optional :: abs_tol

Absolute tolerance; default 0.0

Return Value logical

public function allclose_rank3(a, b, rel_tol, abs_tol)

Checks if two rank-3 floating point arrays of type double are close within tolerance.

Arguments

Type IntentOptional AttributesName
real(kind=rp), intent(in), dimension(:,:,:):: a

(m,n,p) array
real(kind=rp), intent(in), dimension(:,:,:):: b

(m,n,p) array
real(kind=rp), intent(in), optional :: rel_tol

Relative tolerance; default 1e-10
real(kind=rp), intent(in), optional :: abs_tol

Absolute tolerance; default 0.0

Return Value logical