Module org.jruby.base

Package org.jruby.ext.bigdecimal

Class RubyBigDecimal

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyNumeric

org.jruby.ext.bigdecimal.RubyBigDecimal

All Implemented Interfaces:

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

public class RubyBigDecimal
extends RubyNumeric
implements SimpleHash

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RubyBigDecimal.BigDecimalKernelMethods

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	BASE
static final int	EXCEPTION_ALL
static final int	EXCEPTION_INFINITY
static final int	EXCEPTION_NaN
static final int	EXCEPTION_OVERFLOW
static final int	EXCEPTION_UNDERFLOW
static final int	EXCEPTION_ZERODIVIDE
static final int	ROUND_CEILING
static final int	ROUND_DOWN
static final int	ROUND_FLOOR
static final int	ROUND_HALF_DOWN
static final int	ROUND_HALF_EVEN
static final int	ROUND_HALF_UP
static final int	ROUND_MODE
static final int	ROUND_UP
static final int	SIGN_NaN
static final int	SIGN_NEGATIVE_FINITE
static final int	SIGN_NEGATIVE_INFINITE
static final int	SIGN_NEGATIVE_ZERO
static final int	SIGN_POSITIVE_FINITE
static final int	SIGN_POSITIVE_INFINITE
static final int	SIGN_POSITIVE_ZERO

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, ERR_INSECURE_SET_INST_VAR, FALSE_F, flags, FROZEN_F, metaClass, NEVER, NIL_F, STAMP_OFFSET, TAINTED_F, UNDEF, VAR_TABLE_OFFSET, varTable, varTableStamp

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

NULL_ARRAY

Constructor Summary

Constructors

Constructor	Description
RubyBigDecimal(Ruby runtime, BigDecimal value)
RubyBigDecimal(Ruby runtime, BigDecimal value, boolean isNan)
RubyBigDecimal(Ruby runtime, BigDecimal value, int infinitySign)
RubyBigDecimal(Ruby runtime, BigDecimal value, int infinitySign, int zeroSign)
RubyBigDecimal(Ruby runtime, RubyClass klass)
RubyBigDecimal(Ruby runtime, RubyClass klass, BigDecimal value)

Method Summary

