Class Decimal

Decimal is used to represent a decimal floating point more precisely than a Float. Decimal is the preferred numeric type for financial applications.

Hierarchy (View Summary)

Num
- Decimal

Constructors

constructor

new Decimal(): Decimal
Returns Decimal
Inherited from Num.constructor

Properties

`Static`type$

type$: Type

Methods

compare

compare(that: JsObj): number
Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:
```
this < that   =>  <0
this == that  =>  0
this > that   =>  >0
```
This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

Examples:
```
3.compare(8)  =>  -1
8.compare(3)  =>  1
8.compare(8)  =>  0
3 <=> 8       =>  -1  // shortcut for 3.compare(8)
```
Parameters
- that: JsObj
Returns number
Inherited from Num.compare
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9196

equals

equals(that: JsObj): boolean
Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.
Parameters
- that: JsObj
Returns boolean
Inherited from Num.equals
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9217

hash

hash(): number
Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

Returns number
Inherited from Num.hash
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9263

isImmutable

isImmutable(): boolean
Return if this Obj is immutable and safe to share between threads:
- an instance of a const class
- the result of toImmutable on List, Map, or Buf
- a Func object may or may not be immutable - see sys::Func.
- other instances are assumed mutable and return false
Returns boolean
Inherited from Num.isImmutable
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9206

toImmutable

toImmutable(): Readonly<this>
Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:
- if type is const, return this
- if already an immutable List, Map, Buf, or Func return this
- if a List, then attempt to perform a deep clone by calling toImmutable on all items
- if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
- some Funcs can be made immutable - see sys::Func
- if a Buf create immutable copy, see sys::Buf
- any other object throws NotImmutableErr
Returns Readonly<this>
Inherited from Num.toImmutable
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9257

toStr

toStr(): string
Return a string representation of this object.

Returns string
Inherited from Num.toStr
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9166

trap

trap(name: string, args?: List<JsObj>): JsObj
Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:
```
a->x        a.trap("x", null)
a->x()      a.trap("x", null)
a->x = b    a.trap("x", [b])
a->x(b)     a.trap("x", [b])
a->x(b, c)  a.trap("x", [b, c])
```
The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.
Parameters
- name: string
- Optionalargs: List<JsObj>
Returns JsObj
Inherited from Num.trap
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9242

typeof

typeof(): Type
Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

Returns Type
Inherited from Num.typeof
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9268

with

with(f: (arg0: this) => void): this
This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.
Parameters
- f: (arg0: this) => void
Returns this
Inherited from Num.with
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9172

`Static`abs

abs(self: number): number
Return the absolute value of this decimal. If this value is positive then return this, otherwise return the negation.
Parameters
- self: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1556

`Static`compare

compare(self: number, obj: JsObj): number
Compare based on decimal value, scale is not considered for equality (unlike equals).
Parameters
- self: number
- obj: JsObj
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1476

`Static`decrement

decrement(self: number): number
Decrement by one. Shortcut is --a or a--.
Parameters
- self: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1569

`Static`defVal

defVal(): number
Default value is 0.

Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1467

`Static`div

div(self: number, b: number): number
Divide this by b. Shortcut is a/b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1504

`Static`divFloat

divFloat(self: number, b: number): number
Divide this by b. Shortcut is a/b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1492

`Static`divInt

divInt(self: number, b: number): number
Divide this by b. Shortcut is a/b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1581

`Static`echo

echo(x?: JsObj): void
Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.
Parameters
- Optionalx: JsObj
Returns void
Inherited from Num.echo
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:9223

`Static`equals

equals(self: number, obj: JsObj): boolean
Return true if same decimal with same scale.
Parameters
- self: number
- obj: JsObj
Returns boolean
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1577

`Static`fromStr

fromStr(s: string, checked?: boolean, ...args: unknown[]): Decimal
Parse a Str into a Decimal. If invalid format and checked is false return null, otherwise throw ParseErr.
Parameters
- s: string
- Optionalchecked: boolean
- ...args: unknown[]
Returns Decimal
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1561

`Static`hash

hash(self: number): number
Return platform specific hashcode.
Parameters
- self: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1585

`Static`increment

increment(self: number): number
Increment by one. Shortcut is ++a or a++.
Parameters
- self: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1496

`Static`localeDecimal

localeDecimal(): string
Get the current locale's decimal separator. For example in the the US this is a dot.

Returns string
Inherited from Num.localeDecimal
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:4724

`Static`localeGrouping

localeGrouping(): string
Get the current locale's separator for grouping thousands together. For example in the US this is a comma.

Returns string
Inherited from Num.localeGrouping
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:4733

`Static`localeMinus

localeMinus(): string
Get the current locale's minus sign used to represent a negative number.

Returns string
Inherited from Num.localeMinus
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:4714

`Static`localeNaN

localeNaN(): string
Get the current locale's string representation for not-a-number.

Returns string
Inherited from Num.localeNaN
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:4709

`Static`localeNegInf

localeNegInf(): string
Get the current locale's string representation for negative infinity.

Returns string
Inherited from Num.localeNegInf
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:4719

`Static`localePercent

