Package 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>, Appendable, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

public class RubyFloat
extends RubyNumeric
implements Appendable

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	Description
static final int	DIG
static final double	EPSILON
static final int	FLOAT_DIG
static final double	INFINITY
static final int	MANT_DIG
static final int	MAX_10_EXP
static final int	MAX_EXP
static final int	MIN_10_EXP
static final int	MIN_EXP
static final double	NAN
static final ByteList	NAN_TO_S_BYTELIST
static final ByteList	NEGATIVE_INFINITY_TO_S_BYTELIST
static final ByteList	POSITIVE_INFINITY_TO_S_BYTELIST
static final int	RADIX
static final int	ROUNDS

Fields inherited from class org.jruby.RubyNumeric

DBL_EPSILON

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_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, 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	Description
RubyFloat(Ruby runtime)
RubyFloat(Ruby runtime, double value)

Method Summary

Modifier and Type	Method	Description
IRubyObject	abs(ThreadContext context)	flo_abs
void	appendIntoString(RubyString target)
BigInteger	asBigInteger(ThreadContext context)	Return a BigInteger representation of this numerical value
double	asDouble(ThreadContext context)	Return a double representation of this numerical value
int	asInt(ThreadContext context)	Returns the value of this numeric and a java int.
long	asLong(ThreadContext context)	Return the value of this numeric as a 64-bit long.
IRubyObject	ceil(ThreadContext context)	MRI: flo_ceil
IRubyObject	ceil(ThreadContext context, IRubyObject digits)	MRI: flo_ceil
IRubyObject	coerce(ThreadContext context, IRubyObject other)	num_coerce
final int	compareTo(IRubyObject other)	Compares this Ruby object with another.
RubyFloat	convertToFloat()	Tries to convert this object to a Ruby Float using the "to_f" method.
RubyInteger	convertToInteger()	Tries to convert this object to a Ruby Integer using the "to_int" method.
static RubyClass	createFloatClass(ThreadContext context, RubyClass Numeric)
IRubyObject	denominator(ThreadContext context)	flo_denominator
IRubyObject	divmod(ThreadContext context, IRubyObject other)	flo_divmod
final boolean	eql(IRubyObject other)	short circuit for Float key comparison
IRubyObject	eql_p(ThreadContext context, IRubyObject other)	num_eql
IRubyObject	equal_p(ThreadContext context, IRubyObject obj)	Compare this Float object with the given object and determine whether they are effectively identical.
boolean	equals(Object other)	This override does not do a "checked" dispatch.
boolean	fastEqual(RubyFloat other)
IRubyObject	finite_p()	Deprecated.
IRubyObject	finite_p(ThreadContext context)
IRubyObject	floor(ThreadContext context)	MRI: flo_floor
IRubyObject	floor(ThreadContext context, IRubyObject digits)	MRI: flo_floor
IRubyObject	floor(ThreadContext context, IRubyObject[] args)	Deprecated.
Class<?>	getJavaClass()	Will return the Java interface that most closely can represent this object, when working through Java integration translations.
ClassIndex	getNativeClassIndex()	This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
double	getValue()	Get the raw float value.
RubyFixnum	hash(ThreadContext context)	Will return the hash code of this object.
final int	hashCode()	This override does not do "checked" dispatch since Object usually has #hash defined.
IRubyObject	id()	Produce an object ID for this Float.
static IRubyObject	induced_from(ThreadContext context, IRubyObject recv, IRubyObject number)	Deprecated.
IRubyObject	infinite_p()	Deprecated.
IRubyObject	infinite_p(ThreadContext context)
boolean	isInfinite()
boolean	isNaN()
IRubyObject	isNegative(ThreadContext context)	num_negative_p
boolean	isNegativeNumber(ThreadContext context)
IRubyObject	isPositive(ThreadContext context)	num_positive_p
boolean	isPositiveNumber(ThreadContext context)
final boolean	isZero(ThreadContext context)
IRubyObject	magnitude(ThreadContext context)	flo_abs/1.9
static void	marshalTo(RubyFloat aFloat, MarshalStream output)	Deprecated, for removal: This API element is subject to removal in a future version.
static void	marshalTo(ThreadContext context, RubyOutputStream out, RubyFloat aFloat, MarshalDumper output)
IRubyObject	nan_p()	Deprecated.
IRubyObject	nan_p(ThreadContext context)	flo_is_nan_p
static RubyFloat	newFloat(Ruby runtime, double value)
IRubyObject	next_float()	Deprecated.
IRubyObject	next_float(ThreadContext context)
IRubyObject	nonzero_p(ThreadContext context)	num_nonzero_p
IRubyObject	numerator(ThreadContext context)	flo_numerator
IRubyObject	op_cmp(ThreadContext context, double other)
IRubyObject	op_cmp(ThreadContext context, IRubyObject other)	flo_cmp
IRubyObject	op_div(ThreadContext context, double other)
IRubyObject	op_div(ThreadContext context, IRubyObject other)	MRI: flo_div
IRubyObject	op_equal(ThreadContext context, double other)
IRubyObject	op_equal(ThreadContext context, IRubyObject other)	flo_eq
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_mul(ThreadContext context, double other)
IRubyObject	op_mul(ThreadContext context, IRubyObject other)	flo_mul
IRubyObject	op_not_equal(ThreadContext context, double other)
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_uminus()	Deprecated.
IRubyObject	op_uminus(ThreadContext context)	flo_uminus
IRubyObject	prev_float()	Deprecated.
IRubyObject	prev_float(ThreadContext context)
IRubyObject	quo(ThreadContext context, IRubyObject other)	flo_quo
IRubyObject	rationalize(ThreadContext context, IRubyObject[] args)	float_rationalize
IRubyObject	round(ThreadContext context)	MRI: flo_round
IRubyObject	round(ThreadContext context, IRubyObject arg0)	MRI: flo_round
IRubyObject	round(ThreadContext context, IRubyObject[] args)	Deprecated.
IRubyObject	round(ThreadContext context, IRubyObject _digits, IRubyObject _opts)	MRI: flo_round
IRubyObject	roundShared(ThreadContext context, int ndigits, RoundingMode mode)
int	signum()	Deprecated.
int	signum(ThreadContext context)
RubyClass	singletonClass(ThreadContext context)	Will either return the existing singleton class for this object, or create a new one and return that.
IRubyObject	to_f()	Deprecated.
IRubyObject	to_f(ThreadContext context)
IRubyObject	to_r(ThreadContext context)
IRubyObject	to_s(ThreadContext context)	flo_to_s
IRubyObject	truncate(ThreadContext context)	MRI: flo_truncate
IRubyObject	truncate(ThreadContext context, IRubyObject n)	MRI: flo_truncate
static RubyFloat	unmarshalFrom(UnmarshalStream input)	Deprecated, for removal: This API element is subject to removal in a future version.
static RubyFloat	unmarshalFrom(ThreadContext context, RubyInputStream in, MarshalLoader input)
IRubyObject	zero_p()	Deprecated.
IRubyObject	zero_p(ThreadContext context)	MRI: flo_zero_p

