Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
AccessLevel Class
AccessType Enum
Address Class
Answers Class
ApexPages Class
Approval Class
Assert Class
AsyncInfo Class
AsyncOptions Class
Blob Class
Boolean Class
BusinessHours Class
CallbackStatus Enum
Callable Interface
Cases Class
Collator Class
Comparable Interface
Comparator Interface
Continuation Class
Cookie Class
Crypto Class
Custom Metadata Type Methods
Custom Settings Methods
Database Class
Date Class
Datetime Class
Decimal Class
Domain Class
DomainCreator Class
DomainParser Class
DomainType Enum
Double Class
EmailMessages Class
EncodingUtil Class
Enum Methods
EventBus Class
Exception Class and Built-In Exceptions
ExternalServiceTest Class
FlexQueue Class
FeatureManagement Class
Formula Class
FormulaRecalcFieldError Class
FormulaRecalcResult Class
Http Class
HttpCalloutMock Interface
HttpRequest Class
HttpResponse Class
Id Class
Ideas Class
InstallHandler Interface
Integer Class
JSON Class
JSONGenerator Class
JSONParser Class
JSONToken Enum
Label Class
Limits Class
List Class
Location Class
LoggingLevel Enum
Long Class
Map Class
Matcher Class
Math Class
Math Fields
Math Methods
Messaging Class
MultiStaticResourceCalloutMock Class
Network Class
Object Class
OrgLimit Class
OrgLimits Class
PageReference Class
Packaging Class
Pattern Class
Queueable Interface
QueueableContext Interface
QueueableDuplicateSignature Class
QueueableDuplicateSignature.Builder Class
QuickAction Class
Quiddity Enum
RemoteObjectController
Request Class
ResetPasswordResult Class
RestContext Class
RestRequest Class
RestResponse Class
SandboxPostCopy Interface
Schedulable Interface
SchedulableContext Interface
Schema Class
Search Class
Security Class
SelectOption Class
Set Class
Site Class
SObject Class
SObjectAccessDecision Class
SoqlStubProvider Class
StaticResourceCalloutMock Class
String Class
StubProvider Interface
System Class
Test Class
Time Class
TimeZone Class
Trigger Class
TriggerOperation Enum
Type Class
UninstallHandler Interface
URL Class
UserInfo Class
UserManagement Class
UUID Class
Version Class
WebServiceCallout Class
WebServiceMock Interface
XmlStreamReader Class
XmlStreamWriter Class
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Math Class

Contains methods for mathematical operations.

Namespace

System

Math Fields

The following are fields for Math.

E

Returns the mathematical constant e, which is the base of natural logarithms.

Signature

public static final Double E

Property Value

Type: Double

PI

Returns the mathematical constant pi, which is the ratio of the circumference of a circle to its diameter.

Signature

public static final Double PI

Property Value

Type: Double

Math Methods

The following are methods for Math. All methods are static.

abs(decimalValue)

Returns the absolute value of the specified Decimal.

Signature

public static Decimal abs(Decimal decimalValue)

Parameters

decimalValue
Type: Decimal

Return Value

Type: Decimal

abs(doubleValue)

Returns the absolute value of the specified Double.

Signature

public static Double abs(Double doubleValue)

Parameters

doubleValue
Type: Double

Return Value

Type: Double

abs(integerValue)

Returns the absolute value of the specified Integer.

Signature

public static Integer abs(Integer integerValue)

Parameters

integerValue
Type: Integer

Return Value

Type: Integer

Example

abs(longValue)

Returns the absolute value of the specified Long.

Signature

public static Long abs(Long longValue)

Parameters

longValue
Type: Long

Return Value

Type: Long

acos(decimalAngle)

Returns the arc cosine of an angle, in the range of 0.0 through pi.

Signature

public static Decimal acos(Decimal decimalAngle)

Parameters

decimalAngle
Type: Decimal

Return Value

Type: Decimal

acos(doubleAngle)

Returns the arc cosine of an angle, in the range of 0.0 through pi.

Signature

public static Double acos(Double doubleAngle)

Parameters

doubleAngle
Type: Double

Return Value

Type: Double

asin(decimalAngle)

Returns the arc sine of an angle, in the range of -pi/2 through pi/2.

Signature

public static Decimal asin(Decimal decimalAngle)

Parameters

decimalAngle
Type: Decimal

Return Value

Type: Decimal

asin(doubleAngle)

Returns the arc sine of an angle, in the range of -pi/2 through pi/2.

Signature

public static Double asin(Double doubleAngle)

Parameters

doubleAngle
Type: Double

Return Value

Type: Double

atan(decimalAngle)

Returns the arc tangent of an angle, in the range of -pi/2 through pi/2.

