For the complete documentation index, see llms.txt. This page is also available as Markdown.

numeric

In BoxLang, the numeric type is represented by the native Java class java.lang.Number. The member functions below are provided by the BoxLang runtime and can be called directly on the value, in addition to the methods of the underlying Java class.

The abstract class Number is the superclass of platform classes representing numeric values that are convertible to the primitive types byte, double, float, int, long, and short.

Numeric Methods

abs()

Returns the absolute value of a number

Method Signature

abs()

Arguments

This function does not accept any arguments

acos()

Returns the arccosine (inverse cosine) of a number

Method Signature

acos()

Arguments

This function does not accept any arguments

asin()

Returns the arcsine (inverse sine) of a number

Method Signature

asin()

Arguments

This function does not accept any arguments

atn()

Returns the arc tangent (inverse tangent) of a number

Method Signature

atn()

Arguments

This function does not accept any arguments

booleanFormat()

Returns the value formatted as a boolean string

Method Signature

Arguments

This function does not accept any arguments

bxDump(label=[string], depth=[numeric], maxRows=[numeric], top=[numeric], expand=[boolean], abort=[boolean], output=[string], format=[string], showUDFs=[boolean])

Outputs the contents of a variable (simple or complex) of any type for debugging purposes to a specific output location.

The available output locations are: - buffer: The output is written to the buffer, which is the default location. If running on a web server, the output is written to the browser. - console: The output is printed to the System console. - Absolute File Path The output is written to a file with the specified absolute file path.

The output format can be either HTML or plain text.

The default format is HTML if the output location is the buffer or a web server or a file, otherwise it is plain text for the console.

Method Signature

Arguments

Argument
Type
Required
Description
Default

label

string

false

A custom label to display above the dump (Only in HTML output)

depth

numeric

false

The recursion depth to display when dumping nested collections. 1-based: -1 (default) is unlimited, 0 shows nothing, 1 shows the top level with no recursion, 2 recurses once, etc. (Only in HTML output)

maxRows

numeric

false

The maximum number of keys/rows/items to display per level of a collection, array, or query. 1-based: -1 (default) is unlimited, 0 shows nothing, 1 shows a single row, etc. (Only in HTML output)

top

numeric

false

Deprecated: use maxRows instead. When maxRows is not also passed, top's value is used as maxRows. Kept for backwards compatibility with existing BoxLang code. (Only in HTML output)

expand

boolean

false

Whether to expand the dump. Be default, we try to expand as much as possible. (Only in HTML output)

true

abort

boolean

false

Whether to do a hard abort the request after dumping. Default is false

false

output

string

false

The output format which can be "buffer", "console", or "{absolute file path}". The default is "buffer".

format

string

false

The format of the output to a filename. Can be "html" or "text". The default is according to the output location.

showUDFs

boolean

false

Show UDFs or not. Default is true. (Only in HTML output)

true

ceiling()

Determines the closest integer that is greater than a specified floating point number.

Method Signature

Arguments

This function does not accept any arguments

cos()

Returns the cosine of an angle entered in radians

Method Signature

Arguments

This function does not accept any arguments

currencyFormat(type=[string], locale=[string])

No description available

Method Signature

Arguments

Argument
Type
Required
Description
Default

type

string

false

local

locale

string

false

decimalFormat(length=[integer])

Converts a number to a decimal-formatted string.

Method Signature

Arguments

Argument
Type
Required
Description
Default

length

integer

false

The number of decimal places to include in the formatted string.

2

decrementValue()

Decrement the integer part of a number

Method Signature

Arguments

This function does not accept any arguments

exp()

Calculates the exponent whose base is e that represents a number.

Method Signature

Arguments

This function does not accept any arguments

fix()

Converts a real number to an integer

Method Signature

Arguments

This function does not accept any arguments

floor()

Round a number down to the nearest integer

Method Signature

Arguments

This function does not accept any arguments

formatBaseN(radix=[integerTruncate])

Converts a number to a string representation in the specified base.

Method Signature

Arguments

Argument
Type
Required
Description
Default

radix

integerTruncate

true

The base to convert the number to, in the range 2-36.

incrementValue()

Increment the integer part of a number

Method Signature

Arguments

This function does not accept any arguments

int()

Returns the closest integer that is smaller than the number

Method Signature

Arguments

This function does not accept any arguments

log()

Returns the natural logarithm of a number.

Method Signature

Arguments

This function does not accept any arguments

log10()

No description available

Method Signature

Arguments

This function does not accept any arguments

max(number2=[numeric])

Return larger of two numbers

Method Signature

Arguments

Argument
Type
Required
Description
Default

number2

numeric

true

The second number

min(number2=[numeric])

Return larger of two numbers

Method Signature

Arguments

Argument
Type
Required
Description
Default

number2

numeric

true

The second number

numberFormat(mask=[string], locale=[string])

Formats a number with an optional format mask

Method Signature

Arguments

Argument
Type
Required
Description
Default

mask

string

false

The formatting mask to apply using the java.text.DecimalFormat patterns.

locale

string

false

An optional locale string to apply to the format

round(precision=[integer])

Rounds a number to the closest integer.

Method Signature

Arguments

Argument
Type
Required
Description
Default

precision

integer

false

The number of decimal places to round to (default is 0).

0

sgn()

Determine the sign of a number

Method Signature

Arguments

This function does not accept any arguments

sin()

Returns the sine of a number

Method Signature

Arguments

This function does not accept any arguments

sqr()

Returns the square root of a number

Method Signature

Arguments

This function does not accept any arguments

tan()

Returns the tangent of an angle that is entered in radians.

Method Signature

Arguments

This function does not accept any arguments

Java Methods

Use at your own risk: These are the public methods of the native Java class java.lang.Number, documented from the JDK 21 javadocs. They are not part of the BoxLang API, are not tested or supported by BoxLang, and may change between Java versions.

byte byteValue()

Returns the value of the specified number as a byte.

Returns: the numeric value represented by this object after conversion to type byte.

double doubleValue()

Returns the value of the specified number as a double.

Returns: the numeric value represented by this object after conversion to type double.

float floatValue()

Returns the value of the specified number as a float.

Returns: the numeric value represented by this object after conversion to type float.

int intValue()

Returns the value of the specified number as an int.

Returns: the numeric value represented by this object after conversion to type int.

long longValue()

Returns the value of the specified number as a long.

Returns: the numeric value represented by this object after conversion to type long.

short shortValue()

Returns the value of the specified number as a short.

Returns: the numeric value represented by this object after conversion to type short.

Last updated

Was this helpful?