RubyBigDecimal (JRuby Core 9.2.0.0 API)

java.lang.Object
- org.jruby.RubyBasicObject
- - org.jruby.RubyObject
  - - org.jruby.RubyNumeric
    - - org.jruby.ext.bigdecimal.RubyBigDecimal

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType
```
public class RubyBigDecimal
extends RubyNumeric
```
Author:

Ola Bini

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RubyBigDecimal.BigDecimalKernelMethods
- 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`RubyBigDecimal.BigDecimalKernelMethods`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BASE`
`static int`	`EXCEPTION_ALL`
`static int`	`EXCEPTION_INFINITY`
`static int`	`EXCEPTION_NaN`
`static int`	`EXCEPTION_OVERFLOW`
`static int`	`EXCEPTION_UNDERFLOW`
`static int`	`EXCEPTION_ZERODIVIDE`
`static int`	`ROUND_CEILING`
`static int`	`ROUND_DOWN`
`static int`	`ROUND_FLOOR`
`static int`	`ROUND_HALF_DOWN`
`static int`	`ROUND_HALF_EVEN`
`static int`	`ROUND_HALF_UP`
`static int`	`ROUND_MODE`
`static int`	`ROUND_UP`
`static int`	`SIGN_NaN`
`static int`	`SIGN_NEGATIVE_FINITE`
`static int`	`SIGN_NEGATIVE_INFINITE`
`static int`	`SIGN_NEGATIVE_ZERO`
`static int`	`SIGN_POSITIVE_FINITE`
`static int`	`SIGN_POSITIVE_INFINITE`
`static int`	`SIGN_POSITIVE_ZERO`

Fields inherited from class org.jruby.RubyNumeric
DBL_EPSILON, NUMERIC_ALLOCATOR

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, 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
`RubyBigDecimal(Ruby runtime, java.math.BigDecimal value)`
`RubyBigDecimal(Ruby runtime, java.math.BigDecimal value, boolean isNan)`
`RubyBigDecimal(Ruby runtime, java.math.BigDecimal value, int infinitySign)`
`RubyBigDecimal(Ruby runtime, java.math.BigDecimal value, int infinitySign, int zeroSign)`
`RubyBigDecimal(Ruby runtime, RubyBigDecimal rbd)` Deprecated.
`RubyBigDecimal(Ruby runtime, RubyClass klass)`
`RubyBigDecimal(Ruby runtime, RubyClass klass, java.math.BigDecimal value)`
`RubyBigDecimal(Ruby runtime, RubyClass klass, RubyBigDecimal rbd)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`IRubyObject`	`_dump(ThreadContext context)`
`IRubyObject`	`_dump(ThreadContext context, IRubyObject unused)`
`static RubyBigDecimal`	`_load(ThreadContext context, IRubyObject recv, IRubyObject from)`
`IRubyObject`	`abs()`
`IRubyObject`	`add2(ThreadContext context, IRubyObject b, IRubyObject digits)`
`IRubyObject`	`add219(ThreadContext context, IRubyObject b, IRubyObject digits)` Deprecated.
`static java.math.BigDecimal`	`bigSqrt(java.math.BigDecimal squarD, java.math.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)`
`IRubyObject`	`coerce(IRubyObject other)` num_coerce
`RubyArray`	`coerce(ThreadContext context, IRubyObject other)`
`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`	`createBigDecimal(Ruby runtime)`
`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()`
`IRubyObject`	`finite_p()`
`IRubyObject`	`fix()`
`IRubyObject`	`floor(ThreadContext context)` MRI: num_floor
`IRubyObject`	`floor(ThreadContext context, IRubyObject arg)`
`static int`	`formatFractionalDigitGroups(java.lang.String format)`
`static boolean`	`formatHasFloatingPointNotation(java.lang.String format)`
`static boolean`	`formatHasLeadingPlus(java.lang.String format)`
`static boolean`	`formatHasLeadingSpace(java.lang.String format)`
`IRubyObject`	`frac(ThreadContext context)`
`java.math.BigDecimal`	`getBigDecimalValue()`
`java.math.BigInteger`	`getBigIntegerValue()`
`double`	`getDoubleValue()`
`int`	`getIntValue()` Return the value of this numeric as a 32-bit long.
`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.
`java.math.BigDecimal`	`getValue()`
`RubyFixnum`	`hash()` rb_obj_id Will return the hash code of this object.
`static IRubyObject`	`induced_from(ThreadContext context, IRubyObject recv, IRubyObject arg)`
`IRubyObject`	`infinite_p(ThreadContext context)`
`IRubyObject`	`initialize_copy(IRubyObject original)` num_init_copy
`IRubyObject`	`inspect(ThreadContext context)`
`boolean`	`isZero()`
`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.
`static IRubyObject`	`mode(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`IRubyObject`	`mult2(ThreadContext context, IRubyObject b, IRubyObject n)`
`IRubyObject`	`mult219(ThreadContext context, IRubyObject b, IRubyObject n)` Deprecated.
`RubyNumeric`	`multiplyWith(ThreadContext context, RubyBignum value)`
`RubyNumeric`	`multiplyWith(ThreadContext context, RubyFloat value)`
`RubyNumeric`	`multiplyWith(ThreadContext context, RubyInteger value)`
`IRubyObject`	`nan_p(ThreadContext context)`
`static RubyBigDecimal`	`new_(ThreadContext context, IRubyObject recv, IRubyObject arg)` Deprecated.
`static RubyBigDecimal`	`new_(ThreadContext context, IRubyObject recv, IRubyObject arg, IRubyObject mathArg)` Deprecated.
`static RubyBigDecimal`	`newInstance(IRubyObject recv, IRubyObject[] args)` Deprecated.
`static RubyBigDecimal`	`newInstance(ThreadContext context, IRubyObject recv, IRubyObject arg)`
`static RubyBigDecimal`	`newInstance(ThreadContext context, IRubyObject recv, IRubyObject arg, IRubyObject mathArg)`
`IRubyObject`	`nonzero_p()` Deprecated.
`IRubyObject`	`nonzero_p(ThreadContext context)` num_nonzero_p
`IRubyObject`	`op_cmp(ThreadContext context, IRubyObject arg)`
`IRubyObject`	`op_div(ThreadContext context, IRubyObject other)`
`IRubyObject`	`op_div(ThreadContext context, IRubyObject other, IRubyObject digits)`
`IRubyObject`	`op_div19(ThreadContext context, IRubyObject r)` Deprecated.
`IRubyObject`	`op_div19(ThreadContext context, IRubyObject other, IRubyObject digits)` Deprecated.
`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_minus19(ThreadContext context, IRubyObject b)` Deprecated.
`IRubyObject`	`op_mod(ThreadContext context, IRubyObject other)`
`IRubyObject`	`op_mod19(ThreadContext context, IRubyObject arg)` Deprecated.
`IRubyObject`	`op_mul(ThreadContext context, IRubyObject arg)`
`IRubyObject`	`op_mul19(ThreadContext context, IRubyObject arg)` Deprecated.
`IRubyObject`	`op_plus(ThreadContext context, IRubyObject b)`
`IRubyObject`	`op_plus19(ThreadContext context, IRubyObject b)` Deprecated.
`IRubyObject`	`op_pow(IRubyObject arg)` Deprecated.
`RubyBigDecimal`	`op_pow(ThreadContext context, IRubyObject exp)`
`IRubyObject`	`op_pow19(IRubyObject exp)` Deprecated.
`RubyBigDecimal`	`op_pow19(ThreadContext context, IRubyObject exp)` Deprecated.
`IRubyObject`	`op_quo(ThreadContext context, IRubyObject other)`
`IRubyObject`	`op_quo19(ThreadContext context, IRubyObject other)` Deprecated.
`IRubyObject`	`op_quo20(ThreadContext context, IRubyObject other)` Deprecated.
`IRubyObject`	`op_uminus(ThreadContext context)` num_uminus
`IRubyObject`	`op_uplus()` num_uplus
`IRubyObject`	`precs(ThreadContext context)`
`IRubyObject`	`remainder(ThreadContext context, IRubyObject arg)` num_remainder
`IRubyObject`	`remainder19(ThreadContext context, IRubyObject arg)` Deprecated.
`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`	`sign()`
`RubyArray`	`split(ThreadContext context)`
`IRubyObject`	`sqrt(IRubyObject arg)`
`IRubyObject`	`sub2(ThreadContext context, IRubyObject b, IRubyObject n)`
`IRubyObject`	`sub219(ThreadContext context, IRubyObject b, IRubyObject n)` Deprecated.
`IRubyObject`	`to_f()`
`IRubyObject`	`to_int()`
`IRubyObject`	`to_int(ThreadContext context)` num_to_int
`IRubyObject`	`to_int19()` Deprecated.
`IRubyObject`	`to_r(ThreadContext context)`
`IRubyObject`	`to_s()` rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj.
`IRubyObject`	`to_s(IRubyObject[] args)` Deprecated.
`RubyString`	`to_s(ThreadContext context)`
`RubyString`	`to_s(ThreadContext context, IRubyObject arg)`
`<T> T`	`toJava(java.lang.Class<T> target)` Convert the object to the specified Java class, if possible.
`java.lang.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)`
`static IRubyObject`	`ver(ThreadContext context, IRubyObject recv)`
`IRubyObject`	`zero_p()` Deprecated.
`IRubyObject`	`zero_p(ThreadContext context)` num_zero_p

Methods inherited from class org.jruby.RubyNumeric
abs, abs2, arg, asNumeric, callCoerced, callCoerced, callCoerced, callCoerced, ceil, checkInt, checkInt, coerceBin, coerceBin, coerceBit, coerceBit, coerceBody, coerceCmp, coerceCmp, coerceFailed, coerceRelOp, coerceRelOp, coerceRescue, compareWithZero, conjugate, convertToRational, createNumericClass, dbl_cmp, dbl2ival, dbl2num, denominator, div, div19, divmod19, doCoerce, dup, fdiv, finite_p, fix2int, fix2int, fix2long, fixable, float2long, floatStepSize, floor, getCoerced, getRoundingMode, idiv, idiv, image, int2fix, integer_p, intervalStepSize, isNegative, isNegative, isPositive, isPositive, isReal, magnitude, modulo, modulo19, negativeInt, negFixable, negFixable, newNumeric, num_imaginary, num2chr, num2dbl, num2fix, num2int, num2long, numerator, numFuncall, numFuncall, numRemainder, op_cmp, op_not, op_num_equal, polar, posFixable, posFixable, positiveInt, quo_19, quo, rbClone, real_p, real, rect, round, round, scalar_p, singleton_method_added, step, str2fnum, str2fnum, str2fnum19, str2inum, str2inum, to_c, truncate

Methods inherited from class org.jruby.RubyObject
attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, dig, eqlInternal, equalInternal, equals, hashCode, inspect, puts, specificEval, toRubyString

Methods inherited from class org.jruby.RubyBasicObject
addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToHash, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, ensureInstanceVariablesSettable, eql_p, 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, getJavaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize, 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, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing, method_missing19, method, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_equal_19, op_equal, op_match, op_match19, op_not_equal, op_not_match, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, 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_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_method, 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, 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

Field Detail
- 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 Detail

RubyBigDecimal

public RubyBigDecimal(Ruby runtime,
                      RubyClass klass)

RubyBigDecimal

public RubyBigDecimal(Ruby runtime,
                      java.math.BigDecimal value)

RubyBigDecimal

public RubyBigDecimal(Ruby runtime,
                      RubyClass klass,
                      java.math.BigDecimal value)

RubyBigDecimal

public RubyBigDecimal(Ruby runtime,
                      java.math.BigDecimal value,
                      int infinitySign)

RubyBigDecimal

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

RubyBigDecimal

public RubyBigDecimal(Ruby runtime,
                      java.math.BigDecimal value,
                      boolean isNan)

RubyBigDecimal

@Deprecated
public RubyBigDecimal(Ruby runtime,
                                  RubyBigDecimal rbd)

Deprecated.

RubyBigDecimal

@Deprecated
public RubyBigDecimal(Ruby runtime,
                                  RubyClass klass,
                                  RubyBigDecimal rbd)

Deprecated.

Method Detail

createBigDecimal

public static RubyClass createBigDecimal(Ruby runtime)

getValue

public java.math.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

See Also:

ClassIndex

ver

public static IRubyObject ver(ThreadContext context,
                              IRubyObject recv)

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

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
public static RubyBigDecimal newInstance(IRubyObject recv,
                                                     IRubyObject[] args)

Deprecated.

new_

@Deprecated
public static RubyBigDecimal new_(ThreadContext context,
                                              IRubyObject recv,
                                              IRubyObject arg)

Deprecated.

new_

@Deprecated
public static RubyBigDecimal new_(ThreadContext context,
                                              IRubyObject recv,
                                              IRubyObject arg,
                                              IRubyObject mathArg)

Deprecated.

newInstance

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

newInstance

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

hash
```
public RubyFixnum hash()
```
Description copied from class: RubyBasicObject

rb_obj_id 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

initialize_copy
```
public IRubyObject initialize_copy(IRubyObject original)
```
Description copied from class: RubyNumeric

num_init_copy

Overrides:

initialize_copy in class RubyNumeric

op_mod

public IRubyObject op_mod(ThreadContext context,
                          IRubyObject other)

op_mod19

@Deprecated
public IRubyObject op_mod19(ThreadContext context,
                                        IRubyObject arg)

Deprecated.

remainder

public IRubyObject remainder(ThreadContext context,
                             IRubyObject arg)

Description copied from class: RubyNumeric

num_remainder

Overrides:: remainder in class RubyNumeric

remainder19

@Deprecated
public IRubyObject remainder19(ThreadContext context,
                                           IRubyObject arg)

Deprecated.

op_mul

public IRubyObject op_mul(ThreadContext context,
                          IRubyObject arg)

op_mul19

@Deprecated
public IRubyObject op_mul19(ThreadContext context,
                                        IRubyObject arg)

Deprecated.

mult2

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

mult219

@Deprecated
public IRubyObject mult219(ThreadContext context,
                                       IRubyObject b,
                                       IRubyObject n)

Deprecated.

op_pow

@Deprecated
public IRubyObject op_pow(IRubyObject arg)

Deprecated.

op_pow

public RubyBigDecimal op_pow(ThreadContext context,
                             IRubyObject exp)

op_pow19

@Deprecated
public IRubyObject op_pow19(IRubyObject exp)

Deprecated.

op_pow19

@Deprecated
public RubyBigDecimal op_pow19(ThreadContext context,
                                           IRubyObject exp)

Deprecated.

op_plus

public IRubyObject op_plus(ThreadContext context,
                           IRubyObject b)

Overrides:: op_plus in class RubyNumeric

op_plus19

@Deprecated
public IRubyObject op_plus19(ThreadContext context,
                                         IRubyObject b)

Deprecated.

add2

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

add219

@Deprecated
public IRubyObject add219(ThreadContext context,
                                      IRubyObject b,
                                      IRubyObject digits)

Deprecated.

op_uplus
```
public IRubyObject op_uplus()
```
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)

op_minus19

@Deprecated
public IRubyObject op_minus19(ThreadContext context,
                                          IRubyObject b)

Deprecated.

sub2

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

sub219

@Deprecated
public IRubyObject sub219(ThreadContext context,
                                      IRubyObject b,
                                      IRubyObject n)

Deprecated.

op_quo

public IRubyObject op_quo(ThreadContext context,
                          IRubyObject other)

op_quo19

@Deprecated
public IRubyObject op_quo19(ThreadContext context,
                                        IRubyObject other)

Deprecated.

op_quo20

@Deprecated
public IRubyObject op_quo20(ThreadContext context,
                                        IRubyObject other)

Deprecated.

op_div

public IRubyObject op_div(ThreadContext context,
                          IRubyObject other)

op_div

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

op_div19

@Deprecated
public final IRubyObject op_div19(ThreadContext context,
                                              IRubyObject r)

Deprecated.

op_div19

@Deprecated
public final IRubyObject op_div19(ThreadContext context,
                                              IRubyObject other,
                                              IRubyObject digits)

Deprecated.

op_cmp

public IRubyObject op_cmp(ThreadContext context,
                          IRubyObject arg)

Overrides:: op_cmp in class RubyBasicObject

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
```
public IRubyObject abs()
```

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 IRubyObject coerce(IRubyObject other)
```
Description copied from class: RubyNumeric