Signature

public static Decimal atan(Decimal decimalAngle)

Parameters

decimalAngle
Type: Decimal

Return Value

Type: Decimal

atan(doubleAngle)

Returns the arc tangent of an angle, in the range of -pi/2 through pi/2.

Signature

public static Double atan(Double doubleAngle)

Parameters

doubleAngle
Type: Double

Return Value

Type: Double

atan2(xCoordinate, yCoordinate)

Converts rectangular coordinates (xCoordinate and yCoordinate) to polar (r and theta). This method computes the phase theta by computing an arc tangent of xCoordinate/yCoordinate in the range of -pi to pi.

Signature

public static Decimal atan2(Decimal xCoordinate, Decimal yCoordinate)

Parameters

xCoordinate
Type: Decimal
yCoordinate
Type: Decimal

Return Value

Type: Decimal

atan2(xCoordinate, yCoordinate)

Converts rectangular coordinates (xCoordinate and yCoordinate) to polar (r and theta). This method computes the phase theta by computing an arc tangent of xCoordinate/yCoordinate in the range of -pi to pi.

Signature

public static Double atan2(Double xCoordinate, Double yCoordinate)

Parameters

xCoordinate
Type: Double
yCoordinate
Type: Double

Return Value

Type: Double

cbrt(decimalValue)

Returns the cube root of the specified Decimal. The cube root of a negative value is the negative of the cube root of that value's magnitude.

Signature

public static Decimal cbrt(Decimal decimalValue)

Parameters

decimalValue
Type: Decimal

Return Value

Type: Decimal

cbrt(doubleValue)

Returns the cube root of the specified Double. The cube root of a negative value is the negative of the cube root of that value's magnitude.

Signature

public static Double cbrt(Double doubleValue)

Parameters

doubleValue
Type: Double

Return Value

Type: Double

ceil(decimalValue)

Returns the smallest (closest to negative infinity) Decimal that is not less than the argument and is equal to a mathematical integer.

Signature

public static Decimal ceil(Decimal decimalValue)

Parameters

decimalValue
Type: Decimal

Return Value

Type: Decimal

ceil(doubleValue)

Returns the smallest (closest to negative infinity) Double that is not less than the argument and is equal to a mathematical integer.

Signature

public static Double ceil(Double doubleValue)

Parameters

doubleValue
Type: Double

Return Value

Type: Double

cos(decimalAngle)

Returns the trigonometric cosine of the angle specified by decimalAngle.

Signature

public static Decimal cos(Decimal decimalAngle)

Parameters

decimalAngle
Type: Decimal

Return Value

Type: Decimal

cos(doubleAngle)

Returns the trigonometric cosine of the angle specified by doubleAngle.

Signature

public static Double cos(Double doubleAngle)

Parameters

doubleAngle
Type: Double

Return Value

Type: Double

cosh(decimalAngle)

Returns the hyperbolic cosine of decimalAngle. The hyperbolic cosine of d is defined to be (ex + e-x)/2 where e is Euler's number.

Signature

public static Decimal cosh(Decimal decimalAngle)

Parameters

decimalAngle
Type: Decimal

Return Value

Type: Decimal

cosh(doubleAngle)

Returns the hyperbolic cosine of doubleAngle. The hyperbolic cosine of d is defined to be (ex + e-x)/2 where e is Euler's number.

Signature

public static Double cosh(Double doubleAngle)

Parameters

doubleAngle
Type: Double

Return Value

Type: Double

exp(exponentDecimal)

Returns Euler's number e raised to the power of the specified Decimal.

Signature

public static Decimal exp(Decimal exponentDecimal)

Parameters

exponentDecimal
Type: Decimal

Return Value

Type: Decimal

exp(exponentDouble)

Returns Euler's number e raised to the power of the specified Double.

Signature

public static Double exp(Double exponentDouble)

Parameters

exponentDouble
Type: Double

Return Value

Type: Double

floor(decimalValue)

Returns the largest (closest to positive infinity) Decimal that is not greater than the argument and is equal to a mathematical integer.

Signature

public static Decimal floor(Decimal decimalValue)

Parameters

decimalValue
Type: Decimal

Return Value

Type: Decimal

floor(doubleValue)

Returns the largest (closest to positive infinity) Double that is not greater than the argument and is equal to a mathematical integer.

Signature

public static Double floor(Double doubleValue)

Parameters

doubleValue
Type: Double

Return Value

Type: Double

log(decimalValue)

Returns the natural logarithm (base e) of the specified Decimal.

Signature

public static Decimal log(Decimal decimalValue)

Parameters

decimalValue
Type: Decimal

Return Value

Type: Decimal

log(doubleValue)

