org.jruby

Class RubyBignum

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyNumeric

org.jruby.RubyInteger

org.jruby.RubyBignum

All Implemented Interfaces:

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

public class RubyBignum
extends RubyInteger

Author:

jpetersen

See Also:

Serialized Form

Nested Class Summary

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

RubyNumeric.InvalidIntegerException, RubyNumeric.NumberTooLargeException

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

RubyObject.Data

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

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field and Description
static BigInteger	LONG_MAX
static BigInteger	LONG_MIN
static BigInteger	ULONG_MAX

Fields inherited from class org.jruby.RubyInteger

SINGLE_CHAR_BYTELISTS19

Fields inherited from class org.jruby.RubyNumeric

DBL_EPSILON, NUMERIC_ALLOCATOR

Fields inherited from class org.jruby.RubyObject

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

Fields inherited from class org.jruby.RubyBasicObject

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

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

NULL_ARRAY

Constructor Summary

Constructors

Constructor and Description
RubyBignum(Ruby runtime, BigInteger value)

Method Summary

Methods

Modifier and Type	Method and Description
IRubyObject	abs() rb_big_abs
static double	big2dbl(RubyBignum value) rb_big2dbl
static long	big2long(RubyBignum value) rb_big2long
static long	big2ulong(RubyBignum value) rb_big2ulong This is here because for C extensions ulong can hold different values without throwing a RangeError
static RubyInteger	bignorm(Ruby runtime, BigInteger bi) rb_big_norm
IRubyObject	coerce(IRubyObject other) rb_big_coerce
int	compareTo(IRubyObject other) Compares this Ruby object with another.
static RubyClass	createBignumClass(Ruby runtime)
IRubyObject	divmod(ThreadContext context, IRubyObject other) rb_big_divmod
IRubyObject	divmod19(ThreadContext context, IRubyObject other) num_divmod
IRubyObject	eql_p(IRubyObject other) rb_big_eql
IRubyObject	eql_p19(IRubyObject other) In ruby 1.9, '==' and '===' are the same, but they differ from 'eql?'.
static BigInteger	fix2big(RubyFixnum arg) rb_int2big
BigInteger	getBigIntegerValue()
double	getDoubleValue()
int	getIntValue() Return the value of this numeric as a 32-bit long.
Class<?>	getJavaClass() Will return the Java interface that most closely can represent this object, when working through JAva integration translations.
long	getLongValue() Return the value of this numeric as a 64-bit long.
ClassIndex	getNativeClassIndex() This is overridden in the other concrete Java builtins to provide a fast way to determine what type they are.
RubyClass	getSingletonClass() rb_singleton_class Note: this method is specialized for RubyFixnum, RubySymbol, RubyNil and RubyBoolean Will either return the existing singleton class for this object, or create a new one and return that.
BigInteger	getValue() Getter for property value.
RubyFixnum	hash() rb_big_hash
static BigInteger	long2big(long arg)
static void	marshalTo(RubyBignum bignum, MarshalStream output)
static RubyBignum	newBignum(Ruby runtime, BigInteger value)
static RubyBignum	newBignum(Ruby runtime, double value)
static RubyBignum	newBignum(Ruby runtime, long value)
static RubyBignum	newBignum(Ruby runtime, String value)
IRubyObject	op_and(ThreadContext context, IRubyObject other) rb_big_and
IRubyObject	op_and19(ThreadContext context, IRubyObject other)
RubyFixnum	op_aref(IRubyObject other) rb_big_aref
IRubyObject	op_cmp(ThreadContext context, IRubyObject other) rb_big_cmp
IRubyObject	op_div(ThreadContext context, IRubyObject other) rb_big_div
IRubyObject	op_equal(IRubyObject other) rb_big_eq
IRubyObject	op_idiv(ThreadContext context, IRubyObject other) rb_big_idiv
IRubyObject	op_lshift(IRubyObject other) rb_big_lshift
IRubyObject	op_minus(ThreadContext context, IRubyObject other) rb_big_minus
IRubyObject	op_minus(ThreadContext context, long other)
IRubyObject	op_mod(ThreadContext context, IRubyObject other) rb_big_modulo
IRubyObject	op_mod19(ThreadContext context, IRubyObject other) rb_big_modulo
IRubyObject	op_mul(ThreadContext context, IRubyObject other) rb_big_mul
IRubyObject	op_mul(ThreadContext context, long other)
IRubyObject	op_mul19(ThreadContext context, IRubyObject other)
IRubyObject	op_neg() rb_big_neg
IRubyObject	op_or(ThreadContext context, IRubyObject other) rb_big_or
IRubyObject	op_or19(ThreadContext context, IRubyObject other)
IRubyObject	op_plus(ThreadContext context, IRubyObject other) rb_big_plus
IRubyObject	op_plus(ThreadContext context, long other)
IRubyObject	op_pow(ThreadContext context, IRubyObject other) rb_big_pow
IRubyObject	op_pow(ThreadContext context, long other)
IRubyObject	op_pow19(ThreadContext context, IRubyObject other) rb_big_pow
IRubyObject	op_rshift(IRubyObject other) rb_big_rshift
IRubyObject	op_uminus() rb_big_uminus
IRubyObject	op_xor(ThreadContext context, IRubyObject other) rb_big_xor
IRubyObject	op_xor19(ThreadContext context, IRubyObject other)
IRubyObject	opMulOther(ThreadContext context, IRubyObject other)
IRubyObject	quo(ThreadContext context, IRubyObject other) rb_big_quo
IRubyObject	quo19(ThreadContext context, IRubyObject other)
IRubyObject	remainder(ThreadContext context, IRubyObject other) rb_big_remainder
IRubyObject	remainder19(ThreadContext context, IRubyObject other)
IRubyObject	size() rb_big_size
IRubyObject	to_f() rb_big_to_f
IRubyObject	to_s() rb_any_to_s call-seq: obj.to_s => string Returns a string representing obj.
IRubyObject	to_s(IRubyObject arg0)
IRubyObject	to_s(IRubyObject[] args) rb_big_to_s
static RubyNumeric	unmarshalFrom(UnmarshalStream input)