num_coerce

Overrides:

coerce in class RubyNumeric

coerce

public RubyArray coerce(ThreadContext context,
                        IRubyObject other)

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 java.math.BigInteger getBigIntegerValue()
```
Overrides:

getBigIntegerValue in class RubyNumeric

getBigDecimalValue

public java.math.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
```
public IRubyObject exponent()
```

finite_p
```
public IRubyObject finite_p()
```

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)

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

nonzero_p

@Deprecated
public IRubyObject nonzero_p()

Deprecated.

precs

public IRubyObject precs(ThreadContext context)

round

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

round

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

sign
```
public IRubyObject sign()
```

split

public RubyArray split(ThreadContext context)

sqrt

public IRubyObject sqrt(IRubyObject arg)

to_f
```
public IRubyObject to_f()
```

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
```
public final IRubyObject to_int()
```

to_int
```
public IRubyObject to_int(ThreadContext context)
```
Description copied from class: RubyNumeric

num_to_int

Overrides:

to_int in class RubyNumeric

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

to_r

public IRubyObject to_r(ThreadContext context)

to_int19

@Deprecated
public IRubyObject to_int19()

Deprecated.

formatHasLeadingPlus

public static boolean formatHasLeadingPlus(java.lang.String format)

formatHasLeadingSpace

public static boolean formatHasLeadingSpace(java.lang.String format)

formatHasFloatingPointNotation

public static boolean formatHasFloatingPointNotation(java.lang.String format)

formatFractionalDigitGroups

public static int formatFractionalDigitGroups(java.lang.String format)

isZero
```
public final boolean isZero()
```
Overrides:

isZero in class RubyNumeric

to_s
```
public IRubyObject to_s()
```
Description copied from class: RubyBasicObject

rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj. The default to_s prints the object's class and an encoding of the object id. As a special case, the top-level object that is the initial execution context of Ruby programs returns ``main.''

Overrides:

to_s in class RubyBasicObject

to_s

public RubyString to_s(ThreadContext context)

to_s

public RubyString to_s(ThreadContext context,
                       IRubyObject arg)

toString
```
public java.lang.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