Returns the natural logarithm (base e) of the specified Double.

Signature

public static Double log(Double doubleValue)

Parameters

doubleValue
Type: Double

Return Value

Type: Double

log10(decimalValue)

Returns the logarithm (base 10) of the specified Decimal.

Signature

public static Decimal log10(Decimal decimalValue)

Parameters

decimalValue
Type: Decimal

Return Value

Type: Decimal

log10(doubleValue)

Returns the logarithm (base 10) of the specified Double.

Signature

public static Double log10(Double doubleValue)

Parameters

doubleValue
Type: Double

Return Value

Type: Double

max(decimalValue1, decimalValue2)

Returns the larger of the two specified Decimals.

Signature

public static Decimal max(Decimal decimalValue1, Decimal decimalValue2)

Parameters

decimalValue1
Type: Decimal
decimalValue2
Type: Decimal

Return Value

Type: Decimal

Example

max(doubleValue1, doubleValue2)

Returns the larger of the two specified Doubles.

Signature

public static Double max(Double doubleValue1, Double doubleValue2)

Parameters

doubleValue1
Type: Double
doubleValue2
Type: Double

Return Value

Type: Double

max(integerValue1, integerValue2)

Returns the larger of the two specified Integers.

Signature

public static Integer max(Integer integerValue1, Integer integerValue2)

Parameters

integerValue1
Type: Integer
integerValue2
Type: Integer

Return Value

Type: Integer

max(longValue1, longValue2)

Returns the larger of the two specified Longs.

Signature

public static Long max(Long longValue1, Long longValue2)

Parameters

longValue1
Type: Long
longValue2
Type: Long

Return Value

Type: Long

min(decimalValue1, decimalValue2)

Returns the smaller of the two specified Decimals.

Signature

public static Decimal min(Decimal decimalValue1, Decimal decimalValue2)

Parameters

decimalValue1
Type: Decimal
decimalValue2
Type: Decimal

Return Value

Type: Decimal

Example

min(doubleValue1, doubleValue2)

Returns the smaller of the two specified Doubles.

Signature

public static Double min(Double doubleValue1, Double doubleValue2)

Parameters

doubleValue1
Type: Double
doubleValue2
Type: Double

Return Value

Type: Double

min(integerValue1, integerValue2)

Returns the smaller of the two specified Integers.

Signature

public static Integer min(Integer integerValue1, Integer integerValue2)

Parameters

integerValue1
Type: Integer
integerValue2
Type: Integer

Return Value

Type: Integer

min(longValue1, longValue2)

Returns the smaller of the two specified Longs.

Signature

public static Long min(Long longValue1, Long longValue2)

Parameters

longValue1
Type: Long
longValue2
Type: Long

Return Value

Type: Long

mod(integerValue1, integerValue2)

Returns the remainder of integerValue1 divided by integerValue2.

Signature

public static Integer mod(Integer integerValue1, Integer integerValue2)

Parameters

integerValue1
Type: Integer
integerValue2
Type: Integer

Return Value

Type: Integer

Example

mod(longValue1, longValue2)

Returns the remainder of longValue1 divided by longValue2.

Signature

public static Long mod(Long longValue1, Long longValue2)

Parameters

longValue1
Type: Long
longValue2
Type: Long

Return Value

Type: Long

pow(doubleValue, exponent)

Returns the value of the first Double raised to the power of exponent.

Signature

public static Double pow(Double doubleValue, Double exponent)

Parameters

doubleValue
Type: Double
exponent
Type: Double

Return Value

Type: Double

random()

Returns a positive Double that is greater than or equal to 0.0 and less than 1.0.

Signature

public static Double random()

Return Value

Type: Double

rint(decimalValue)

Returns the value that is closest in value to decimalValue and is equal to a mathematical integer.

Signature

public static Decimal rint(Decimal decimalValue)

Parameters

decimalValue
Type: Decimal

Return Value

Type: Decimal

rint(doubleValue)

Returns the value that is closest in value to doubleValue and is equal to a mathematical integer.

Signature

public static Double rint(Double doubleValue)

Parameters

doubleValue
Type: Double

Return Value

Type: Double

round(doubleValue)

Do not use. This method is deprecated as of the Winter '08 release. Instead, use Math.roundToLong. Returns the closest Integer to the specified Double. If the result is less than -2,147,483,648 or greater than 2,147,483,647, Apex generates an error.

Signature

public static Integer round(Double doubleValue)

Parameters

doubleValue
Type: Double

Return Value

Type: Integer

round(decimalValue)

Returns the rounded approximation of this Decimal. The number is rounded to zero decimal places using half-even rounding mode, that is, it rounds towards the “nearest neighbor” unless both neighbors are equidistant, in which case, this mode rounds towards the even neighbor. If the result is less than -2,147,483,648 or greater than 2,147,483,647, Apex generates an error.