Modifier and Type	Method	Description
IRubyObject	_dump(ThreadContext context)
IRubyObject	_dump(ThreadContext context, IRubyObject unused)
static RubyBigDecimal	_load(ThreadContext context, IRubyObject recv, IRubyObject from)
IRubyObject	abs()	Deprecated.
IRubyObject	abs(ThreadContext context)	num_abs
IRubyObject	add2(ThreadContext context, IRubyObject b, IRubyObject digits)
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.
static BigDecimal	bigSqrt(BigDecimal squarD, MathContext rootMC)	Returns the correctly rounded square root of a positive BigDecimal.
IRubyObject	ceil(ThreadContext context)	MRI: num_ceil
IRubyObject	ceil(ThreadContext context, IRubyObject arg)
RubyArray	coerce(ThreadContext context, IRubyObject other)	num_coerce
RubyFloat	convertToFloat()	Tries to convert this object to a Ruby Float using the "to_f" method.
RubyInteger	convertToInteger()	Deprecated.
static RubyClass	createBigDecimal(ThreadContext context)
IRubyObject	divmod(ThreadContext context, IRubyObject other)	num_divmod
static IRubyObject	double_fig(ThreadContext context, IRubyObject recv)
IRubyObject	eql_p(ThreadContext context, IRubyObject arg)	num_eql
IRubyObject	exponent()	Deprecated.
IRubyObject	exponent(ThreadContext context)
IRubyObject	finite_p()	Deprecated.
IRubyObject	finite_p(ThreadContext context)
IRubyObject	fix()	Deprecated.
IRubyObject	fix(ThreadContext context)
IRubyObject	floor(ThreadContext context)	MRI: num_floor
IRubyObject	floor(ThreadContext context, IRubyObject arg)
static int	formatFractionalDigitGroups(String format)
static boolean	formatHasFloatingPointNotation(String format)
static boolean	formatHasLeadingPlus(String format)
static boolean	formatHasLeadingSpace(String format)
IRubyObject	frac(ThreadContext context)
BigDecimal	getBigDecimalValue()
ClassIndex	getNativeClassIndex()	This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
BigDecimal	getValue()
RubyFixnum	hash(ThreadContext context)	Will return the hash code of this object.
int	hashCode()	This override does not do "checked" dispatch since Object usually has #hash defined.
static IRubyObject	induced_from(ThreadContext context, IRubyObject recv, IRubyObject arg)
IRubyObject	infinite_p(ThreadContext context)
IRubyObject	initialize_copy(ThreadContext context, IRubyObject original)	num_init_copy
IRubyObject	inspect(ThreadContext context)	Returns a string containing a human-readable representation of obj.
static IRubyObject	interpret_loosely(ThreadContext context, IRubyObject recv, IRubyObject str)
final boolean	isZero(ThreadContext context)
static IRubyObject	limit(ThreadContext context, IRubyObject recv)	Retrieve vpPrecLimit.
static IRubyObject	limit(ThreadContext context, IRubyObject recv, IRubyObject arg)	Set new vpPrecLimit if Fixnum and return the old value.
long	longHashCode()
static IRubyObject	mode(ThreadContext context, IRubyObject recv, IRubyObject[] args)
IRubyObject	mult2(ThreadContext context, IRubyObject b, IRubyObject n)
RubyNumeric	multiplyWith(ThreadContext context, RubyBignum value)
RubyNumeric	multiplyWith(ThreadContext context, RubyFloat value)
RubyNumeric	multiplyWith(ThreadContext context, RubyInteger value)
IRubyObject	n_significant_digits(ThreadContext context)
IRubyObject	nan_p(ThreadContext context)
static RubyBigDecimal	newInstance(ThreadContext context, IRubyObject recv, IRubyObject arg)	Deprecated.
static IRubyObject	newInstance(ThreadContext context, IRubyObject recv, IRubyObject arg, boolean strict, boolean exception)	Deprecated.
static RubyBigDecimal	newInstance(ThreadContext context, IRubyObject recv, IRubyObject arg, IRubyObject mathArg)
static IRubyObject	newInstance(ThreadContext context, IRubyObject recv, IRubyObject arg, IRubyObject mathArg, boolean strict, boolean exception)
IRubyObject	nonzero_p(ThreadContext context)	num_nonzero_p
IRubyObject	op_cmp(ThreadContext context, IRubyObject arg)	num_cmp
IRubyObject	op_div(ThreadContext context, IRubyObject other)
IRubyObject	op_div(ThreadContext context, IRubyObject other, IRubyObject digits)
IRubyObject	op_divide(ThreadContext context, IRubyObject other)
IRubyObject	op_eqq(ThreadContext context, IRubyObject arg)	rb_equal The Ruby "===" method is used by default in case/when statements.
IRubyObject	op_ge(ThreadContext context, IRubyObject arg)
IRubyObject	op_gt(ThreadContext context, IRubyObject arg)
IRubyObject	op_le(ThreadContext context, IRubyObject arg)
IRubyObject	op_lt(ThreadContext context, IRubyObject arg)
IRubyObject	op_minus(ThreadContext context, IRubyObject b)
IRubyObject	op_mod(ThreadContext context, IRubyObject other)
IRubyObject	op_mul(ThreadContext context, IRubyObject arg)
IRubyObject	op_plus(ThreadContext context, IRubyObject b)
IRubyObject	op_pow(ThreadContext context, IRubyObject exp)
IRubyObject	op_power(ThreadContext context, IRubyObject exp)
IRubyObject	op_power(ThreadContext context, IRubyObject exp, IRubyObject prec)
IRubyObject	op_quo(ThreadContext context, IRubyObject other)
IRubyObject	op_quo(ThreadContext context, IRubyObject object, IRubyObject digits)
IRubyObject	op_uminus(ThreadContext context)	num_uminus
IRubyObject	op_uplus(ThreadContext context)	num_uplus
IRubyObject	precision(ThreadContext context)
RubyArray	precision_scale(ThreadContext context)
IRubyObject	remainder(ThreadContext context, IRubyObject arg)	num_remainder
IRubyObject	round(ThreadContext context, IRubyObject[] args)
IRubyObject	round(ThreadContext context, IRubyObject scale, IRubyObject mode)
static IRubyObject	save_exception_mode(ThreadContext context, IRubyObject recv, Block block)
static IRubyObject	save_limit(ThreadContext context, IRubyObject recv, Block block)
static IRubyObject	save_rounding_mode(ThreadContext context, IRubyObject recv, Block block)
IRubyObject	scale(ThreadContext context)
IRubyObject	sign()	Deprecated. Use sign(ThreadContext) instead.
IRubyObject	sign(ThreadContext context)
RubyArray	split(ThreadContext context)
IRubyObject	sqrt(IRubyObject arg)	Deprecated.
IRubyObject	sqrt(ThreadContext context, IRubyObject arg)
IRubyObject	sub2(ThreadContext context, IRubyObject b, IRubyObject n)
IRubyObject	to_f()	Deprecated.
IRubyObject	to_f(ThreadContext context)
final IRubyObject	to_int()	Deprecated.
IRubyObject	to_int(ThreadContext context)	num_to_int
IRubyObject	to_r(ThreadContext context)
RubyString	to_s(ThreadContext context)
RubyString	to_s(ThreadContext context, IRubyObject arg)
<T> T	toJava(Class<T> target)	Convert the object to the specified Java class, if possible.
String	toString()	The default toString method is just a wrapper that calls the Ruby "to_s" method.
IRubyObject	truncate(ThreadContext context)	MRI: num_truncate
IRubyObject	truncate(ThreadContext context, IRubyObject arg)
IRubyObject	zero_p(ThreadContext context)	num_zero_p

