Math.Abs Method (Single) (System)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
Math.Abs Method (Single)

Updated: July 2010

Returns the absolute value of a single-precision floating-point number.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
Syntax
Visual Basic
Public Shared Function Abs ( _
	value As Single _
) As Single
C#
public static float Abs(
	float value
)
Visual C++
public:
static float Abs(
	float value
)
F#
static member Abs : 
        value:float32 -> float32

Parameters

value
Type: System.Single
A number that is greater than or equal to Single.MinValue, but less than or equal to Single.MaxValue.

Return Value

Type: System.Single
A single-precision floating-point number, x, such that 0 ≤ x ≤ Single.MaxValue.
Remarks

The absolute value of a Single is its numeric value without its sign. For example, the absolute value of both 1.2e-03 and -1.2e03 is 1.2e03.

If value is equal to NegativeInfinity or PositiveInfinity, the return value is PositiveInfinity. If value is equal to NaN, the return value is NaN.

Examples

The following example uses the Abs(Single) method to get the absolute value of a number of Single values.

Visual Basic

Dim values() As Single = { Single.MaxValue, 16.354e-12, 15.098123, 0, _
                            -19.069713, -15.058e17, Single.MinValue }
For Each value As Single In values
   Console.WriteLine("Abs({0}) = {1}", value, Math.Abs(value))
Next
' The example displays the following output:
'       Abs(3.402823E+38) = 3.402823E+38
'       Abs(1.6354E-11) = 1.6354E-11
'       Abs(15.09812) = 15.09812
'       Abs(0) = 0
'       Abs(-19.06971) = 19.06971
'       Abs(-1.5058E+18) = 1.5058E+18
'       Abs(-3.402823E+38) = 3.402823E+38
C#

float[] values= { Single.MaxValue, 16.354e-12F, 15.098123F, 0F, 
                  -19.069713F, -15.058e17F, Single.MinValue };
foreach (float value in values)
   Console.WriteLine("Abs({0}) = {1}", value, Math.Abs(value));

// The example displays the following output:
//       Abs(3.402823E+38) = 3.402823E+38
//       Abs(1.6354E-11) = 1.6354E-11
//       Abs(15.09812) = 15.09812
//       Abs(0) = 0
//       Abs(-19.06971) = 19.06971
//       Abs(-1.5058E+18) = 1.5058E+18
//       Abs(-3.402823E+38) = 3.402823E+38
Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also

Reference

Math Class
Abs Overload
System Namespace
Change History

Date

History

Reason

July 2010

Added a definition of absolute value.

Customer feedback.