Objeck Classes

All Bundles

Float

Float class represents a double-precision floating-point value

Derived from: Number

Operations

Abs
ArcCos
ArcSin
ArcTan
ArcTan2
Ceiling
Clamp
Clear
Compare
Cos
DoubleFactorial
E
Error
ErrorLine
Factorial
Floor
Gamma
IsNeg
Log
Max
Min
Mod
Pi
Pow
Print
PrintLine
Random
Sin
Sqrt
Tan
ToByte
ToChar
ToDegrees
ToInt
ToRadians
ToString

Abs

Returns the absolute value

function : native : Abs() ~ Float

Return

Type	Description
Float	absolute value

ArcCos

Calculates the cosine value

function : ArcCos() ~ Float

Return

Type	Description
Float	cosine value

ArcSin

Calculates the arc-sine value

function : ArcSin() ~ Float

Return

Type	Description
Float	arc-sine value

ArcTan

Calculates the arc-tangent value

function : ArcTan() ~ Float

Return

Type	Description
Float	arc-tangent value

ArcTan2

Calculates arc tangent of y/x

function : ArcTan2(y:Float, x:Float) ~ Float

Parameters

Name	Type	Description
y	Float	value
x	Float	value

Return

Type	Description
Float	arc-tangent value

Ceiling

Calculates the ceiling value

function : Ceiling() ~ Float

Return

Type	Description
Float	ceiling value

Clamp

Returns a given value between an upper and lower bound

function : Clamp(min:Float, value:Float, max:Float) ~ Float

Parameters

Name	Type	Description
min	Float	minimal value
value	Float	value between the min and max
max	Float	maximum value

Return

Type	Description
Float	min if vaule is less than main, max if max is less than value, otherwise the value

Clear

Set all array elements to zero

function : Clear(f:Float[]) ~ Nil

Parameters

Name	Type	Description
f	Float[]	array

Compare

Compares two value

function : native : Compare(l:Float, r:Float) ~ Int

Parameters

Name	Type	Description
l	Float	left compare object
r	Float	right compare object

Return

Type	Description
Int	0 if equal, -1 if types differ, 1 if equal

Cos

Calculates the cosine value

function : Cos() ~ Float

Return

Type	Description
Float	cosine value

DoubleFactorial

Calculates the double factorial of the value

function : native : DoubleFactorial() ~ Float

Parameters

Name	Type	Description

Return

Type	Description
Float	double factorial of the value

E

Value of E

function : E() ~ Float

Return

Type	Description
Float	value of E

Error

Prints error value

function : Error() ~ Nil

ErrorLine

Prints error value with newline

function : ErrorLine() ~ Nil

Factorial

Calculates the factorial value

function : Factorial() ~ Float

Parameters

Name	Type	Description

Return

Type	Description
Float	factorial value

Floor

Calculates the floor value

function : Floor() ~ Float

Return

Type	Description
Float	floor value

Gamma

Calculates the gamma value

function : Gamma() ~ Float

Parameters

Name	Type	Description

Return

Type	Description
Float	gamma value

IsNeg

Checks is a number is negative

function : IsNeg() ~ Bool

Return

Type	Description
Bool	true if negative, false otherwise

Log

Calculates the log value

function : Log() ~ Float

Return

Type	Description
Float	log value

Max

Returns the largest float value

function : native : Max(l:Float, r:Float) ~ Float

Parameters

Name	Type	Description
l	Float	value to compare
r	Float	value to compare

Return

Type	Description
Float	largest float value

Min

Returns the smallest float value

function : native : Min(r:Float) ~ Float

Parameters

Name	Type	Description
r	Float	value to compare

Return

Type	Description
Float	smallest float value

Mod

Calculates the decimal mod

function : Mod(a:Float, b:Float) ~ Float

Parameters

Name	Type	Description
a	Float	value
b	Float	value

Return

Type	Description
Float	decimial mod

Pi

Value of Pi

function : Pi() ~ Float

Return

Type	Description
Float	value of Pi

Pow

Calculates the power value

function : Pow(b:Float, r:Float) ~ Float

Parameters

Name	Type	Description
b	Float	power base
r	Float	power to raise

Return

Type	Description
Float	pseudo power value

Print

Prints value

function : Print() ~ Nil

PrintLine

Prints value with newline

function : PrintLine() ~ Nil

Random

Returns a pseudo random value between 0.0 and 1.0

function : Random() ~ Float

Return

Type	Description
Float	pseudo random value

Sin

Calculates the sine value

function : Sin() ~ Float

Return

Type	Description
Float	sine value

Sqrt

Calculates the natural log value

function : Sqrt() ~ Float

Return

Type	Description
Float	natural log value

Tan

Calculates the tangent value

function : Tan() ~ Float

Return

Type	Description
Float	tangent value

ToByte

Returns the Character value

function : ToByte() ~ Byte

Return

Type	Description
Byte	value

ToChar

Returns the Int value

function : ToChar() ~ Char

Return

Type	Description
Char	value

ToDegrees

Converts the value into degrees

function : ToDegrees() ~ Float

Return

Type	Description
Float	degree value

ToInt

Returns the Int value

function : ToInt() ~ Int

Return

Type	Description
Int	value

ToRadians

Converts the value into radians

function : ToRadians() ~ Float

Return

Type	Description
Float	radian value

ToString

Returns a string representation of the value

function : native : ToString() ~ String

Return

Type	Description
String	string representation of the value