Monkeybread Xojo plugin - BigNumberMBS methods

BigNumberMBS.Abs as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Queries absolute value.

Example

Var o as BigNumberMBS = new BigNumberMBS(-123)
Var z as BigNumberMBS = o.Abs

MsgBox z.StringValue

Removes sign.

See also:

Abs(value as BigNumberMBS) as BigNumberMBS

BigNumberMBS.Add(other as BigNumberMBS, round as boolean = true) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Adds a number.

Example

Var x as new BigNumberMBS(2)
Var d as new BigNumberMBS(3)
Var p as BigNumberMBS = x.Add(d)

MsgBox p.StringValue // shows 5

BigNumberMBS.BitAnd(other as BigNumberMBS) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Calculates bitwise AND operation.

Example

Var x as new BigNumberMBS(17)
Var y as new BigNumberMBS(16)
Var r as BigNumberMBS = x.BitAnd(y)

MsgBox r.StringValue

BigNumberMBS.BitOr(other as BigNumberMBS) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Calculates bitwise or operation.

Example

Var x as new BigNumberMBS(17)
Var y as new BigNumberMBS(16)
Var r as BigNumberMBS = x.BitOr(y)

MsgBox r.StringValue

BigNumberMBS.BitXOr(other as BigNumberMBS) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Calculates bitwise xor operation.

Example

Var x as new BigNumberMBS(17)
Var y as new BigNumberMBS(16)
Var r as BigNumberMBS = x.BitXOr(y)

MsgBox r.StringValue

BigNumberMBS.Ceil as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	21.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

This function returns a value representing the smallest integer that is greater than or equal to x.

Example

Var c As New BigNumberMBS(-3.7)
Var d As BigNumberMBS = c.Ceil

MsgBox d // shows -3

e.g.
Ceil(-3.7) = -3
Ceil(-3.1) = -3
Ceil(-3.0) = -3
Ceil(4.0) = 4
Ceil(4.2) = 5
Ceil(4.8) = 5

BigNumberMBS.Constructor

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Initialize the number with zero value.

Example

Var o as BigNumberMBS = new BigNumberMBS
MsgBox o.StringValue

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Initialize the number with other value.

Example

Var o as BigNumberMBS = new BigNumberMBS(2.5)
Var c as BigNumberMBS = new BigNumberMBS(o)

MsgBox c.StringValue

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Creates a new number object with a currency object.

Example

Var v as Currency = 123.456
Var b as new BigNumberMBS(v)
MsgBox b.StringValue

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Initialize the number with double value.

Example

Var o as BigNumberMBS = new BigNumberMBS(2.5)
MsgBox str(o.DoubleValue)+" = "+str(o.StringValue)#

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Creates a new number with a 32-bit integer.

Example

Var v as Int32 = 123
Var b as new BigNumberMBS(v)
MsgBox b.StringValue

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Creates a new number with a 64-bit integer.

Example

Var v as Int64 = 123
Var b as new BigNumberMBS(v)
MsgBox b.StringValue

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Creates a new number with a 32-bit floating point number.

Example

Var v as Single = 123
Var b as new BigNumberMBS(v)
MsgBox b.StringValue

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Initialize the number with string value.

Example

Var o as BigNumberMBS = new BigNumberMBS("123.456")
MsgBox o.StringValue

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Creates a new number with an unsigned 32-bit integer.

Example

Var v as UInt32 = 123
Var b as new BigNumberMBS(v)
MsgBox b.StringValue

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Creates a new number with an unsigned 32-bit integer.

Example

Var v as UInt64 = 123
Var b as new BigNumberMBS(v)
MsgBox b.StringValue

See also:

BigNumberMBS.Divide(other as BigNumberMBS, round as boolean = true) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Divides the number.

Example

Var x as new BigNumberMBS(8)
Var d as new BigNumberMBS(2)
Var p as BigNumberMBS = x.Divide(d)

MsgBox p.StringValue // shows 4

BigNumberMBS.Equals(other as BigNumberMBS) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Checks if two numbers are the same.

Example

Var o as BigNumberMBS = new BigNumberMBS(123)
Var z as BigNumberMBS = new BigNumberMBS(123)

if o.Equals(z) then
  MsgBox "equal"
else
  Break // error
end if

Returns true if equal.

BigNumberMBS.Floor as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Removes any fraction part.

Example

Var o as BigNumberMBS = new BigNumberMBS(2.3)
Var s as BigNumberMBS = o.Floor

MsgBox s.StringValue

Var a as BigNumberMBS = new BigNumberMBS(-2.3)
Var b as BigNumberMBS = a.Floor

MsgBox b.StringValue

BigNumberMBS.Frac as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Extracts the fraction part.

Example

Var o as BigNumberMBS = new BigNumberMBS(2.5)
Var s as BigNumberMBS = o.Frac

MsgBox s.StringValue

Var a as BigNumberMBS = new BigNumberMBS(-2.5)
Var b as BigNumberMBS = a.Frac

MsgBox b.StringValue

BigNumberMBS.GetStringValue(Base as Integer = 10, scientific as boolean = false, scientificFrom as Integer = 15, round as Integer = -1, TrimZeros as Boolean = true, comma as String = ".") as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Queries string value.

Example

Var o as new BigNumberMBS(1234)

// show as hex
MsgBox o.GetStringValue(16)

// show as number with comma and 3 digits
Var z as new BigNumberMBS(12.345)
MsgBox z.GetStringValue(10, false, 15, 3, true, ",")

