diff options
| author | julie <julielangou@users.noreply.github.com> | 2011-10-06 06:53:11 +0000 |
|---|---|---|
| committer | julie <julielangou@users.noreply.github.com> | 2011-10-06 06:53:11 +0000 |
| commit | e1d39294aee16fa6db9ba079b14442358217db71 (patch) | |
| tree | 30e5aa04c1f6596991fda5334f63dfb9b8027849 /SRC/slaisnan.f | |
| parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/slaisnan.f')
| -rw-r--r-- | SRC/slaisnan.f | 89 |
1 files changed, 65 insertions, 24 deletions
diff --git a/SRC/slaisnan.f b/SRC/slaisnan.f index 49d309fc..1f0c36c8 100644 --- a/SRC/slaisnan.f +++ b/SRC/slaisnan.f @@ -1,38 +1,79 @@ - LOGICAL FUNCTION SLAISNAN( SIN1, SIN2 ) +*> \brief \b SLAISNAN * -* -- LAPACK auxiliary routine (version 3.2.2) -- -* -- LAPACK is a software package provided by Univ. of Tennessee, -- -* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..-- -* June 2010 +* =========== DOCUMENTATION =========== * -* .. Scalar Arguments .. - REAL SIN1, SIN2 -* .. +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ * +* Definition +* ========== +* +* LOGICAL FUNCTION SLAISNAN( SIN1, SIN2 ) +* +* .. Scalar Arguments .. +* REAL SIN1, SIN2 +* .. +* * Purpose * ======= * -* This routine is not for general use. It exists solely to avoid -* over-optimization in SISNAN. -* -* SLAISNAN checks for NaNs by comparing its two arguments for -* inequality. NaN is the only floating-point value where NaN != NaN -* returns .TRUE. To check for NaNs, pass the same variable as both -* arguments. -* -* A compiler must assume that the two arguments are -* not the same variable, and the test will not be optimized away. -* Interprocedural or whole-program optimization may delete this -* test. The ISNAN functions will be replaced by the correct -* Fortran 03 intrinsic once the intrinsic is widely available. +*>\details \b Purpose: +*>\verbatim +*> +*> This routine is not for general use. It exists solely to avoid +*> over-optimization in SISNAN. +*> +*> SLAISNAN checks for NaNs by comparing its two arguments for +*> inequality. NaN is the only floating-point value where NaN != NaN +*> returns .TRUE. To check for NaNs, pass the same variable as both +*> arguments. +*> +*> A compiler must assume that the two arguments are +*> not the same variable, and the test will not be optimized away. +*> Interprocedural or whole-program optimization may delete this +*> test. The ISNAN functions will be replaced by the correct +*> Fortran 03 intrinsic once the intrinsic is widely available. +*> +*>\endverbatim * * Arguments * ========= * -* SIN1 (input) REAL +*> \param[in] SIN1 +*> \verbatim +*> SIN1 is REAL +*> \endverbatim +*> +*> \param[in] SIN2 +*> \verbatim +*> SIN2 is REAL +*> Two numbers to compare for inequality. +*> \endverbatim +*> +* +* Authors +* ======= +* +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. * -* SIN2 (input) REAL -* Two numbers to compare for inequality. +*> \date November 2011 +* +*> \ingroup auxOTHERauxiliary +* +* ===================================================================== + LOGICAL FUNCTION SLAISNAN( SIN1, SIN2 ) +* +* -- LAPACK auxiliary routine (version 3.2.2) -- +* -- LAPACK is a software package provided by Univ. of Tennessee, -- +* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..-- +* November 2011 +* +* .. Scalar Arguments .. + REAL SIN1, SIN2 +* .. * * ===================================================================== * |