→ index of namespace default
 
→ index of project core
 
→ index of module core

Class core.Double


Synopsis: A number object that wraps a 64bit IEEE floating point value.

  Base classes:
  Methods:
See also:  



Method decZ
Decrement by 'dec' if value is > 0. Return true if value is <= 0.0.
Signature
decZ(floatdec)
 :boolean
Arguments
floatdec–Decrement
Returns
boolean–True if value crossed zero threshold

 
→ top of page
Method decZR1
Decrement by 'dec' if value is > 0. Return true and wrap back to 1 if value is <= 0.0.
Signature
decZR1(floatdec)
 :boolean
Arguments
floatdec–Decrement
Returns
boolean–True if value wrapped around

 
→ top of page
Method getString
Return a string representation of this number object.
Signature
getString():String
Returns
String–a new String instance holding a string representation of this number object

 
→ top of page
Method getValue
Return the current value.
Signature
getValue():double
Returns
double–Current value
Description

The value will silently be converted to a single precision float value.

See also:  


 
→ top of page
Method incZ1
Increment by 'inc' if value is < 1. Return true if value is >= 1.
Signature
incZ1(floatdec)
 :boolean
Arguments
floatdec–
Returns
boolean–True if value crossed (1) threshold

 
→ top of page
Method incZR1
Increment by 'inc' if value is < 1. Return true and wrap back to 0 if value is >= 1.
Signature
incZR1(floatdec)
 :boolean
Arguments
floatdec–
Returns
boolean–True if value wrapped back to 0

 
→ top of page
Method Newf
Create a new Double object and initialize it with the given value.
Signature
Newf(floatv)
 :Double
Arguments
floatv–The value to assign the new object
Returns
Double–new Double object

 
→ top of page
Method Newi
Create a new Double object and initialize it with the given value.
Signature
Newi(intv)
 :Double
Arguments
intv–The value to assign the new object
Returns
Double–new Double object

 
→ top of page
Method News
Create a new Double object and initialize it with the given String.
Signature
News(Strings)
 :Double
Arguments
Strings–
Returns
Double–new Double object
Description

The String will be converted to a 64bit double precision floating point value before assignment.

 
→ top of page
Method operator !=
Check whether the given value does not equal this value
Signature
operator !=(Doublev)
 :boolean
Arguments
Doublev–Value to compare to
Returns
boolean–Comparison result

 
→ top of page
Method operator &
Calculate reminder of this divided by the given value.
Signature
operator &(intv)
 :Double
Arguments
intv–Dividend
Returns
Double–new Double object holding the result
Description

This value is temporarily converted to an integer before the operation is performed.

 
→ top of page
Method operator &
Bitwise AND
Signature
operator &(intv)
 :Double
Arguments
intv–Right-hand side operand
Returns
Double–new Double object holding the result
Description

This value is temporarily converted to an integer before the operation is performed.

 
→ top of page
Method operator &&
Logical AND
Signature
operator &&(intv)
 :boolean
Arguments
intv–Right-hand side operand
Returns
boolean–Result value

 
→ top of page
Method operator >
Check whether this value is greater than the given value
Signature
operator >(Doublev)
 :boolean
Arguments
Doublev–Value to compare to
Returns
boolean–Comparison result

 
→ top of page
Method operator >>
Logical shift right
Signature
operator >>(intv)
 :Double
Arguments
intv–How many bits to shift right
Returns
Double–new Double object holding the result
Description

This value is temporarily converted to an integer before the operation is performed.

 
→ top of page
Method operator >=
Check whether this value is equal to or greater than the given value
Signature
operator >=(Doublev)
 :boolean
Arguments
Doublev–Value to compare to
Returns
boolean–Comparison result

 
→ top of page
Method operator <
Check whether this value is less than the given value
Signature
operator <(Doublev)
 :boolean
Arguments
Doublev–Value to compare to
Returns
boolean–Comparison result

 
→ top of page
Method operator <<
Logical shift left
Signature
operator <<(intv)
 :Double
Arguments
intv–How many bits to shift left
Returns
Double–new Double object holding the result
Description

This value is temporarily converted to an integer before the operation is performed.

 
→ top of page
Method operator <=
Check whether this value is less than the given value
Signature
operator <=(Doublev)
 :boolean
Arguments
Doublev–Value to compare to
Returns
boolean–Comparison result

 
→ top of page
Method operator *
Multiply by the given value
Signature
operator *(Doublev)
 :Double
Arguments
Doublev–Factor
Returns
Double–new Double object holding the result

 
→ top of page
Method operator +
Add the given value
Signature
operator +(Doublev)
 :Double
Arguments
Doublev–Addend
Returns
Double–new Double object holding the result

 
→ top of page
Method operator -
Subtract the given value
Signature
operator -(Doublev)
 :Double
