Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Num

Hierarchy

  • Value
    • Num

Implements

Index

Accessors

Methods

Accessors

key

  • get key(): Value

length

  • get length(): number

value

  • get value(): number

Methods

abs

alias

  • alias(): void

and

appended

bitwiseAnd

bitwiseNot

  • bitwiseNot(): Value

bitwiseOr

bitwiseXor

body

  • body(): Value

booleanValue

  • booleanValue(): boolean
  • booleanValue<T>(orElse: T): boolean

branch

  • branch(): Value

cast

  • cast<T>(form: Form<T, unknown>): T | undefined
  • cast<T, E>(form: Form<T, unknown>, orElse: E): T | E

ceil

clone

  • clone(): Value

coerce

  • coerce<T>(form: Form<T, unknown>): T
  • coerce<T, E>(form: Form<T, unknown>, orElse: E): T | E

commit

  • commit(): this

compareTo

  • compareTo(that: Item): 0 | 1 | -1

concat

conditional

debug

deleted

display

  • display(output: Output): void

divide

eq

equals

  • equals(that: unknown): boolean

evaluate

filter

flattened

  • flattened(): Value

  • Returns the sole member of this Value, if this Value is a Record with exactly one member, and its member is a Value; returns Extant if this Value is an empty Record; otherwise returns this if this Value is a Record with more than one member, or if this Value is a not a Record.

    Used to convert a unary Record into its member Value. Facilitates writing code that treats a unary Record equivalently to a bare Value.

    Returns Value

floor

forEach

  • forEach<T, S>(callback: function, thisArg?: S): T | undefined

  • Type parameters

    • T

    • S

    Parameters

    • callback: function
        • (this: S, item: Item, index: number): T | void

        • Parameters

          • this: S
          • item: Item
          • index: number

          Returns T | void

    • Optional thisArg: S

    Returns T | undefined

ge

get

getAttr

getField

getItem

  • getItem(index: AnyNum): Item

getSlot

gt

has

hashCode

  • hashCode(): number

head

  • head(): Item

header

  • header(tag: string): Value

  • Returns the value of the first member of this Value, if this Value is a Record, and its first member is an Attr whose key string is equal to tag; otherwise returns Absent if this Value is not a Record, or if this Value is a Record whose first member is not an Attr, or if this Value is a Record whose first member is an Attr whose key does not equal the tag.

    Used to conditionally get the value of the head Attr of a structure, if and only if the key string of the head Attr is equal to the tag. Can be used to check if a structure might conform to a nominal type named tag, while simultaneously getting the value of the tag attribute.

    Parameters

    • tag: string

    Returns Value

headers

  • headers(tag: string): Record | undefined

  • Returns the unflattened header of this Value, if this Value is a Record, and its first member is an Attr whose key string is equal to tag; otherwise returns undefined.

    The headers of the tag attribute of a structure are like the attributes of an XML element tag; through unlike an XML element, tag attribute headers are not limited to string keys and values.

    Parameters

    • tag: string

    Returns Record | undefined

inverse

  • inverse(): Value

invoke

  • invoke(args: Value): Item

isAliased

  • isAliased(): boolean

isConstant

  • isConstant(): boolean

isDefined

  • isDefined(): boolean

isDistinct

  • isDistinct(): boolean

isInfinite

  • isInfinite(): boolean

isMutable

  • isMutable(): boolean

isNaN

  • isNaN(): boolean

isUint32

  • isUint32(): boolean

isUint64

  • isUint64(): boolean

iterator

keyEquals

  • keyEquals(key: unknown): boolean

lambda

  • lambda(template: Value): Value

le

lt

max

  • max(that: Num): Num
  • max(that: Item): Item

min

  • min(that: Num): Num
  • min(that: Item): Item

minus

modulo

ne

negative

  • negative(): Value

not

  • not(): Value

numberValue

  • numberValue(): number
  • numberValue<T>(orElse: T): number

or

plus

positive

  • positive(): Value

pow

prepended

round

sqrt

stringValue

  • stringValue(): string
  • stringValue<T>(orElse: T): string

substitute

tag

  • tag(): string | undefined

  • Returns the key string of the first member of this Value, if this Value is a Record, and its first member is an Attr; otherwise returns undefined if this Value is not a Record, or if this Value is a Record whose first member is not an Attr.

    Used to concisely get the name of the discriminating attribute of a structure. The tag can be used to discern the nominal type of a polymorphic structure, similar to an XML element tag.

    Returns string | undefined

tail

target

  • target(): Value

  • Returns the flattened members of this Value after all attributes have been removed, if this Value is a Record; otherwise returns this if this Value is not a Record.

    Used to concisely get the scalar value of an attributed structure. An attributed structure is a Record with one or more attributes that modify one or more other members.

    Returns Value

times

toAny

toRecon

  • toRecon(): string

toReconBlock

  • toReconBlock(): string

toString

  • toString(): string

toValue

  • toValue(): Value

typeOrder

  • typeOrder(): number

unflattened

updated

updatedAttr

updatedSlot

valueOf

  • valueOf(): number

Static absent

  • absent(): Value

Static builder

Static empty

  • empty(): Value

Static extant

  • extant(): Value

Static from

  • from(value: number | string): Num

Static fromAny

Static globalScope

  • globalScope(): Item

Static nan

Static negativeOne

  • negativeOne(): Num

Static negativeZero

  • negativeZero(): Num

Static parseRecon

  • parseRecon(recon: string): Value

Static positiveOne

  • positiveOne(): Num

Static positiveZero

  • positiveZero(): Num

Static uint32

  • uint32(value: number): Num

Static uint64

  • uint64(value: number): Num