home
 
 index of namespace default
 
 index of project core
 
 index of module core

Class core.Float


SynopsisA number object that wraps a 32bit IEEE floating point value.

  Base classes:
  Methods: See also:  


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

 
 top of page
Method getValue
Return the current value.
Signature
getValue():float
Returns
floatCurrent value
See also:  


 
 top of page
Method New
Create a new Float object and initialize it with the given value.
Signature
New(floatv)
 :Float
Arguments
floatvThe value to assign the new object
Returns
Floatnew Float object

 
 top of page
Method operator !=
Check whether the given value does not equal this value
Signature
operator !=(floatv)
 :boolean
Arguments
floatvValue to compare to
Returns
booleanComparison result

 
 top of page
Method operator &
Calculate reminder of this divided by the given value.
Signature
operator &(intv)
 :Float
Arguments
intvDividend
Returns
Floatnew Float 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)
 :Float
Arguments
intvRight-hand side operand
Returns
Floatnew Float 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
intvRight-hand side operand
Returns
booleanResult value

 
 top of page
Method operator >
Check whether this value is greater than the given value
Signature
operator >(floatv)
 :boolean
Arguments
floatvValue to compare to
Returns
booleanComparison result

 
 top of page
Method operator >>
Logical shift right
Signature
operator >>(intv)
 :Float
Arguments
intvHow many bits to shift right
Returns
Floatnew Float 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 >=(floatv)
 :boolean
Arguments
floatvValue to compare to
Returns
booleanComparison result

 
 top of page
Method operator <
Check whether this value is less than the given value
Signature
operator <(floatv)
 :boolean
Arguments
floatvValue to compare to
Returns
booleanComparison result

 
 top of page
Method operator <<
Logical shift left
Signature
operator <<(intv)
 :Float
Arguments
intvHow many bits to shift left
Returns
Floatnew Float 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 <=(floatv)
 :boolean
Arguments
floatvValue to compare to
Returns
booleanComparison result

 
 top of page
Method operator *
Multiply by the given value
Signature
operator *(floatv)
 :Float
Arguments
floatvFactor
Returns
Floatnew Float object holding the result

 
 top of page
Method operator +
Add the given value
Signature
operator +(floatv)
 :Float
Arguments
floatvAddend
Returns
Floatnew Float object holding the result

 
 top of page
Method operator -
Subtract the given value
Signature
operator -(floatv)
 :Float
Arguments
floatvMinuend
Returns
Floatnew Float object holding the result

 
 top of page
Method operator /
Divide by the given value
Signature
operator /(floatv)
 :Float
Arguments
floatvDividend
Returns
Floatnew Float object holding the result

 
 top of page
Method operator ==
Compare to the given value
Signature
operator ==(floatv)
 :boolean
Arguments
floatvValue to compare to
Returns
booleanComparison result

 
 top of page
Method operator unary!
Logical not.
Signature
operator unary!():Float
Returns
Floatnew Float 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-():Float
Returns
Floatnew Float object holding the result

 
 top of page
Method operator unary~
Bitwise not
Signature
operator unary~():Float
Returns
Floatnew Float 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)
 :Float
Arguments
intvRight-hand side operand
Returns
Floatnew Float 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
intvRight-hand side operand
Returns
booleanResult value

 
 top of page
Method operator |
Bitwise OR
Signature
operator |(intv)
 :Float
Arguments
intvRight-hand side operand
Returns
Floatnew Float 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
intvRight-hand side operand
Returns
booleanResult 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
StringfmtANSI-C style format string.
Returns
Stringnew String instance holding a formatted string representation of this number object.

 
 top of page
Method setValue
Set a new value.
Signature
setValue(floatv)
Arguments
floatvThe 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 , List , ListNode , Long , Mailbox , Mutex , Object , ObjectArray , PakFile , PointerArray , Pool , Script , SharedBuffer , Short , Stack , StdErrStream , StdInStream , StdOutStream , 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 , mathClampf , mathClampi , mathDistancePointPlane2d , mathLerpf , mathMaxf , mathMaxi , mathMinf , mathMini , mathPowerf , mathPoweri , mathSmoothStepf , mathWrapf , mathWrapi , milliSeconds , psystem , putenv , srand , system , ucchar 
All Namespaces:default , ui 
All Projects:core , debugtext , tkfreetype2 , tkmath , tkmidi , tkopengl , tkportaudio , tksdl , tkui , tkunit 


auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54