Arguments
Doublev–Minuend
Returns
Double–new Double object holding the result

 
→ top of page
Method operator /
Divide by the given value
Signature
operator /(Doublev)
 :Double
Arguments
Doublev–Dividend
Returns
Double–new Double object holding the result

 
→ top of page
Method operator ==
Compare to the given value
Signature
operator ==(Doublev)
 :boolean
Arguments
Doublev–Value to compare to
Returns
boolean–Comparison result

 
→ top of page
Method operator unary!
Logical not
Signature
operator unary!():Double
Returns
Double–new Double object holding the result
Description

This value is temporarily converted to an integer before the operation is performed.

 
→ top of page
Method operator unary-
Negate value
Signature
operator unary-():Double
Returns
Double–new Double object holding the result

 
→ top of page
Method operator unary~
Bitwise not
Signature
operator unary~():Double
Returns
Double–new Double object holding the result
Description

This value is temporarily converted to an integer before the operation is performed.

 
→ top of page
Method operator ^
Bitwise EOR/XOR (exclusive or)
Signature
operator ^(intv)
 :Double
Arguments
intv–Right-hand side operand
Returns
Double–new Double object holding the result
Description

This value is temporarily converted to an integer before the operation is performed.

 
→ top of page
Method operator ^^
Logical EOR/XOR (exclusive OR)
Signature
operator ^^(intv)
 :boolean
Arguments
intv–Right-hand side operand
Returns
boolean–Result value

 
→ top of page
Method operator |
Bitwise OR
Signature
operator |(intv)
 :Double
Arguments
intv–Right-hand side operand
Returns
Double–new Double object holding the result
Description

This value is temporarily converted to an integer before the operation is performed.

 
→ top of page
Method operator ||
Logical OR
Signature
operator ||(intv)
 :boolean
Arguments
intv–Right-hand side operand
Returns
boolean–Result value

 
→ top of page
Method printf
Return a string representation of this number object that is formatted using the given ANSI-C format string.
Signature
printf(Stringfmt)
 :String
Arguments
Stringfmt–ANSI-C style format string.
Returns
String–new String instance holding a formatted string representation of this number object.

 
→ top of page
Method setValue
Set a new value.
Signature
setValue(floatv)
Arguments
floatv–The new value

See also:  


 
→ top of page
 

Project Modules:core 
Project Classes:Boolean , Buffer , Byte , Class , ClassArray , Condition , Configuration , Double , DummyStream , Envelope , Event , Exception , File , Float , FloatArray , FloatArray128 , FloatArray16 , FloatArray32 , FloatArray64 , FloatArray8 , Function , HashTable , IntArray , IntArray128 , IntArray16 , IntArray32 , IntArray64 , IntArray8 , Integer , LFSR , LFSR_NR , List , ListNode , Long , Mailbox , Mutex , Object , ObjectArray , PakFile , PointerArray , Pool , Process , Script , SharedBuffer , Short , Stack , StdErrStream , StdInStream , StdOutStream , Stream , Stream , String , String128 , String16 , String32 , String64 , String8 , StringArray , StringIterator , Thread , Time , TKS , TreeNode , UnsignedByte , UnsignedInteger , UnsignedLong , UnsignedShort , Value , ValueArray , Variable 
Project Functions:ceil , exit , floor , GetCurrentThread , getenv , lcchar , mathAbsMaxf , mathAbsMinf , mathAbsMini , mathAbsMini , mathCerpf , mathClampf , mathClampi , mathDistancePointPlane2d , mathFoldf , mathFoldi , mathGCD , mathLerpCyclicf , mathLerpf , mathMaxf , mathMaxi , mathMinf , mathMini , mathNextCyclicf , mathPowerf , mathPowerfC , mathPoweri , mathSerpf , mathSigmoidf , mathSmoothStepf , mathSmoothStepNf , mathWrapf , mathWrapi , milliSeconds , milliSecondsDouble , psystem , putenv , srand , system , ucchar 
All Namespaces:default , graph , ui 
All Projects:core , eqxmms , ShaderVG , ShaderVG_Text , tkanalogrytm , tkchipmunk , tkclap , tkfileutils , tkfreeglut , tkfreetype2 , tkfreeverb , tkmath , tkmidi , tkmidipipe , tkminnie , tkoldmath , tkopengl , tkportaudio , tkradiastools , tksamplechain , tksampleedit , tksampler , tksdl , tksdl_net , tksidplay2 , tkspeexdsp , tksqlite , tktriangulate , tkui , tkvst2 , tkzip , ui , yingtest 


auto-generated by "DOG", the TkScript document generator. Sun, 4/Oct/2026 11:15:07