Methods inherited from class org.jruby.RubyNumeric

abs2, arg, asNumeric, callCoerced, callCoerced, callCoerced, callCoerced, ceil, checkInt, checkInt, coerce, coerceBin, coerceBin, coerceBit, coerceBit, coerceCmp, coerceCmp, coerceFailed, coerceRelOp, coerceRelOp, coerceRescue, compareWithZero, conjugate, convertToRational, convertToRational, createNumericClass, dbl_cmp, dbl2ival, dbl2num, div, doCoerce, dup, fdiv, fix2int, fix2int, fix2long, fixable, float2long, float2ulong, floatStep, floatStepSize, floor, getBigIntegerValue, getCoerced, getDoubleValue, getIntValue, getLongValue, getRoundingMode, idiv, idiv, image, initialize_copy, int2fix, integer_p, integer_p, intervalStepSize, isNegative, isPositive, isReal, isZero, modulo, negativeInt, negFixable, negFixable, newNumeric, num_imaginary, num2chr, num2dbl, num2dbl, num2fix, num2fix, num2int, num2long, num2ulong, numFuncall, numFuncall, numRemainder, op_not, op_num_equal, op_uplus, op_uplus, polar, posFixable, posFixable, positiveInt, rbClone, rbClone, rbClone, rbClone, real, real_p, rect, remainder, round, scalar_p, singleton_method_added, step, str2fnum, str2fnum, str2fnum, str2inum, str2inum, str2inum, to_c, to_int, toJava, truncate

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, dig, dig1, dig2, eqlInternal, equalInternal, finishObjectClass, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, convertToArray, convertToHash, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql_p, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, freeze, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getMarshalVariableList, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, infectBy, initialize, initialize_copy, inspect, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval, instance_exec, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_match, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, trust, type, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, 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

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

