org.jruby

Class RubyFloat

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyNumeric

org.jruby.RubyFloat

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

public class RubyFloat
extends RubyNumeric

A representation of a float object

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.RubyNumeric

RubyNumeric.InvalidIntegerException, RubyNumeric.NumberTooLargeException

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field and Description
static int	DIG
static double	EPSILON
static double	INFINITY
static int	MANT_DIG
static int	MAX_10_EXP
static int	MAX_EXP
static int	MIN_10_EXP
static int	MIN_EXP
static double	NAN
static int	RADIX
static int	ROUNDS

Fields inherited from class org.jruby.RubyNumeric

DBL_EPSILON, NUMERIC_ALLOCATOR

Fields inherited from class org.jruby.RubyObject

FIELD_ALLOCATED_CLASSES, FIELD_ALLOCATORS, IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, OBJECT_VAR0_ALLOCATOR, OBJECT_VAR1_ALLOCATOR, OBJECT_VAR2_ALLOCATOR, OBJECT_VAR3_ALLOCATOR, OBJECT_VAR4_ALLOCATOR, OBJECT_VAR5_ALLOCATOR, OBJECT_VAR6_ALLOCATOR, OBJECT_VAR7_ALLOCATOR, OBJECT_VAR8_ALLOCATOR, OBJECT_VAR9_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUST_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Constructor and Description
RubyFloat(Ruby runtime)
RubyFloat(Ruby runtime, double value)

Method Summary

Methods

Modifier and Type	Method and Description
IRubyObject	abs(ThreadContext context) flo_abs
IRubyObject	ceil() flo_ceil
IRubyObject	coerce(IRubyObject other) flo_coerce
int	compareTo(IRubyObject other) Compares this Ruby object with another.
protected int	compareValue(RubyNumeric other)
RubyFloat	convertToFloat() Tries to convert this object to a Ruby Float using the "to_f" method.
static RubyClass	createFloatClass(Ruby runtime)
IRubyObject	denominator(ThreadContext context) flo_denominator
IRubyObject	divmod(ThreadContext context, IRubyObject other) flo_divmod
IRubyObject	divmod19(ThreadContext context, IRubyObject other) flo_divmod
IRubyObject	eql_p(IRubyObject other) flo_eql
boolean	fastEqual(RubyFloat other)
IRubyObject	finite_p() flo_is_finite_p
IRubyObject	floor() floor
BigInteger	getBigIntegerValue()
double	getDoubleValue()
int	getIntValue() Return the value of this numeric as a 32-bit long.
Class<?>	getJavaClass() Will return the Java interface that most closely can represent this object, when working through JAva integration translations.
long	getLongValue() Return the value of this numeric as a 64-bit long.
ClassIndex	getNativeClassIndex() This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
RubyClass	getSingletonClass() rb_singleton_class Note: this method is specialized for RubyFixnum, RubySymbol, RubyNil and RubyBoolean Will either return the existing singleton class for this object, or create a new one and return that.
double	getValue() Getter for property value.
RubyFixnum	hash() flo_hash
int	hashCode() Override the Object#hashCode method to make sure that the Ruby hash is actually used as the hashcode for Ruby objects.
static IRubyObject	induced_from(ThreadContext context, IRubyObject recv, IRubyObject number) Deprecated.
IRubyObject	infinite_p() flo_is_infinite_p
IRubyObject	magnitude(ThreadContext context) flo_abs/1.9
IRubyObject	magnitude(ThreadContext context, IRubyObject other) flo_quo
static void	marshalTo(RubyFloat aFloat, MarshalStream output)
IRubyObject	nan_p() flo_is_nan_p
static RubyFloat	newFloat(Ruby runtime, double value)
IRubyObject	next_float()
IRubyObject	numerator(ThreadContext context) flo_numerator
IRubyObject	op_cmp(ThreadContext context, double other)
IRubyObject	op_cmp(ThreadContext context, IRubyObject other) flo_cmp
IRubyObject	op_equal(ThreadContext context, double other)
IRubyObject	op_equal(ThreadContext context, IRubyObject other) flo_eq
IRubyObject	op_fdiv(ThreadContext context, double other)
IRubyObject	op_fdiv(ThreadContext context, IRubyObject other) flo_div
IRubyObject	op_ge(ThreadContext context, double other)
IRubyObject	op_ge(ThreadContext context, IRubyObject other) flo_ge
IRubyObject	op_gt(ThreadContext context, double other)
IRubyObject	op_gt(ThreadContext context, IRubyObject other) flo_gt
IRubyObject	op_le(ThreadContext context, double other)
IRubyObject	op_le(ThreadContext context, IRubyObject other) flo_le
IRubyObject	op_lt(ThreadContext context, double other)
IRubyObject	op_lt(ThreadContext context, IRubyObject other) flo_lt
IRubyObject	op_minus(ThreadContext context, double other)
IRubyObject	op_minus(ThreadContext context, IRubyObject other) flo_minus
IRubyObject	op_mod(ThreadContext context, double other)
IRubyObject	op_mod(ThreadContext context, IRubyObject other) flo_mod
IRubyObject	op_mod19(ThreadContext context, IRubyObject other) flo_mod
IRubyObject	op_mul(ThreadContext context, double other)
IRubyObject	op_mul(ThreadContext context, IRubyObject other) flo_mul
IRubyObject	op_plus(ThreadContext context, double other)
IRubyObject	op_plus(ThreadContext context, IRubyObject other) flo_plus
IRubyObject	op_pow(ThreadContext context, double other)
IRubyObject	op_pow(ThreadContext context, IRubyObject other) flo_pow
IRubyObject	op_pow19(ThreadContext context, IRubyObject other)
IRubyObject	op_uminus() flo_uminus
IRubyObject	prev_float()
IRubyObject	rationalize(ThreadContext context, IRubyObject[] args) float_rationalize
IRubyObject	round() flo_round
IRubyObject	round(ThreadContext context, IRubyObject[] args)
IRubyObject	to_f() flo_fo
IRubyObject	to_r(ThreadContext context)
IRubyObject	to_s() flo_to_s
IRubyObject	truncate() flo_truncate
static RubyFloat	unmarshalFrom(UnmarshalStream input)
IRubyObject	zero_p() flo_zero_p