localePercent(): string
Get the current locale's symbol for the percent sign.

Returns string
Inherited from Num.localePercent
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:4700

`Static`localePosInf

localePosInf(): string
Get the current locale's string representation for positive infinity.

Returns string
Inherited from Num.localePosInf
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:4738

`Static`max

max(self: number, that: number): number
Return the larger of this and the specified Decimal values.
Parameters
- self: number
- that: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1543

`Static`min

min(self: number, that: number): number
Return the smaller of this and the specified Decimal values.
Parameters
- self: number
- that: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1512

`Static`minus

minus(self: number, b: number): number
Subtract b from this. Shortcut is a-b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1471

`Static`minusFloat

minusFloat(self: number, b: number): number
Subtract b from this. Shortcut is a-b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1516

`Static`minusInt

minusInt(self: number, b: number): number
Subtract b from this. Shortcut is a-b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1573

`Static`mod

mod(self: number, b: number): number
Return remainder of this divided by b. Shortcut is a%b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1484

`Static`modFloat

modFloat(self: number, b: number): number
Return remainder of this divided by b. Shortcut is a%b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1524

`Static`modInt

modInt(self: number, b: number): number
Return remainder of this divided by b. Shortcut is a%b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1488

`Static`mult

mult(self: number, b: number): number
Multiply this with b. Shortcut is a*b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1480

`Static`multFloat

multFloat(self: number, b: number): number
Multiply this with b. Shortcut is a*b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1532

`Static`multInt

multInt(self: number, b: number): number
Multiply this with b. Shortcut is a*b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1500

`Static`negate

negate(self: number): number
Negative of this. Shortcut is -a.
Parameters
- self: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1565

`Static`plus

plus(self: number, b: number): number
Add this with b. Shortcut is a+b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1551

`Static`plusFloat

plusFloat(self: number, b: number): number
Add this with b. Shortcut is a+b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1508

`Static`plusInt

plusInt(self: number, b: number): number
Add this with b. Shortcut is a+b.
Parameters
- self: number
- b: number
Returns number
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1520

`Static`toCode

toCode(self: number): string
Get this Decimal as a Fantom code literal.
Parameters
- self: number
Returns string
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1547

`Static`toDecimal

toDecimal(self: number): number
Convert this number to a Decimal.
Parameters
- self: number
Returns number
Inherited from Num.toDecimal
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:4728

`Static`toFloat

toFloat(self: number): number
Convert this number to a Float.
Parameters
- self: number
Returns number
Inherited from Num.toFloat
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:4704

`Static`toInt

toInt(self: number): number
Convert this number to an Int.
Parameters
- self: number
Returns number
Inherited from Num.toInt
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:4696

`Static`toLocale

toLocale(self: number, pattern?: string, locale?: Locale): string
Format this decimal number for the current locale. If pattern is null, then the locale's default pattern is used. See Float.toLocale for pattern language and examples.
Parameters
- self: number
- Optionalpattern: string
- Optionallocale: Locale
Returns string
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1539

`Static`toStr

toStr(self: number): string
Get string representation.
Parameters
- self: number
Returns string
- Defined in AppData/Roaming/npm/node_modules/@haxall/haxall/esm/sys.d.ts:1528

Class Decimal

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Decimal

Properties

Statictype$

Methods

compare

Parameters

Returns number

equals

Parameters

Returns boolean

hash

Returns number

isImmutable

Returns boolean

toImmutable

Returns Readonly<this>

toStr

Returns string

trap

Parameters

Returns JsObj

typeof

Returns Type

with

Parameters

Returns this

Staticabs

Parameters

Returns number

Staticcompare

Parameters

Returns number

Staticdecrement

Parameters

Returns number

StaticdefVal

Returns number

Staticdiv

Parameters

Returns number

StaticdivFloat

Parameters

Returns number

StaticdivInt

Parameters

Returns number

Staticecho

Parameters

Returns void

Staticequals

Parameters

Returns boolean

StaticfromStr

Parameters

Returns Decimal

Statichash

Parameters

Returns number

Staticincrement

Parameters

Returns number

StaticlocaleDecimal

Returns string

StaticlocaleGrouping

Returns string

StaticlocaleMinus

Returns string

StaticlocaleNaN

Returns string

StaticlocaleNegInf

Returns string

StaticlocalePercent

`Static`type$

`Static`abs

`Static`compare

`Static`decrement

`Static`defVal

`Static`div

`Static`divFloat

`Static`divInt

`Static`echo

`Static`equals

`Static`fromStr

`Static`hash

`Static`increment

`Static`localeDecimal

`Static`localeGrouping

`Static`localeMinus

`Static`localeNaN

`Static`localeNegInf

`Static`localePercent

`Static`localePosInf

`Static`max

`Static`min

`Static`minus

`Static`minusFloat

`Static`minusInt

`Static`mod

`Static`modFloat

`Static`modInt

`Static`mult

`Static`multFloat

`Static`multInt

`Static`negate

`Static`plus

`Static`plusFloat

`Static`plusInt

`Static`toCode

`Static`toDecimal

`Static`toFloat

`Static`toInt

`Static`toLocale

`Static`toStr