checkStringType19, dup, marshalLiveVariables

Field Details

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

FLOAT_DIG

public static final int FLOAT_DIG

See Also:

• Constant Field Values

POSITIVE_INFINITY_TO_S_BYTELIST

public static final ByteList POSITIVE_INFINITY_TO_S_BYTELIST

NEGATIVE_INFINITY_TO_S_BYTELIST

public static final ByteList NEGATIVE_INFINITY_TO_S_BYTELIST

NAN_TO_S_BYTELIST

public static final ByteList NAN_TO_S_BYTELIST

Constructor Details

RubyFloat

public RubyFloat(Ruby runtime)

RubyFloat

public RubyFloat(Ruby runtime,
 double value)

Method Details

createFloatClass

public static RubyClass createFloatClass(ThreadContext context,
 RubyClass Numeric)

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

Returns:

the ClassIndex of the native type this object was constructed from

See Also:

• ClassIndex

singletonClass

public RubyClass singletonClass(ThreadContext context)

Description copied from class: RubyBasicObject

Will either return the existing singleton class for this object, or create a new one and return that. For a few types a singleton class is not possible so it will throw an error.

Specified by:

singletonClass in interface IRubyObject

Overrides:

singletonClass in class RubyBasicObject

Parameters:

context - the current thread context

Returns:

the singleton of this type

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:

the true Java class of this (Ruby) object

getValue

public double getValue()

Get the raw float value. If you want to access this as other Java primitive types then you should use asLong(ThreadContext), asBigInteger(ThreadContext), or asInt(ThreadContext). Those will ensure that the double will fit into the range and create the type if needed (e.g. make a BigInteger). If you KNOW the double is in the right range then you can just use this method and manually cast it.

Returns:

Value of property value.

asBigInteger

public BigInteger asBigInteger(ThreadContext context)

Description copied from class: RubyNumeric

Return a BigInteger representation of this numerical value

Overrides:

asBigInteger in class RubyNumeric

Parameters:

context - the current thread context

Returns:

a BigInteger

asDouble

public double asDouble(ThreadContext context)

Description copied from class: RubyNumeric

Return a double representation of this numerical value

Overrides:

asDouble in class RubyNumeric

Parameters:

context - the current thread context

Returns:

a double

asInt

public int asInt(ThreadContext context)

Description copied from class: RubyNumeric

Returns the value of this numeric and a java int.

Overrides:

asInt in class RubyNumeric

asLong

public long asLong(ThreadContext context)

Description copied from class: RubyNumeric

Return the value of this numeric as a 64-bit long.

Overrides:

asLong 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:

float representation of this

convertToInteger

public RubyInteger convertToInteger()

Description copied from class: RubyBasicObject

Tries to convert this object to a Ruby Integer using the "to_int" method.

Specified by:

convertToInteger in interface IRubyObject

Overrides:

convertToInteger in class RubyBasicObject

Returns:

an integer representation of this

signum

@Deprecated(since="10.0")
public int signum()

Deprecated.

signum

public int signum(ThreadContext context)

isNegative

public IRubyObject isNegative(ThreadContext context)

Description copied from class: RubyNumeric

num_negative_p