Methods inherited from class org.jruby.RubyInteger

chr, chr19, chr19, convertToInteger, createIntegerClass, denominator, downto, even_p, gcd, gcdlcm, induced_from, integer_p, lcm, numerator, odd_p, ord, pred, rationalize, round, round19, round19, succ, times, timesSizeFn, to_i, to_r, toFloat, upto

Methods inherited from class org.jruby.RubyNumeric

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

Methods inherited from class org.jruby.RubyObject

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

Methods inherited from class org.jruby.RubyBasicObject

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

Methods inherited from class java.lang.Object

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

Field Detail

LONG_MAX

public static final BigInteger LONG_MAX

LONG_MIN

public static final BigInteger LONG_MIN

ULONG_MAX

public static final BigInteger ULONG_MAX

Constructor Detail

RubyBignum

public RubyBignum(Ruby runtime,
          BigInteger value)

Method Detail

createBignumClass

public static RubyClass createBignumClass(Ruby runtime)

getNativeClassIndex

public ClassIndex getNativeClassIndex()

Description copied from class: RubyObject

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

Specified by:

getNativeClassIndex in interface CoreObjectType

Overrides:

getNativeClassIndex in class RubyObject

See Also:

ClassIndex

getJavaClass

public Class<?> getJavaClass()

Description copied from class: RubyBasicObject

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

Specified by:

getJavaClass in interface IRubyObject

Overrides:

getJavaClass in class RubyBasicObject

Returns:

Class

newBignum

public static RubyBignum newBignum(Ruby runtime,
                   long value)

newBignum

public static RubyBignum newBignum(Ruby runtime,
                   double value)

newBignum

public static RubyBignum newBignum(Ruby runtime,
                   BigInteger value)

newBignum

public static RubyBignum newBignum(Ruby runtime,
                   String value)

getDoubleValue

public double getDoubleValue()

Overrides:

getDoubleValue in class RubyNumeric

getLongValue

public long getLongValue()

Description copied from class: RubyNumeric

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

Overrides:

getLongValue in class RubyNumeric

getIntValue

public int getIntValue()

Description copied from class: RubyNumeric

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

Overrides:

getIntValue in class RubyNumeric

getBigIntegerValue

public BigInteger getBigIntegerValue()

Overrides:

getBigIntegerValue in class RubyNumeric

getSingletonClass

public RubyClass getSingletonClass()

Description copied from class: RubyBasicObject

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

Specified by:

getSingletonClass in interface IRubyObject

Overrides:

getSingletonClass in class RubyBasicObject

Returns:

RubyClass

getValue

public BigInteger getValue()

Getter for property value.

Returns:

Value of property value.

bignorm

public static RubyInteger bignorm(Ruby runtime,
                  BigInteger bi)

rb_big_norm

big2long

public static long big2long(RubyBignum value)

rb_big2long

big2ulong

public static long big2ulong(RubyBignum value)

rb_big2ulong This is here because for C extensions ulong can hold different values without throwing a RangeError

big2dbl

public static double big2dbl(RubyBignum value)

rb_big2dbl

fix2big

public static BigInteger fix2big(RubyFixnum arg)

rb_int2big

long2big

public static BigInteger long2big(long arg)

to_s