Methods inherited from class org.jruby.RubyNumeric

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

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, dig, dig1, dig2, eqlInternal, equalInternal, equals, finishObjectClass, inspect, puts, toRubyString

Methods inherited from class org.jruby.RubyBasicObject

__id__, addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, compareTo, convertToArray, convertToHash, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataWrapStruct, decode, display, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, eql_p, equal_p, evalUnder, extend, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, freeze, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMarshalVariableList, getMetaClass, getMetaClass, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableList, getVariableNameList, hash, hashyInspect, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize_copy, 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, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_equal, op_match, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setTaint, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, singletonClass, specificEval, specificEval, specificEval, specificEval, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_s, type, untaint, validateInstanceVariable, variableTableContains, 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

ROUND_DOWN

public static final int ROUND_DOWN

See Also:

• Constant Field Values

ROUND_CEILING

public static final int ROUND_CEILING

See Also:

• Constant Field Values

ROUND_UP

public static final int ROUND_UP

See Also:

• Constant Field Values

ROUND_HALF_DOWN

public static final int ROUND_HALF_DOWN

See Also:

• Constant Field Values

ROUND_HALF_EVEN

public static final int ROUND_HALF_EVEN

See Also:

• Constant Field Values

ROUND_HALF_UP

public static final int ROUND_HALF_UP

See Also:

• Constant Field Values

ROUND_FLOOR

public static final int ROUND_FLOOR

See Also:

• Constant Field Values

SIGN_POSITIVE_INFINITE

public static final int SIGN_POSITIVE_INFINITE

See Also:

• Constant Field Values

SIGN_POSITIVE_ZERO

public static final int SIGN_POSITIVE_ZERO

See Also:

• Constant Field Values

SIGN_NEGATIVE_FINITE

public static final int SIGN_NEGATIVE_FINITE

See Also:

• Constant Field Values

SIGN_NaN

public static final int SIGN_NaN

See Also:

• Constant Field Values

BASE

public static final int BASE

See Also:

• Constant Field Values

ROUND_MODE

public static final int ROUND_MODE

See Also:

• Constant Field Values

SIGN_POSITIVE_FINITE

public static final int SIGN_POSITIVE_FINITE

See Also:

• Constant Field Values

SIGN_NEGATIVE_INFINITE

public static final int SIGN_NEGATIVE_INFINITE

See Also:

• Constant Field Values

SIGN_NEGATIVE_ZERO

public static final int SIGN_NEGATIVE_ZERO

See Also:

• Constant Field Values

EXCEPTION_INFINITY

public static final int EXCEPTION_INFINITY

See Also:

• Constant Field Values

EXCEPTION_OVERFLOW

public static final int EXCEPTION_OVERFLOW

See Also:

• Constant Field Values

EXCEPTION_NaN

public static final int EXCEPTION_NaN

See Also:

• Constant Field Values

EXCEPTION_UNDERFLOW

public static final int EXCEPTION_UNDERFLOW

See Also:

• Constant Field Values