Overrides:

isNegative in class RubyNumeric

isPositive

public IRubyObject isPositive(ThreadContext context)

Description copied from class: RubyNumeric

num_positive_p

Overrides:

isPositive in class RubyNumeric

isNegativeNumber

public boolean isNegativeNumber(ThreadContext context)

Overrides:

isNegativeNumber in class RubyNumeric

isPositiveNumber

public boolean isPositiveNumber(ThreadContext context)

Overrides:

isPositiveNumber in class RubyNumeric

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(ThreadContext context)

flo_to_s

Overrides:

to_s in class RubyBasicObject

coerce

public IRubyObject coerce(ThreadContext context,
 IRubyObject other)

Description copied from class: RubyNumeric

num_coerce

Overrides:

coerce in class RubyNumeric

op_uminus

public IRubyObject op_uminus(ThreadContext context)

flo_uminus

Overrides:

op_uminus in class RubyNumeric

op_uminus

@Deprecated
public IRubyObject op_uminus()

Deprecated.

op_plus

public IRubyObject op_plus(ThreadContext context,
 IRubyObject other)

flo_plus

Overrides:

op_plus in class RubyNumeric

op_plus

public IRubyObject op_plus(ThreadContext context,
 double other)

op_minus

public IRubyObject op_minus(ThreadContext context,
 IRubyObject other)

flo_minus

Overrides:

op_minus in class RubyNumeric

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_div

public IRubyObject op_div(ThreadContext context,
 IRubyObject other)

MRI: flo_div

op_div

public IRubyObject op_div(ThreadContext context,
 double other)

quo

public IRubyObject quo(ThreadContext context,
 IRubyObject other)

flo_quo

Overrides:

quo in class RubyNumeric

op_mod

public IRubyObject op_mod(ThreadContext context,
 IRubyObject other)

flo_mod

op_mod

public IRubyObject op_mod(ThreadContext context,
 double other)

divmod

public IRubyObject divmod(ThreadContext context,
 IRubyObject other)

flo_divmod

Overrides:

divmod 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_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)

op_not_equal

public IRubyObject op_not_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 RubyNumeric

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(ThreadContext context,
 IRubyObject other)

Description copied from class: RubyNumeric

num_eql

Overrides:

eql_p in class RubyNumeric

eql

public final boolean eql(IRubyObject other)

short circuit for Float key comparison

Specified by:

eql in interface IRubyObject

Overrides:

eql in class RubyBasicObject

Returns:

Will by default just call the Ruby method "eql?"

equals

public boolean equals(Object other)

Description copied from class: RubyObject

This override does not do a "checked" dispatch.

Overrides:

equals in class RubyObject

Parameters:

other - object to compare

Returns:

true if equals

See Also:

• RubyBasicObject.equals(Object)

hash

public RubyFixnum hash(ThreadContext context)

Description copied from class: RubyBasicObject

Will return the hash code of this object. In comparison to MRI, this method will use the Java identity hash code instead of using rb_obj_id, since the usage of id in JRuby will incur the cost of some. ObjectSpace maintenance.

Overrides:

hash in class RubyBasicObject

Parameters:

context - the current thread context

Returns:

the hash value

hashCode

public final int hashCode()

Description copied from class: RubyObject

This override does not do "checked" dispatch since Object usually has #hash defined.

Overrides:

hashCode in class RubyObject

Returns:

the hash code

See Also:

• RubyBasicObject.hashCode()

to_f

@Deprecated(since="10.0")
public IRubyObject to_f()

Deprecated.

to_f

public IRubyObject to_f(ThreadContext context)

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(ThreadContext context)

MRI: flo_zero_p

Overrides:

zero_p in class RubyNumeric

isZero

public final boolean isZero(ThreadContext context)

Overrides:

isZero in class RubyNumeric

nonzero_p

public IRubyObject nonzero_p(ThreadContext context)

Description copied from class: RubyNumeric

num_nonzero_p

Overrides:

nonzero_p in class RubyNumeric

truncate

public IRubyObject truncate(ThreadContext context)