Methods inherited from class org.jruby.RubyNumeric

abs2, arg, asNumeric, callCoerced, callCoerced, checkInt, coerceBin, coerceBit, coerceBody, coerceCmp, coerceFailed, coerceRelOp, coerceRescue, conjugate, createNumericClass, dbl_cmp, dbl2num, div, div19, doCoerce, eql_p, fdiv, fix2int, fix2int, fix2long, floatStep, floatStepSize, getCoerced, image, initialize_copy, int2fix, integer_p, intervalStepSize, modulo, modulo19, newNumeric, nonzero_p, num_imaginary, num2chr, num2dbl, num2fix, num2int, num2long, op_cmp, op_num_equal, op_uminus, op_uplus, polar, quo_19, quo, real, rect, remainder, sadded, scalar_p, step, str2fnum, str2fnum, str2fnum19, str2inum, str2inum, to_c, to_int, toJava, zero_p

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, eqlInternal, equalInternal, equals, initialize, initialize, inspect, op_eqq, puts, specificEval, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkFrozen, checkStringType, checkStringType19, convertToArray, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, display, dup, ensureInstanceVariablesSettable, eql, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClassClone, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize19, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing19, method, method19, methods, methods, methods19, nil_p, OBJ_INIT_COPY, objInitCopy, op_equal_19, op_match, op_match19, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added19, singleton_method_removed19, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, trust, type_deprecated, type, untaint, untrust, untrusted_p, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ROUNDS

public static final int ROUNDS

See Also:

Constant Field Values

RADIX

public static final int RADIX

See Also:

Constant Field Values

MANT_DIG

public static final int MANT_DIG

See Also:

Constant Field Values

DIG

public static final int DIG

See Also:

Constant Field Values

MIN_EXP

public static final int MIN_EXP

See Also:

Constant Field Values

MAX_EXP

public static final int MAX_EXP

See Also:

Constant Field Values

MAX_10_EXP

public static final int MAX_10_EXP

See Also:

Constant Field Values

MIN_10_EXP

public static final int MIN_10_EXP

See Also:

Constant Field Values

EPSILON

public static final double EPSILON

See Also:

Constant Field Values

INFINITY

public static final double INFINITY

See Also:

Constant Field Values

NAN

public static final double NAN

See Also:

Constant Field Values

Constructor Detail

RubyFloat

public RubyFloat(Ruby runtime)

RubyFloat

public RubyFloat(Ruby runtime,
         double value)