to_s

@Deprecated
public IRubyObject to_s(IRubyObject[] args)

Deprecated.

fix
```
public IRubyObject fix()
```

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

zero_p

@Deprecated
public IRubyObject zero_p()

Deprecated.

toJava
```
public <T> T toJava(java.lang.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

Parameters:

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

See Also:

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

bigSqrt
```
public static java.math.BigDecimal bigSqrt(java.math.BigDecimal squarD,
                                           java.math.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:

java.lang.ArithmeticException - if the argument number is negative

java.lang.IllegalArgumentException - if rootMC has precision 0

Class RubyBigDecimal

Nested Class Summary

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

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

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

Field Summary

Fields inherited from class org.jruby.RubyNumeric

Fields inherited from class org.jruby.RubyObject

Fields inherited from class org.jruby.RubyBasicObject

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

Constructor Summary

Method Summary

Methods inherited from class org.jruby.RubyNumeric

Methods inherited from class org.jruby.RubyObject

Methods inherited from class org.jruby.RubyBasicObject

Methods inherited from class java.lang.Object

Field Detail

ROUND_DOWN

ROUND_CEILING

ROUND_UP

ROUND_HALF_DOWN

ROUND_HALF_EVEN

ROUND_HALF_UP

ROUND_FLOOR

SIGN_POSITIVE_INFINITE

SIGN_POSITIVE_ZERO

SIGN_NEGATIVE_FINITE

SIGN_NaN

BASE

ROUND_MODE

SIGN_POSITIVE_FINITE

SIGN_NEGATIVE_INFINITE

SIGN_NEGATIVE_ZERO

EXCEPTION_INFINITY

EXCEPTION_OVERFLOW

EXCEPTION_NaN

EXCEPTION_UNDERFLOW

EXCEPTION_ZERODIVIDE

EXCEPTION_ALL

Constructor Detail

RubyBigDecimal

RubyBigDecimal

RubyBigDecimal

RubyBigDecimal

RubyBigDecimal

RubyBigDecimal

RubyBigDecimal

RubyBigDecimal

Method Detail

createBigDecimal

getValue

getNativeClassIndex

ver

_dump

_dump

_load

double_fig

limit

limit

save_limit

save_exception_mode

save_rounding_mode

mode

induced_from

newInstance

new_

new_

newInstance

newInstance

hash

initialize_copy

op_mod

op_mod19

remainder

remainder19

op_mul

op_mul19

mult2

mult219

op_pow