EXCEPTION_ZERODIVIDE

public static final int EXCEPTION_ZERODIVIDE

See Also:

• Constant Field Values

EXCEPTION_ALL

public static final int EXCEPTION_ALL

See Also:

• Constant Field Values

Constructor Details

RubyBigDecimal

public RubyBigDecimal(Ruby runtime,
 RubyClass klass)

RubyBigDecimal

public RubyBigDecimal(Ruby runtime,
 BigDecimal value)

RubyBigDecimal

public RubyBigDecimal(Ruby runtime,
 RubyClass klass,
 BigDecimal value)

RubyBigDecimal

public RubyBigDecimal(Ruby runtime,
 BigDecimal value,
 int infinitySign)

RubyBigDecimal

public RubyBigDecimal(Ruby runtime,
 BigDecimal value,
 int infinitySign,
 int zeroSign)

RubyBigDecimal

public RubyBigDecimal(Ruby runtime,
 BigDecimal value,
 boolean isNan)

Method Details

createBigDecimal

public static RubyClass createBigDecimal(ThreadContext context)

getValue

public BigDecimal getValue()

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

_dump

public IRubyObject _dump(ThreadContext context)

_dump

public IRubyObject _dump(ThreadContext context,
 IRubyObject unused)

_load

public static RubyBigDecimal _load(ThreadContext context,
 IRubyObject recv,
 IRubyObject from)

double_fig

public static IRubyObject double_fig(ThreadContext context,
 IRubyObject recv)

limit

public static IRubyObject limit(ThreadContext context,
 IRubyObject recv)

Retrieve vpPrecLimit.

limit

public static IRubyObject limit(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg)

Set new vpPrecLimit if Fixnum and return the old value.

save_limit

public static IRubyObject save_limit(ThreadContext context,
 IRubyObject recv,
 Block block)

save_exception_mode

public static IRubyObject save_exception_mode(ThreadContext context,
 IRubyObject recv,
 Block block)

save_rounding_mode

public static IRubyObject save_rounding_mode(ThreadContext context,
 IRubyObject recv,
 Block block)

interpret_loosely

public static IRubyObject interpret_loosely(ThreadContext context,
 IRubyObject recv,
 IRubyObject str)

mode

public static IRubyObject mode(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args)

induced_from

public static IRubyObject induced_from(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg)

newInstance

@Deprecated(since="9.4.7.0")
public static RubyBigDecimal newInstance(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg)

Deprecated.

newInstance

@Deprecated(since="9.4.7.0")
public static IRubyObject newInstance(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg,
 boolean strict,
 boolean exception)

Deprecated.

newInstance

public static RubyBigDecimal newInstance(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg,
 IRubyObject mathArg)

newInstance

public static IRubyObject newInstance(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg,
 IRubyObject mathArg,
 boolean strict,
 boolean exception)

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

longHashCode

public long longHashCode()

Specified by:

longHashCode in interface SimpleHash

initialize_copy

public IRubyObject initialize_copy(ThreadContext context,
 IRubyObject original)

Description copied from class: RubyNumeric

num_init_copy

Overrides:

initialize_copy in class RubyNumeric

Parameters:

context - the thread context

original - the original

Returns:

a copy unless the same thing

op_mod

public IRubyObject op_mod(ThreadContext context,
 IRubyObject other)

remainder

public IRubyObject remainder(ThreadContext context,
 IRubyObject arg)

Description copied from class: RubyNumeric

num_remainder

Overrides:

remainder in class RubyNumeric

op_mul

public IRubyObject op_mul(ThreadContext context,
 IRubyObject arg)

mult2

public IRubyObject mult2(ThreadContext context,
 IRubyObject b,
 IRubyObject n)

op_pow

public IRubyObject op_pow(ThreadContext context,
 IRubyObject exp)

op_power

public IRubyObject op_power(ThreadContext context,
 IRubyObject exp)

op_power

public IRubyObject op_power(ThreadContext context,
 IRubyObject exp,
 IRubyObject prec)

op_plus

public IRubyObject op_plus(ThreadContext context,
 IRubyObject b)

Overrides:

op_plus in class RubyNumeric

add2

public IRubyObject add2(ThreadContext context,
 IRubyObject b,
 IRubyObject digits)

op_uplus

public IRubyObject op_uplus(ThreadContext context)