public IRubyObject to_s(IRubyObject[] args)

rb_big_to_s

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 IRubyObject to_s(IRubyObject arg0)

coerce

public IRubyObject coerce(IRubyObject other)

rb_big_coerce

Overrides:

coerce in class RubyNumeric

op_uminus

public IRubyObject op_uminus()

rb_big_uminus

op_plus

public IRubyObject op_plus(ThreadContext context,
                  IRubyObject other)

rb_big_plus

op_plus

public IRubyObject op_plus(ThreadContext context,
                  long other)

op_minus

public IRubyObject op_minus(ThreadContext context,
                   IRubyObject other)

rb_big_minus

op_minus

public IRubyObject op_minus(ThreadContext context,
                   long other)

op_mul

public IRubyObject op_mul(ThreadContext context,
                 IRubyObject other)

rb_big_mul

op_mul19

public IRubyObject op_mul19(ThreadContext context,
                   IRubyObject other)

op_mul

public IRubyObject op_mul(ThreadContext context,
                 long other)

opMulOther

public IRubyObject opMulOther(ThreadContext context,
                     IRubyObject other)

op_div

public IRubyObject op_div(ThreadContext context,
                 IRubyObject other)

rb_big_div

op_idiv

public IRubyObject op_idiv(ThreadContext context,
                  IRubyObject other)

rb_big_idiv

divmod

public IRubyObject divmod(ThreadContext context,
                 IRubyObject other)

rb_big_divmod

Overrides:

divmod in class RubyNumeric

divmod19

public IRubyObject divmod19(ThreadContext context,
                   IRubyObject other)

Description copied from class: RubyNumeric

num_divmod

Overrides:

divmod19 in class RubyNumeric

op_mod

public IRubyObject op_mod(ThreadContext context,
                 IRubyObject other)

rb_big_modulo

op_mod19

public IRubyObject op_mod19(ThreadContext context,
                   IRubyObject other)

rb_big_modulo

remainder

public IRubyObject remainder(ThreadContext context,
                    IRubyObject other)

rb_big_remainder

Overrides:

remainder in class RubyNumeric

remainder19

public IRubyObject remainder19(ThreadContext context,
                      IRubyObject other)

quo

public IRubyObject quo(ThreadContext context,
              IRubyObject other)

rb_big_quo

Overrides:

quo in class RubyNumeric

quo19

public IRubyObject quo19(ThreadContext context,
                IRubyObject other)

op_pow

public IRubyObject op_pow(ThreadContext context,
                 IRubyObject other)

rb_big_pow

op_pow

public IRubyObject op_pow(ThreadContext context,
                 long other)

op_pow19

public IRubyObject op_pow19(ThreadContext context,
                   IRubyObject other)

rb_big_pow

op_and

public IRubyObject op_and(ThreadContext context,
                 IRubyObject other)

rb_big_and

op_and19

public IRubyObject op_and19(ThreadContext context,
                   IRubyObject other)

op_or

public IRubyObject op_or(ThreadContext context,
                IRubyObject other)

rb_big_or

op_or19

public IRubyObject op_or19(ThreadContext context,
                  IRubyObject other)

op_xor

public IRubyObject op_xor(ThreadContext context,
                 IRubyObject other)

rb_big_xor

op_xor19

public IRubyObject op_xor19(ThreadContext context,
                   IRubyObject other)

op_neg

public IRubyObject op_neg()

rb_big_neg

op_lshift

public IRubyObject op_lshift(IRubyObject other)

rb_big_lshift

op_rshift

public IRubyObject op_rshift(IRubyObject other)

rb_big_rshift

op_aref

public RubyFixnum op_aref(IRubyObject other)

rb_big_aref

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)

rb_big_cmp

Overrides:

op_cmp in class RubyBasicObject

op_equal

public IRubyObject op_equal(IRubyObject other)

rb_big_eq

eql_p

public IRubyObject eql_p(IRubyObject other)

rb_big_eql

Overrides:

eql_p in class RubyBasicObject

eql_p19

public IRubyObject eql_p19(IRubyObject other)

In ruby 1.9, '==' and '===' are the same, but they differ from 'eql?'.

hash

public RubyFixnum hash()

rb_big_hash

Overrides:

hash in class RubyBasicObject

to_f

public IRubyObject to_f()

rb_big_to_f

abs

public IRubyObject abs()

rb_big_abs

size

public IRubyObject size()

rb_big_size

marshalTo

public static void marshalTo(RubyBignum bignum,
             MarshalStream output)
                      throws IOException

Throws:

IOException

unmarshalFrom

public static RubyNumeric unmarshalFrom(UnmarshalStream input)
                                 throws IOException

Throws:

IOException