MRI: flo_truncate

Overrides:

truncate in class RubyNumeric

truncate

public IRubyObject truncate(ThreadContext context,
 IRubyObject n)

MRI: flo_truncate

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(ThreadContext context)

MRI: flo_floor

Overrides:

floor in class RubyNumeric

floor

public IRubyObject floor(ThreadContext context,
 IRubyObject digits)

MRI: flo_floor

ceil

public IRubyObject ceil(ThreadContext context)

MRI: flo_ceil

Overrides:

ceil in class RubyNumeric

ceil

public IRubyObject ceil(ThreadContext context,
 IRubyObject digits)

MRI: flo_ceil

round

public IRubyObject round(ThreadContext context)

MRI: flo_round

Overrides:

round in class RubyNumeric

round

public IRubyObject round(ThreadContext context,
 IRubyObject arg0)

MRI: flo_round

round

public IRubyObject round(ThreadContext context,
 IRubyObject _digits,
 IRubyObject _opts)

MRI: flo_round

roundShared

public IRubyObject roundShared(ThreadContext context,
 int ndigits,
 RoundingMode mode)

nan_p

public IRubyObject nan_p(ThreadContext context)

flo_is_nan_p

nan_p

@Deprecated
public IRubyObject nan_p()

Deprecated.

isNaN

public boolean isNaN()

infinite_p

@Deprecated(since="10.0")
public IRubyObject infinite_p()

Deprecated.

infinite_p

public IRubyObject infinite_p(ThreadContext context)

Overrides:

infinite_p in class RubyNumeric

isInfinite

public boolean isInfinite()

finite_p

@Deprecated(since="10.0")
public IRubyObject finite_p()

Deprecated.

finite_p

public IRubyObject finite_p(ThreadContext context)

Overrides:

finite_p in class RubyNumeric

marshalTo

@Deprecated(since="10.0",
            forRemoval=true)
public static void marshalTo(RubyFloat aFloat,
 MarshalStream output)
                      throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException

marshalTo

public static void marshalTo(ThreadContext context,
 RubyOutputStream out,
 RubyFloat aFloat,
 MarshalDumper output)

unmarshalFrom

@Deprecated(since="10.0",
            forRemoval=true)
public static RubyFloat unmarshalFrom(UnmarshalStream input)
                               throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IOException

unmarshalFrom

public static RubyFloat unmarshalFrom(ThreadContext context,
 RubyInputStream in,
 MarshalLoader input)

next_float

@Deprecated(since="10.0")
public IRubyObject next_float()

Deprecated.

next_float

public IRubyObject next_float(ThreadContext context)

prev_float

@Deprecated(since="10.0")
public IRubyObject prev_float()

Deprecated.

prev_float

public IRubyObject prev_float(ThreadContext context)

id

public IRubyObject id()

Produce an object ID for this Float. Values within the "flonum" range will produce a special object ID that emulates the CRuby tagged "flonum" pointer logic. This ID is never registered but can be reversed by ObjectSpace._id2ref using the same bit manipulation as in CRuby.

Specified by:

id in interface IRubyObject

Overrides:

id in class RubyBasicObject

Returns:

the object ID for this Float

equal_p

public IRubyObject equal_p(ThreadContext context,
 IRubyObject obj)

Compare this Float object with the given object and determine whether they are effectively identical. This logic for Float considers all values in the "flonum" range to be identical, since in CRuby they would have the same pointer value (a tagged "flonum" pointer). We do not support flonums, but emulate this behavior for compatibility.

Overrides:

equal_p in class RubyBasicObject

Parameters:

context - the current context

obj - the object with which to compare

Returns:

true if this Float and the given object are effectively identical, false otherwise

appendIntoString

public void appendIntoString(RubyString target)

Specified by:

appendIntoString in interface Appendable

zero_p

@Deprecated
public IRubyObject zero_p()

Deprecated.

floor

@Deprecated
public IRubyObject floor(ThreadContext context,
 IRubyObject[] args)

Deprecated.

round

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

Deprecated.