Description copied from class: RubyNumeric

num_uplus

Overrides:

op_uplus in class RubyNumeric

op_uminus

public IRubyObject op_uminus(ThreadContext context)

Description copied from class: RubyNumeric

num_uminus

Overrides:

op_uminus in class RubyNumeric

op_minus

public IRubyObject op_minus(ThreadContext context,
 IRubyObject b)

Overrides:

op_minus in class RubyNumeric

sub2

public IRubyObject sub2(ThreadContext context,
 IRubyObject b,
 IRubyObject n)

op_divide

public IRubyObject op_divide(ThreadContext context,
 IRubyObject other)

op_quo

public IRubyObject op_quo(ThreadContext context,
 IRubyObject other)

op_quo

public IRubyObject op_quo(ThreadContext context,
 IRubyObject object,
 IRubyObject digits)

op_div

public IRubyObject op_div(ThreadContext context,
 IRubyObject other)

op_div

public IRubyObject op_div(ThreadContext context,
 IRubyObject other,
 IRubyObject digits)

op_cmp

public IRubyObject op_cmp(ThreadContext context,
 IRubyObject arg)

Description copied from class: RubyNumeric

num_cmp

Overrides:

op_cmp in class RubyNumeric

eql_p

public IRubyObject eql_p(ThreadContext context,
 IRubyObject arg)

Description copied from class: RubyNumeric

num_eql

Overrides:

eql_p in class RubyNumeric

op_eqq

public IRubyObject op_eqq(ThreadContext context,
 IRubyObject arg)

Description copied from class: RubyObject

rb_equal The Ruby "===" method is used by default in case/when statements. The Object implementation first checks Java identity equality and then calls the "==" method too.

Specified by:

op_eqq in interface IRubyObject

Overrides:

op_eqq in class RubyObject

op_lt

public IRubyObject op_lt(ThreadContext context,
 IRubyObject arg)

op_le

public IRubyObject op_le(ThreadContext context,
 IRubyObject arg)

op_gt

public IRubyObject op_gt(ThreadContext context,
 IRubyObject arg)

op_ge

public IRubyObject op_ge(ThreadContext context,
 IRubyObject arg)

abs

@Deprecated(since="10.0.0.0")
public IRubyObject abs()

Deprecated.

abs

public IRubyObject abs(ThreadContext context)

Description copied from class: RubyNumeric

num_abs

Overrides:

abs in class RubyNumeric

ceil

public IRubyObject ceil(ThreadContext context,
 IRubyObject arg)

ceil

public IRubyObject ceil(ThreadContext context)

Description copied from class: RubyNumeric

MRI: num_ceil

Overrides:

ceil in class RubyNumeric

coerce

public RubyArray coerce(ThreadContext context,
 IRubyObject other)

Description copied from class: RubyNumeric

num_coerce

Overrides:

coerce in class RubyNumeric

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

getBigDecimalValue

public BigDecimal getBigDecimalValue()

multiplyWith

public RubyNumeric multiplyWith(ThreadContext context,
 RubyInteger value)

multiplyWith

public RubyNumeric multiplyWith(ThreadContext context,
 RubyFloat value)

multiplyWith

public RubyNumeric multiplyWith(ThreadContext context,
 RubyBignum value)

divmod

public IRubyObject divmod(ThreadContext context,
 IRubyObject other)

Description copied from class: RubyNumeric

num_divmod

Overrides:

divmod in class RubyNumeric

exponent

@Deprecated(since="10.0.0.0")
public IRubyObject exponent()

Deprecated.

exponent

public IRubyObject exponent(ThreadContext context)

finite_p

public IRubyObject finite_p(ThreadContext context)

Overrides:

finite_p in class RubyNumeric

finite_p

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

Deprecated.

floor

public IRubyObject floor(ThreadContext context)

Description copied from class: RubyNumeric

MRI: num_floor

Overrides:

floor in class RubyNumeric

floor

public IRubyObject floor(ThreadContext context,
 IRubyObject arg)

frac

public IRubyObject frac(ThreadContext context)

infinite_p

public IRubyObject infinite_p(ThreadContext context)

Overrides:

infinite_p in class RubyNumeric

inspect

public IRubyObject inspect(ThreadContext context)

Description copied from class: RubyBasicObject