Method Detail

createFloatClass

public static RubyClass createFloatClass(Ruby runtime)

getNativeClassIndex

public ClassIndex getNativeClassIndex()

Description copied from class: RubyObject

This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are. Will generally return a value from org.jruby.runtime.ClassIndex

Specified by:

getNativeClassIndex in interface CoreObjectType

Overrides:

getNativeClassIndex in class RubyObject

See Also:

ClassIndex

getSingletonClass

public RubyClass getSingletonClass()

Description copied from class: RubyBasicObject

rb_singleton_class Note: this method is specialized for RubyFixnum, RubySymbol, RubyNil and RubyBoolean Will either return the existing singleton class for this object, or create a new one and return that.

Specified by:

getSingletonClass in interface IRubyObject

Overrides:

getSingletonClass in class RubyBasicObject

Returns:

RubyClass

getJavaClass

public Class<?> getJavaClass()

Description copied from class: RubyBasicObject

Will return the Java interface that most closely can represent this object, when working through JAva integration translations.

Specified by:

getJavaClass in interface IRubyObject

Overrides:

getJavaClass in class RubyBasicObject

Returns:

Class

getValue

public double getValue()

Getter for property value.

Returns:

Value of property value.

getDoubleValue

public double getDoubleValue()

Overrides:

getDoubleValue in class RubyNumeric

getLongValue

public long getLongValue()

Description copied from class: RubyNumeric

Return the value of this numeric as a 64-bit long. If the value does not fit in 64 bits, it will be truncated.

Overrides:

getLongValue in class RubyNumeric

getIntValue

public int getIntValue()

Description copied from class: RubyNumeric

Return the value of this numeric as a 32-bit long. If the value does not fit in 32 bits, it will be truncated.

Overrides:

getIntValue in class RubyNumeric

getBigIntegerValue

public BigInteger getBigIntegerValue()

Overrides:

getBigIntegerValue in class RubyNumeric

convertToFloat

public RubyFloat convertToFloat()

Description copied from class: RubyBasicObject

Tries to convert this object to a Ruby Float using the "to_f" method.

Specified by:

convertToFloat in interface IRubyObject

Overrides:

convertToFloat in class RubyBasicObject

Returns:

compareValue

protected int compareValue(RubyNumeric other)

newFloat

public static RubyFloat newFloat(Ruby runtime,
                 double value)

induced_from

@Deprecated
public static IRubyObject induced_from(ThreadContext context,
                                  IRubyObject recv,
                                  IRubyObject number)

Deprecated.

rb_flo_induced_from

to_s

public IRubyObject to_s()

flo_to_s

Overrides:

to_s in class RubyBasicObject

coerce

public IRubyObject coerce(IRubyObject other)

flo_coerce

Overrides:

coerce in class RubyNumeric

op_uminus

public IRubyObject op_uminus()

flo_uminus

op_plus

public IRubyObject op_plus(ThreadContext context,
                  IRubyObject other)

flo_plus

op_plus

public IRubyObject op_plus(ThreadContext context,
                  double other)

op_minus

public IRubyObject op_minus(ThreadContext context,
                   IRubyObject other)

flo_minus

op_minus

public IRubyObject op_minus(ThreadContext context,
                   double other)

op_mul

public IRubyObject op_mul(ThreadContext context,
                 IRubyObject other)

flo_mul

op_mul

public IRubyObject op_mul(ThreadContext context,
                 double other)

op_fdiv

public IRubyObject op_fdiv(ThreadContext context,
                  IRubyObject other)

flo_div

op_fdiv

public IRubyObject op_fdiv(ThreadContext context,
                  double other)

magnitude

public IRubyObject magnitude(ThreadContext context,
                    IRubyObject other)

flo_quo

op_mod

public IRubyObject op_mod(ThreadContext context,
                 IRubyObject other)

flo_mod

op_mod

public IRubyObject op_mod(ThreadContext context,
                 double other)

op_mod19

public IRubyObject op_mod19(ThreadContext context,
                   IRubyObject other)

flo_mod

divmod

public IRubyObject divmod(ThreadContext context,
                 IRubyObject other)

flo_divmod

Overrides:

divmod in class RubyNumeric

divmod19

public IRubyObject divmod19(ThreadContext context,
                   IRubyObject other)

flo_divmod

Overrides:

divmod19 in class RubyNumeric

op_pow