Signature

public static Integer round(Decimal decimalValue)

Parameters

decimalValue
Type: Decimal

Return Value

Type: Integer

Usage

Note that this rounding mode statistically minimizes cumulative error when applied repeatedly over a sequence of calculations.

Example

roundToLong(decimalValue)

Returns the rounded approximation of this Decimal. The number is rounded to zero decimal places using half-even rounding mode, that is, it rounds towards the “nearest neighbor” unless both neighbors are equidistant, in which case, this mode rounds towards the even neighbor.

Signature

public static Long roundToLong(Decimal decimalValue)

Parameters

decimalValue
Type: Decimal

Return Value

Type: Long

Usage

Note that this rounding mode statistically minimizes cumulative error when applied repeatedly over a sequence of calculations.

Example

roundToLong(doubleValue)

Returns the closest Long to the specified Double.

Signature

public static Long roundToLong(Double doubleValue)

Parameters

doubleValue
Type: Double

Return Value

Type: Long

signum(decimalValue)

Returns the signum function of the specified Decimal, which is 0 if decimalValue is 0, 1.0 if decimalValue is greater than 0, -1.0 if decimalValue is less than 0.

Signature

public static Decimal signum(Decimal decimalValue)

Parameters

decimalValue
Type: Decimal

Return Value

Type: Decimal

signum(doubleValue)

Returns the signum function of the specified Double, which is 0 if doubleValue is 0, 1.0 if doubleValue is greater than 0, -1.0 if doubleValue is less than 0.

Signature

public static Double signum(Double doubleValue)

Parameters

doubleValue
Type: Double

Return Value

Type: Double

sin(decimalAngle)

Returns the trigonometric sine of the angle specified by decimalAngle.

Signature

public static Decimal sin(Decimal decimalAngle)

Parameters

decimalAngle
Type: Decimal

Return Value

Type: Decimal

sin(doubleAngle)

Returns the trigonometric sine of the angle specified by doubleAngle.

Signature

public static Double sin(Double doubleAngle)

Parameters

doubleAngle
Type: Double

Return Value

Type: Double

sinh(decimalAngle)

Returns the hyperbolic sine of decimalAngle. The hyperbolic sine of decimalAngle is defined to be (ex - e-x)/2 where e is Euler's number.

Signature

public static Decimal sinh(Decimal decimalAngle)

Parameters

decimalAngle
Type: Decimal

Return Value

Type: Decimal

sinh(doubleAngle)

Returns the hyperbolic sine of doubleAngle. The hyperbolic sine of doubleAngle is defined to be (ex - e-x)/2 where e is Euler's number.

Signature

public static Double sinh(Double doubleAngle)

Parameters

doubleAngle
Type: Double

Return Value

Type: Double

sqrt(decimalValue)

Returns the correctly rounded positive square root of decimalValue.

Signature

public static Decimal sqrt(Decimal decimalValue)

Parameters

decimalValue
Type: Decimal

Return Value

Type: Decimal

sqrt(doubleValue)

Returns the correctly rounded positive square root of doubleValue.

Signature

public static Double sqrt(Double doubleValue)

Parameters

doubleValue
Type: Double

Return Value

Type: Double

tan(decimalAngle)

Returns the trigonometric tangent of the angle specified by decimalAngle.

Signature

public static Decimal tan(Decimal decimalAngle)

Parameters

decimalAngle
Type: Decimal

Return Value

Type: Decimal

tan(doubleAngle)

Returns the trigonometric tangent of the angle specified by doubleAngle.

Signature

public static Double tan(Double doubleAngle)

Parameters

doubleAngle
Type: Double

Return Value

Type: Double

tanh(decimalAngle)

Returns the hyperbolic tangent of decimalAngle. The hyperbolic tangent of decimalAngle is defined to be (ex - e-x)/(ex + e-x) where e is Euler's number. In other words, it is equivalent to sinh(x)/cosinh(x). The absolute value of the exact tanh is always less than 1.

Signature

public static Decimal tanh(Decimal decimalAngle)

Parameters

decimalAngle
Type: Decimal

Return Value

Type: Decimal

tanh(doubleAngle)

Returns the hyperbolic tangent of doubleAngle. The hyperbolic tangent of doubleAngle is defined to be (ex - e-x)/(ex + e-x) where e is Euler's number. In other words, it is equivalent to sinh(x)/cosinh(x). The absolute value of the exact tanh is always less than 1.

Signature

public static Double tanh(Double doubleAngle)

Parameters

doubleAngle
Type: Double

Return Value

Type: Double