Returns a string containing a human-readable representation of obj. If not overridden, uses the to_s method to generate the string. [ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]" Time.new.inspect #=> "Wed Apr 09 08:54:39 CDT 2003"

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

nan_p

public IRubyObject nan_p(ThreadContext context)

nonzero_p

public IRubyObject nonzero_p(ThreadContext context)

Description copied from class: RubyNumeric

num_nonzero_p

Overrides:

nonzero_p in class RubyNumeric

n_significant_digits

public IRubyObject n_significant_digits(ThreadContext context)

precision

public IRubyObject precision(ThreadContext context)

scale

public IRubyObject scale(ThreadContext context)

precision_scale

public RubyArray precision_scale(ThreadContext context)

round

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

round

public IRubyObject round(ThreadContext context,
 IRubyObject scale,
 IRubyObject mode)

sign

@Deprecated(since="10.0.0.0")
public IRubyObject sign()

Deprecated.

Use sign(ThreadContext) instead.

Returns:

sign

public IRubyObject sign(ThreadContext context)

split

public RubyArray split(ThreadContext context)

sqrt

@Deprecated(since="10.0.0.0")
public IRubyObject sqrt(IRubyObject arg)

Deprecated.

sqrt

public IRubyObject sqrt(ThreadContext context,
 IRubyObject arg)

to_f

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

Deprecated.

to_f

public IRubyObject to_f(ThreadContext context)

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

to_int

@Deprecated(since="10.0.0.0")
public final IRubyObject to_int()

Deprecated.

to_int

public IRubyObject to_int(ThreadContext context)

Description copied from class: RubyNumeric

num_to_int

Overrides:

to_int in class RubyNumeric

convertToInteger

@Deprecated(since="10.0.0.0")
public RubyInteger convertToInteger()

Deprecated.

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

to_r

public IRubyObject to_r(ThreadContext context)

formatHasLeadingPlus

public static boolean formatHasLeadingPlus(String format)

formatHasLeadingSpace

public static boolean formatHasLeadingSpace(String format)

formatHasFloatingPointNotation

public static boolean formatHasFloatingPointNotation(String format)

formatFractionalDigitGroups

public static int formatFractionalDigitGroups(String format)

isZero

public final boolean isZero(ThreadContext context)

Overrides:

isZero in class RubyNumeric

to_s

public RubyString to_s(ThreadContext context)

Overrides:

to_s in class RubyBasicObject

to_s

public RubyString to_s(ThreadContext context,
 IRubyObject arg)

toString

public String toString()

Description copied from class: RubyObject

The default toString method is just a wrapper that calls the Ruby "to_s" method.

Overrides:

toString in class RubyObject

Returns:

string representation

fix

@Deprecated(since="10.0.0.0")
public IRubyObject fix()

Deprecated.

fix

public IRubyObject fix(ThreadContext context)

truncate

public IRubyObject truncate(ThreadContext context)

Description copied from class: RubyNumeric

MRI: num_truncate

Overrides:

truncate in class RubyNumeric

truncate

public IRubyObject truncate(ThreadContext context,
 IRubyObject arg)

zero_p

public IRubyObject zero_p(ThreadContext context)

Description copied from class: RubyNumeric

num_zero_p

Overrides:

zero_p in class RubyNumeric

toJava

public <T> T toJava(Class<T> target)

Description copied from interface: IRubyObject

Convert the object to the specified Java class, if possible.

Specified by:

toJava in interface IRubyObject

Overrides:

toJava in class RubyNumeric

Type Parameters:

T - type

Parameters:

target - The target type to which the object should be converted.

Returns:

java type

See Also:

• IRubyObject.toJava(java.lang.Class<T>)

bigSqrt

public static BigDecimal bigSqrt(BigDecimal squarD,
 MathContext rootMC)

Returns the correctly rounded square root of a positive BigDecimal. This method performs the fast Square Root by Coupled Newton Iteration algorithm by Timm Ahrendt, from the book "Pi, unleashed" by Jörg Arndt in a neat loop.

The code is based on Frans Lelieveld's code , used here with permission.

Parameters:

squarD - The number to get the root from.

rootMC - Precision and rounding mode.

Returns:

the root of the argument number

Throws:

ArithmeticException - if the argument number is negative

IllegalArgumentException - if rootMC has precision 0

See Also:

• Java BigDecimal sqrt() method - Square Root by Coupled Newton Iteration