public IRubyObject op_pow(ThreadContext context,
                 IRubyObject other)

flo_pow

op_pow

public IRubyObject op_pow(ThreadContext context,
                 double other)

op_pow19

public IRubyObject op_pow19(ThreadContext context,
                   IRubyObject other)

op_equal

public IRubyObject op_equal(ThreadContext context,
                   IRubyObject other)

flo_eq

Specified by:

op_equal in interface IRubyObject

Overrides:

op_equal in class RubyBasicObject

op_equal

public IRubyObject op_equal(ThreadContext context,
                   double other)

fastEqual

public boolean fastEqual(RubyFloat other)

compareTo

public final int compareTo(IRubyObject other)

Description copied from class: RubyBasicObject

Compares this Ruby object with another.

Specified by:

compareTo in interface Comparable<IRubyObject>

Overrides:

compareTo in class RubyBasicObject

Parameters:

other - another IRubyObject

Returns:

0 if equal, < 0 if this is less than other, > 0 if this is greater than other

op_cmp

public IRubyObject op_cmp(ThreadContext context,
                 IRubyObject other)

flo_cmp

Overrides:

op_cmp in class RubyBasicObject

op_cmp

public IRubyObject op_cmp(ThreadContext context,
                 double other)

op_gt

public IRubyObject op_gt(ThreadContext context,
                IRubyObject other)

flo_gt

op_gt

public IRubyObject op_gt(ThreadContext context,
                double other)

op_ge

public IRubyObject op_ge(ThreadContext context,
                IRubyObject other)

flo_ge

op_ge

public IRubyObject op_ge(ThreadContext context,
                double other)

op_lt

public IRubyObject op_lt(ThreadContext context,
                IRubyObject other)

flo_lt

op_lt

public IRubyObject op_lt(ThreadContext context,
                double other)

op_le

public IRubyObject op_le(ThreadContext context,
                IRubyObject other)

flo_le

op_le

public IRubyObject op_le(ThreadContext context,
                double other)

eql_p

public IRubyObject eql_p(IRubyObject other)

flo_eql

Overrides:

eql_p in class RubyBasicObject

hash

public RubyFixnum hash()

flo_hash

Overrides:

hash in class RubyBasicObject

hashCode

public final int hashCode()

Description copied from class: RubyObject

Override the Object#hashCode method to make sure that the Ruby hash is actually used as the hashcode for Ruby objects. If the Ruby "hash" method doesn't return a number, the Object#hashCode implementation will be used instead.

Overrides:

hashCode in class RubyObject

to_f

public IRubyObject to_f()

flo_fo

abs

public IRubyObject abs(ThreadContext context)

flo_abs

Overrides:

abs in class RubyNumeric

magnitude

public IRubyObject magnitude(ThreadContext context)

flo_abs/1.9

Overrides:

magnitude in class RubyNumeric

zero_p

public IRubyObject zero_p()

flo_zero_p

truncate

public IRubyObject truncate()

flo_truncate

Overrides:

truncate in class RubyNumeric

numerator

public IRubyObject numerator(ThreadContext context)

flo_numerator

Overrides:

numerator in class RubyNumeric

denominator

public IRubyObject denominator(ThreadContext context)

flo_denominator

Overrides:

denominator in class RubyNumeric

to_r

public IRubyObject to_r(ThreadContext context)

rationalize

public IRubyObject rationalize(ThreadContext context,
                      IRubyObject[] args)

float_rationalize

floor

public IRubyObject floor()

floor

Overrides:

floor in class RubyNumeric

ceil

public IRubyObject ceil()

flo_ceil

Overrides:

ceil in class RubyNumeric

round

public IRubyObject round()

flo_round

Overrides:

round in class RubyNumeric

round

public IRubyObject round(ThreadContext context,
                IRubyObject[] args)

nan_p

public IRubyObject nan_p()

flo_is_nan_p

infinite_p

public IRubyObject infinite_p()

flo_is_infinite_p

finite_p

public IRubyObject finite_p()

flo_is_finite_p

marshalTo

public static void marshalTo(RubyFloat aFloat,
             MarshalStream output)
                      throws IOException

Throws:

IOException

unmarshalFrom

public static RubyFloat unmarshalFrom(UnmarshalStream input)
                               throws IOException

Throws:

IOException

next_float

public IRubyObject next_float()

prev_float

public IRubyObject prev_float()