DistanceNumber
Defined in: lc/distance-number.ts:10
Minimal interface used for equality comparison across calendar components.
Extends
Extended by
Implements
Constructors
Constructor
new DistanceNumber(...
cycles):DistanceNumber
Defined in: lc/distance-number.ts:19
Parameters
cycles
...(number | Wildcard)[]
Components in the long count (eg, K'in, Winal, Bak'tun, etc)
Returns
DistanceNumber
Overrides
CommentWrapper.constructor
Properties
comment
comment:
Comment
Defined in: comment-wrapper.ts:11
Attached comment.
Inherited from
datePattern
datePattern:
RegExp
Defined in: lc/distance-number.ts:12
parts
parts: (
number|Wildcard)[]
Defined in: lc/distance-number.ts:11
sign
sign:
number
Defined in: lc/distance-number.ts:13
Accessors
bakTun
Get Signature
get bakTun():
number|Wildcard
Defined in: lc/distance-number.ts:262
Return the bak'tun component of the fullDate
Returns
number | Wildcard
Set Signature
set bakTun(
newBakTun):void
Defined in: lc/distance-number.ts:254
Set the bak'tun component of the fullDate
Parameters
newBakTun
number | Wildcard
Returns
void
isNegative
Get Signature
get isNegative():
boolean
Defined in: lc/distance-number.ts:60
Return true if the Long Count is operating as a negative Distance Number.
Returns
boolean
Set Signature
set isNegative(
newNegative):void
Defined in: lc/distance-number.ts:76
Set this Long Count as being a negative Distance Number
Parameters
newNegative
boolean
Returns
void
isPositive
Get Signature
get isPositive():
boolean
Defined in: lc/distance-number.ts:52
Return true if the Long Count is positive.
Returns
boolean
Set Signature
set isPositive(
newPositive):void
Defined in: lc/distance-number.ts:68
Set this Long Count as being a Long Count or a positive Distance Number
Parameters
newPositive
boolean
Returns
void
kalabtun
Get Signature
get kalabtun():
number|Wildcard
Defined in: lc/distance-number.ts:292
Return the kalabtun component of the fullDate
Returns
number | Wildcard
Set Signature
set kalabtun(
newBakTun):void
Defined in: lc/distance-number.ts:284
Set the kalabtun component of the fullDate
Parameters
newBakTun
number | Wildcard
Returns
void
kAtun
Get Signature
get kAtun():
number|Wildcard
Defined in: lc/distance-number.ts:247
Return the k'atun component of the fullDate
Returns
number | Wildcard
Set Signature
set kAtun(
newKAtun):void
Defined in: lc/distance-number.ts:239
Set the k'atun component of the fullDate
Parameters
newKAtun
number | Wildcard
Returns
void
kIn
Get Signature
get kIn():
number|Wildcard
Defined in: lc/distance-number.ts:202
Return the k'in component of the fullDate
Returns
number | Wildcard
Set Signature
set kIn(
newKIn):void
Defined in: lc/distance-number.ts:194
Set the k'in component of the fullDate
Parameters
newKIn
number | Wildcard
Returns
void
kinchiltun
Get Signature
get kinchiltun():
number|Wildcard
Defined in: lc/distance-number.ts:307
Return the kinchiltun component of the fullDate
Returns
number | Wildcard
Set Signature
set kinchiltun(
newBakTun):void
Defined in: lc/distance-number.ts:299
Set the kinchiltun component of the fullDate
Parameters
newBakTun
number | Wildcard
Returns
void
piktun
Get Signature
get piktun():
number|Wildcard
Defined in: lc/distance-number.ts:277
Return the piktun component of the fullDate
Returns
number | Wildcard
Set Signature
set piktun(
newBakTun):void
Defined in: lc/distance-number.ts:269
Set the piktun component of the fullDate
Parameters
newBakTun
number | Wildcard
Returns
void
sigParts
Get Signature
get sigParts(): (
number|Wildcard)[]
Defined in: lc/distance-number.ts:120
Only digits in the LC with significant digits
Returns
(number | Wildcard)[]
tun
Get Signature
get tun():
number|Wildcard
Defined in: lc/distance-number.ts:232
Return the tun component of the fullDate
Returns
number | Wildcard
Set Signature
set tun(
newTun):void
Defined in: lc/distance-number.ts:224
Set the tun component of the fullDate
Parameters
newTun
number | Wildcard
Returns
void
winal
Get Signature
get winal():
number|Wildcard
Defined in: lc/distance-number.ts:217
Return the winal component of the fullDate
Returns
number | Wildcard
Set Signature
set winal(
newWinal):void
Defined in: lc/distance-number.ts:209
Set the winal component of the fullDate
Parameters
newWinal
number | Wildcard
Returns
void
Methods
appendComment()
appendComment(
comment):this
Defined in: comment-wrapper.ts:42
Append additional text to the current comment.
Parameters
comment
string | Comment
Returns
this
Inherited from
clone()
clone():
DistanceNumber
Defined in: lc/distance-number.ts:136
Create a copy object of this long count fullDate
Returns
DistanceNumber
commentIsEqual()
commentIsEqual(
otherCommentWrapper):boolean
Defined in: comment-wrapper.ts:60
Compare this wrapper's comment against another wrapper.
Parameters
otherCommentWrapper
Returns
boolean
Inherited from
equal()
equal(
other):boolean
Defined in: lc/distance-number.ts:85
Given two long count dates, check if they are equal
Parameters
other
Returns
boolean
Implementation of
equalWithComment()
equalWithComment(
otherCommentWrapper):boolean
Defined in: comment-wrapper.ts:67
Check equality including the associated comment.
Parameters
otherCommentWrapper
Returns
boolean
Inherited from
CommentWrapper.equalWithComment
exactlyEqual()
exactlyEqual(
other):boolean
Defined in: lc/distance-number.ts:107
Given two long count dates, check if they are exactly equal
Parameters
other
DistanceNumber
Returns
boolean
getDateSections()
getDateSections(
index):number|Wildcard
Defined in: lc/distance-number.ts:145
Get specific column in Long Count fullDate
Parameters
index
number
Returns
number | Wildcard
getPosition()
getPosition():
number
Defined in: lc/distance-number.ts:332
Count the number of days since 0.0.0.0.0 for this LC.
Returns
number
gt()
gt(
newLongCount):boolean
Defined in: lc/distance-number.ts:187
Compare is this LC is less than the supplied LC.
Parameters
newLongCount
DistanceNumber
Returns
boolean
isPartial()
isPartial():
boolean
Defined in: lc/distance-number.ts:324
Returns true if any of the positions in the Long Count have been assigned a Wildcard object.
Returns
boolean
isValid()
isValid():
boolean
Defined in: lc/distance-number.ts:315
Ensure the fullDate has only numbers and wildcards separated by points.
Returns
boolean
lt()
lt(
newLongCount):boolean
Defined in: lc/distance-number.ts:178
Compare if this LC is greater than the supplied LC.
Parameters
newLongCount
DistanceNumber
Returns
boolean
map()
map(
fn):any[]
Defined in: lc/distance-number.ts:169
Pass the map down to the parts
Parameters
fn
(lcPart, lcPartIndex) => any
Returns
any[]
minus()
minus(
newLc):LongcountSubtraction
Defined in: lc/distance-number.ts:381
Return the difference between this Long Count and the supplied
Parameters
newLc
DistanceNumber
Returns
normalise()
normalise():
DistanceNumber
Defined in: lc/distance-number.ts:399
Make sure the elements of the Long Count do not exceed their valid ranges. Converts the Long Count to total days, then decomposes back to normalized form with proper carry/borrow per the mixed-radix system [R1, R2]:
- k'in ∈ [0,19]
- winal ∈ [0,17] (18 winal = 1 tun)
- tun ∈ [0,19]
- k'atun ∈ [0,19]
- bak'tun and higher are unbounded
Returns
DistanceNumber
plus()
plus(
newLc):LongcountAddition
Defined in: lc/distance-number.ts:369
Return the sum of this Long Count and the supplied
Parameters
newLc
DistanceNumber
Returns
resetComment()
resetComment():
this
Defined in: comment-wrapper.ts:20
Reset the current comment back to an empty comment.
Returns
this
Inherited from
setComment()
setComment(
comment):this
Defined in: comment-wrapper.ts:28
Replace the current comment.
Parameters
comment
string | Comment
Returns
this
Inherited from
setDateSections()
setDateSections(
index,newValue):DistanceNumber
Defined in: lc/distance-number.ts:159
Set specific column in Long Count fullDate
Parameters
index
number
newValue
number | Wildcard
Returns
DistanceNumber
toString()
toString():
string
Defined in: lc/distance-number.ts:454
Convert the LongCount to a string and pad the sections of the fullDate
Returns
string