Base: The base of the number system. Normally 10, but also 16 for hex is common.
scientific: Whether to use scientific notation.
scientificFrom: How many digits we show.
Round: Whether to round to n digits.
TrimZeros: Whether to trim unneeded zeros.
comma: The character to use as decimal dot.

See also:

GetStringValue(Conversion as BigNumberConversionMBS) as String

BigNumberMBS.GetStringValue(Conversion as BigNumberConversionMBS) as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	24.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Queries string value.

Example

Var o As New BigNumberMBS(1234567.890)

Var conv As New BigNumberConversionMBS
conv.Comma = ","
conv.Group = "'"
conv.Scientific = False
conv.Round = 3

Var s1 As String = o.GetStringValue(conv)
// 1'234'567,89

conv.Comma = "."
conv.Group = ","

Var s2 As String = o.GetStringValue(conv)
// 1,234,567,89

conv.Comma = ","
conv.Group = "'"
conv.Scientific = True

Var s3 As String = o.GetStringValue(conv)
// 1,235e+6

Break

See also:

GetStringValue(Base as Integer = 10, scientific as boolean = false, scientificFrom as Integer = 15, round as Integer = -1, TrimZeros as Boolean = true, comma as String = ".") as String

BigNumberMBS.Modulate(other as BigNumberMBS) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Modulates a number.

Example

Var x as new BigNumberMBS(17)
Var y as new BigNumberMBS(3)
Var r as BigNumberMBS = x.Modulate(y)

MsgBox r.StringValue

Similar to mod keyword in Xojo.

BigNumberMBS.Modulate2 as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Modulates by 2.

Example

Var x as new BigNumberMBS(8)
Var y as new BigNumberMBS(9)

MsgBox str(x.Modulate2)+" "+str(y.Modulate2)

Returns 0 or 1.

BigNumberMBS.Multiply(other as BigNumberMBS, round as boolean = true) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Multiplies two numbers.

Example

Var x as new BigNumberMBS(8)
Var d as new BigNumberMBS(2)
Var p as BigNumberMBS = x.Multiply(d)

MsgBox p.StringValue // shows 16

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Multiply by an integer.

Example

Var x as new BigNumberMBS(2)
Var p as BigNumberMBS = x.Multiply(3)

MsgBox p.StringValue // shows 6

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Multiply by an unsigned integer.

Example

Var x as new BigNumberMBS(17)
Var r as BigNumberMBS = x.Multiply(3)

MsgBox r.StringValue

See also:

BigNumberMBS.Negate as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Negates the number.

Example

Var o as BigNumberMBS = new BigNumberMBS(123)
Var z as BigNumberMBS = o.Negate

MsgBox z.StringValue

BigNumberMBS.Operator_Add(other as BigNumberMBS) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Adds a number.

Example

Var a as new BigNumberMBS(3)
Var b as new BigNumberMBS(4)

// add
Var c as BigNumberMBS = a + b

MsgBox c.StringValue

BigNumberMBS.Operator_AddRight(other as BigNumberMBS) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Adds a number.

Example

Var a as new BigNumberMBS(3)
Var b as new BigNumberMBS(4)

// add
Var c as BigNumberMBS = a + b

MsgBox c.StringValue

BigNumberMBS.Operator_Compare(other as BigNumberMBS) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Compares two numbers.

Example

Var a as new BigNumberMBS(1.2)
Var b as new BigNumberMBS(1.2)
Var c as new BigNumberMBS(1.3)

if a = b then
  // ok
else
  break
end if

if a < c then
  // ok
else
  Break
end if

if c > b then
  // ok
else
  break
end if

BigNumberMBS.Operator_Convert as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Converts big number to string automatically.

Example

Var b as new BigNumberMBS
Var n as Double = 5

// convert from double to big number automatically
b = n

// convert to string automatically
MsgBox b

See also:

Operator_Convert(value as String)

BigNumberMBS.Operator_Convert(value as String)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Converts a string to a big number.

Example

Var b as new BigNumberMBS
Var n as string = "5"

// convert from string to big number automatically
b = n

// convert to double automatically
Var d as Double = b
MsgBox str(d)

See also:

Operator_Convert as String

BigNumberMBS.Operator_Divide(other as BigNumberMBS) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Divides two numbers.

Example

Var a as new BigNumberMBS(9.3)
Var b as new BigNumberMBS(3.0)

Var r as BigNumberMBS = a / b

MsgBox r.StringValue

BigNumberMBS.Operator_DivideRight(other as BigNumberMBS) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Divides two numbers.

BigNumberMBS.Operator_IntegerDivide(other as BigNumberMBS) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Calculates an integer divide.

Example

Var a as new BigNumberMBS(9.3)
Var b as new BigNumberMBS(3.0)

Var r as BigNumberMBS = a \ b

MsgBox r.StringValue

Same as normal divide, but removes fraction part.

BigNumberMBS.Operator_IntegerDivideRight(other as BigNumberMBS) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Calculates an integer divide.

Same as normal divide, but removes fraction part.

BigNumberMBS.Operator_Modulo(other as BigNumberMBS) as BigNumberMBS

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Math	MBS DataTypes Plugin	16.5	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Calculates the modulo of two numbers.

Example

Var a as new BigNumberMBS(9.3)
Var b as new BigNumberMBS(3.0)

Var r as BigNumberMBS = a mod b

MsgBox r.StringValue