Package org.jruby

Class RubyNumeric

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyNumeric

All Implemented Interfaces:

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

Direct Known Subclasses:

RubyBigDecimal, RubyComplex, RubyFloat, RubyInteger, RubyRational

public class RubyNumeric
extends RubyObject

Base class for all numerical types in ruby.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RubyNumeric.InvalidIntegerException	Deprecated.
static class	RubyNumeric.NumberTooLargeException	Deprecated.

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 double	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
RubyNumeric(RubyClass metaClass)
RubyNumeric(Ruby runtime, RubyClass metaClass)
RubyNumeric(Ruby runtime, RubyClass metaClass, boolean useObjectSpace)
RubyNumeric(Ruby runtime, RubyClass metaClass, boolean useObjectSpace, boolean canBeTainted)	Deprecated.

Method Summary

Modifier and Type	Method	Description
IRubyObject	abs(ThreadContext context)	num_abs
IRubyObject	abs2(ThreadContext context)	numeric_abs2
IRubyObject	arg(ThreadContext context)	numeric_arg
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.
RubyNumeric	asNumeric()
final IRubyObject	callCoerced(ThreadContext context, String method, IRubyObject other)
protected final IRubyObject	callCoerced(ThreadContext context, String method, IRubyObject other, boolean err)
final IRubyObject	callCoerced(ThreadContext context, CallSite site, IRubyObject other)
protected final IRubyObject	callCoerced(ThreadContext context, CallSite site, IRubyObject other, boolean err)
IRubyObject	ceil()	Deprecated.
IRubyObject	ceil(ThreadContext context)	MRI: num_ceil
static int	checkInt(Ruby runtime, long num)	check_int
static void	checkInt(IRubyObject arg, long num)
IRubyObject	coerce(IRubyObject other)	Deprecated. Use coerce(ThreadContext, IRubyObject) instead.
IRubyObject	coerce(ThreadContext context, IRubyObject other)	num_coerce
protected final IRubyObject	coerceBin(ThreadContext context, String method, IRubyObject other)	Deprecated.
protected final IRubyObject	coerceBin(ThreadContext context, CallSite site, IRubyObject other)
protected final IRubyObject	coerceBit(ThreadContext context, String method, IRubyObject other)	rb_num_coerce_bit coercion taking two arguments
protected final IRubyObject	coerceBit(ThreadContext context, JavaSites.CheckedSites site, IRubyObject other)
protected final IRubyObject	coerceCmp(ThreadContext context, String method, IRubyObject other)	Deprecated.
protected final IRubyObject	coerceCmp(ThreadContext context, CallSite site, IRubyObject other)
protected final void	coerceFailed(ThreadContext context, IRubyObject arg)	coerce_failed
protected final IRubyObject	coerceRelOp(ThreadContext context, String method, IRubyObject other)	Deprecated.
protected final IRubyObject	coerceRelOp(ThreadContext context, CallSite site, IRubyObject other)
protected final IRubyObject	coerceRescue(ThreadContext context, IRubyObject other)	coerce_rescue
protected static IRubyObject	compareWithZero(ThreadContext context, IRubyObject num, JavaSites.CheckedSites site)
IRubyObject	conjugate(ThreadContext context)	numeric_real
RubyRational	convertToRational()	Deprecated.
RubyRational	convertToRational(ThreadContext context)
static RubyClass	createNumericClass(ThreadContext context, RubyClass Object, RubyModule Comparable)
static IRubyObject	dbl_cmp(Ruby runtime, double a, double b)	rb_dbl_cmp (numeric.c)
static RubyInteger	dbl2ival(Ruby runtime, double val)	Deprecated. Use Convert.asInteger(ThreadContext, double) instead.
static IRubyObject	dbl2num(Ruby runtime, double val)	Deprecated. Use Convert.asFloat(ThreadContext, long) instead.
IRubyObject	denominator(ThreadContext context)	numeric_denominator
IRubyObject	div(ThreadContext context, IRubyObject other)	MRI: num_div
IRubyObject	divmod(ThreadContext context, IRubyObject other)	num_divmod
protected final RubyArray	doCoerce(ThreadContext context, IRubyObject other, boolean err)	do_coerce
IRubyObject	dup()	RubyMethod dup.
IRubyObject	eql_p(ThreadContext context, IRubyObject other)	num_eql
IRubyObject	fdiv(ThreadContext context, IRubyObject other)	num_fdiv
IRubyObject	finite_p(ThreadContext context)
static int	fix2int(RubyFixnum arg)	Deprecated.
static int	fix2int(IRubyObject arg)	Deprecated.
static long	fix2long(IRubyObject arg)	Deprecated. Use RubyFixnum.getValue()
static boolean	fixable(Ruby runtime, double f)
static long	float2long(RubyFloat flt)	Deprecated.
static long	float2ulong(RubyFloat flt)	Convert the given RubyFloat into an unsigned long, encoded as a signed long.
static boolean	floatStep(ThreadContext context, IRubyObject from, IRubyObject to, IRubyObject step, boolean excl, boolean allowEndless, Block block)
static double	floatStepSize(double beg, double end, double unit, boolean excludeLast)	Returns the number of unit-sized steps between the given beg and end.
IRubyObject	floor()	Deprecated.
IRubyObject	floor(ThreadContext context)	MRI: num_floor
BigInteger	getBigIntegerValue()	Deprecated.
protected final IRubyObject[]	getCoerced(ThreadContext context, IRubyObject other, boolean error)	Numeric methods.
double	getDoubleValue()	Deprecated. Use asDouble(ThreadContext) instead.
int	getIntValue()	Deprecated. Use asInt(ThreadContext) instead.
long	getLongValue()	Deprecated. Use asLong(ThreadContext) instead.
static RoundingMode	getRoundingMode(ThreadContext context, IRubyObject opts)
IRubyObject	idiv(ThreadContext context, long other)
IRubyObject	idiv(ThreadContext context, IRubyObject other)	MRI: rb_int_idiv and overrides
IRubyObject	image(ThreadContext context)	numeric_image
IRubyObject	infinite_p(ThreadContext context)
IRubyObject	initialize_copy(ThreadContext context, IRubyObject arg)	num_init_copy
static RubyNumeric	int2fix(Ruby runtime, long val)	Deprecated. Use Convert.asFixnum(ThreadContext, long) instead.
IRubyObject	integer_p()	Deprecated.
IRubyObject	integer_p(ThreadContext context)	num_int_p
static RubyNumeric	intervalStepSize(ThreadContext context, IRubyObject from, IRubyObject to, IRubyObject step, boolean excl)
boolean	isNegative()	Deprecated. Use isNegativeNumber(ThreadContext) instead.
IRubyObject	isNegative(ThreadContext context)	num_negative_p
boolean	isNegativeNumber(ThreadContext context)
boolean	isPositive()	Deprecated. Use isPositiveNumber(ThreadContext) instead.
IRubyObject	isPositive(ThreadContext context)	num_positive_p
boolean	isPositiveNumber(ThreadContext context)
boolean	isReal()
boolean	isZero()	Deprecated. Use isZero(ThreadContext) instead.
boolean	isZero(ThreadContext context)
IRubyObject	magnitude(ThreadContext context)	num_abs/1.9
IRubyObject	modulo(ThreadContext context, IRubyObject other)	num_modulo
static boolean	negativeInt(ThreadContext context, IRubyObject num)
static boolean	negFixable(double l)
static boolean	negFixable(BigInteger f)
static RubyNumeric	newNumeric(Ruby runtime)
IRubyObject	nonzero_p(ThreadContext context)	num_nonzero_p
IRubyObject	num_imaginary(ThreadContext context)	num_imaginary
static byte	num2chr(IRubyObject arg)	Deprecated.
static double	num2dbl(IRubyObject arg)	Deprecated. Use Convert.toDouble(ThreadContext, IRubyObject) instead.
static double	num2dbl(ThreadContext context, IRubyObject arg)	Deprecated. Use Convert.toDouble(ThreadContext, IRubyObject) instead.
static IRubyObject	num2fix(IRubyObject val)	Deprecated.
static IRubyObject	num2fix(ThreadContext context, IRubyObject val)	Deprecated.
static int	num2int(IRubyObject arg)	Deprecated.
static long	num2long(IRubyObject arg)	rb_num2long and FIX2LONG (numeric.c)
static long	num2ulong(IRubyObject arg)	Convert the given value into an unsigned long, encoded as a signed long.
IRubyObject	numerator(ThreadContext context)	numeric_numerator
static IRubyObject	numFuncall(ThreadContext context, IRubyObject x, CallSite site)
static IRubyObject	numFuncall(ThreadContext context, IRubyObject x, CallSite site, IRubyObject value)
IRubyObject	numRemainder(ThreadContext context, IRubyObject y)
IRubyObject	op_cmp(ThreadContext context, IRubyObject other)	num_cmp
IRubyObject	op_minus(ThreadContext context, IRubyObject other)
IRubyObject	op_not(ThreadContext context)
protected final IRubyObject	op_num_equal(ThreadContext context, IRubyObject other)	num_equal, doesn't override RubyObject.op_equal
IRubyObject	op_plus(ThreadContext context, IRubyObject other)
IRubyObject	op_uminus(ThreadContext context)	num_uminus
IRubyObject	op_uplus()	Deprecated.
IRubyObject	op_uplus(ThreadContext context)	num_uplus
IRubyObject	polar(ThreadContext context)	numeric_polar
static boolean	posFixable(double l)
static boolean	posFixable(BigInteger f)
static boolean	positiveInt(ThreadContext context, IRubyObject num)
IRubyObject	quo(ThreadContext context, IRubyObject other)	num_quo
final IRubyObject	rbClone()	RubyMethod clone.
final IRubyObject	rbClone(IRubyObject[] args)	Deprecated.
final IRubyObject	rbClone(ThreadContext context)
final IRubyObject	rbClone(ThreadContext context, IRubyObject arg)
IRubyObject	real(ThreadContext context)	numeric_real
IRubyObject	real_p(ThreadContext context)	num_real_p
IRubyObject	rect(ThreadContext context)	numeric_rect
IRubyObject	remainder(ThreadContext context, IRubyObject y)	num_remainder
IRubyObject	round()	Deprecated.
IRubyObject	round(ThreadContext context)	MRI: num_round
IRubyObject	scalar_p()	Deprecated.
static IRubyObject	singleton_method_added(ThreadContext context, IRubyObject self, IRubyObject name)	num_sadded
IRubyObject	step(ThreadContext context, IRubyObject[] args, Block block)	num_step
static RubyFloat	str2fnum(Ruby runtime, RubyString arg)	Same as RubyNumeric.str2fnum passing false for strict.
static RubyFloat	str2fnum(Ruby runtime, RubyString arg, boolean strict)
static IRubyObject	str2fnum(Ruby runtime, RubyString arg, boolean strict, boolean exception)	Converts a string representation of a floating-point number to the numeric value.
static RubyInteger	str2inum(Ruby runtime, RubyString str, int base)	Deprecated.
static RubyInteger	str2inum(Ruby runtime, RubyString str, int base, boolean strict)	Deprecated.
static IRubyObject	str2inum(Ruby runtime, RubyString str, int base, boolean strict, boolean exception)	Converts a string representation of an integer to the integer value.
IRubyObject	to_c(ThreadContext context)	numeric_to_c
IRubyObject	to_int(ThreadContext context)	num_to_int
<T> T	toJava(Class<T> target)	Convert the object to the specified Java class, if possible.
IRubyObject	truncate()	Deprecated.
IRubyObject	truncate(ThreadContext context)	MRI: num_truncate
IRubyObject	zero_p(ThreadContext context)	num_zero_p

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, dig, dig1, dig2, eqlInternal, equalInternal, equals, finishObjectClass, getNativeClassIndex, hashCode, 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, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, eql_p, equal_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, getJavaClass, getMarshalVariableList, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, 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_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, 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, singletonClass, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, 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

DBL_EPSILON

public static final double DBL_EPSILON

See Also:

• Constant Field Values

Constructor Details

RubyNumeric

public RubyNumeric(Ruby runtime,
 RubyClass metaClass)

RubyNumeric

public RubyNumeric(RubyClass metaClass)

RubyNumeric

public RubyNumeric(Ruby runtime,
 RubyClass metaClass,
 boolean useObjectSpace)

RubyNumeric

@Deprecated
public RubyNumeric(Ruby runtime,
 RubyClass metaClass,
 boolean useObjectSpace,
 boolean canBeTainted)

Deprecated.

Method Details

createNumericClass

public static RubyClass createNumericClass(ThreadContext context,
 RubyClass Object,
 RubyModule Comparable)

getRoundingMode

public static RoundingMode getRoundingMode(ThreadContext context,
 IRubyObject opts)

getLongValue

@Deprecated(since="10.0")
public long getLongValue()

Deprecated.

Use asLong(ThreadContext) instead.

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

getIntValue

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

Deprecated.

Use asInt(ThreadContext) instead.

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

asBigInteger

public BigInteger asBigInteger(ThreadContext context)

Return a BigInteger representation of this numerical value

Parameters:

context - the current thread context

Returns:

a BigInteger

asDouble

public double asDouble(ThreadContext context)

Return a double representation of this numerical value

Parameters:

context - the current thread context

Returns:

a double

asInt

public int asInt(ThreadContext context)

Returns the value of this numeric and a java int.

asLong

public long asLong(ThreadContext context)

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

getDoubleValue

@Deprecated(since="10.0")
public double getDoubleValue()

Deprecated.

Use asDouble(ThreadContext) instead.

Returns:

getBigIntegerValue

@Deprecated(since="10.0")
public BigInteger getBigIntegerValue()

Deprecated.

newNumeric

public static RubyNumeric newNumeric(Ruby runtime)

num2int

@Deprecated(since="10.0")
public static int num2int(IRubyObject arg)

Deprecated.

rb_num2int, NUM2INT if you know it is Integer use Convert.toInt(ThreadContext, IRubyObject).

checkInt

public static int checkInt(Ruby runtime,
 long num)

check_int

checkInt

public static void checkInt(IRubyObject arg,
 long num)

num2chr

@Deprecated(since="10.0")
public static byte num2chr(IRubyObject arg)

Deprecated.

NUM2CHR

num2long

public static long num2long(IRubyObject arg)

rb_num2long and FIX2LONG (numeric.c)

float2long

@Deprecated(since="10.0")
public static long float2long(RubyFloat flt)

Deprecated.

num2ulong

public static long num2ulong(IRubyObject arg)

Convert the given value into an unsigned long, encoded as a signed long. Because we can't represent an unsigned long directly in Java, callers of this code must deal with the signed long bits accordingly.

Parameters:

arg - the argument to convert

Returns:

an unsigned long encoded as a signed long, or raise an error if out of range

float2ulong

public static long float2ulong(RubyFloat flt)

Convert the given RubyFloat into an unsigned long, encoded as a signed long. Because we can't represent an unsigned long directly in Java, callers of this code must deal with the signed long bits accordingly.

Parameters:

flt - the argument to convert

Returns:

an unsigned long encoded as a signed long, or raise an error if out of range

dbl2num

@Deprecated(since="10.0")
public static IRubyObject dbl2num(Ruby runtime,
 double val)

Deprecated.

Use Convert.asFloat(ThreadContext, long) instead.

dbl2ival

@Deprecated(since="10.0")
public static RubyInteger dbl2ival(Ruby runtime,
 double val)

Deprecated.

Use Convert.asInteger(ThreadContext, double) instead.

num2dbl

@Deprecated(since="10.0")
public static double num2dbl(IRubyObject arg)

Deprecated.

Use Convert.toDouble(ThreadContext, IRubyObject) instead.

num2dbl

@Deprecated(since="10.0")
public static double num2dbl(ThreadContext context,
 IRubyObject arg)

Deprecated.

Use Convert.toDouble(ThreadContext, IRubyObject) instead.

rb_num2dbl and NUM2DBL

dbl_cmp

public static IRubyObject dbl_cmp(Ruby runtime,
 double a,
 double b)

rb_dbl_cmp (numeric.c)

fix2long

@Deprecated(since="10.0")
public static long fix2long(IRubyObject arg)

Deprecated.

Use RubyFixnum.getValue()

Parameters:

arg -

Returns:

fix2int

@Deprecated(since="10.0")
public static int fix2int(IRubyObject arg)

Deprecated.

fix2int

@Deprecated(since="10.0")
public static int fix2int(RubyFixnum arg)

Deprecated.

str2inum

@Deprecated(since="10.0")
public static RubyInteger str2inum(Ruby runtime,
 RubyString str,
 int base)

Deprecated.

int2fix

@Deprecated(since="10.0")
public static RubyNumeric int2fix(Ruby runtime,
 long val)

Deprecated.

Use Convert.asFixnum(ThreadContext, long) instead.

Parameters:

runtime -

val -

Returns:

num2fix

@Deprecated(since="10.0")
public static IRubyObject num2fix(IRubyObject val)

Deprecated.

num2fix

@Deprecated(since="10.0")
public static IRubyObject num2fix(ThreadContext context,
 IRubyObject val)

Deprecated.

str2inum

public static IRubyObject str2inum(Ruby runtime,
 RubyString str,
 int base,
 boolean strict,
 boolean exception)

Converts a string representation of an integer to the integer value. Parsing starts at the beginning of the string (after leading and trailing whitespace have been removed), and stops at the end or at the first character that can't be part of an integer. Leading signs are allowed. If base is zero, strings that begin with '0[xX]', '0[bB]', or '0' (optionally preceded by a sign) will be treated as hex, binary, or octal numbers, respectively. If a non-zero base is given, only the prefix (if any) that is appropriate to that base will be parsed correctly. For example, if the base is zero or 16, the string "0xff" will be converted to 256, but if the base is 10, it will come out as zero, since 'x' is not a valid decimal digit. If the string fails to parse as a number, zero is returned.

Parameters:

runtime - the ruby runtime

str - the string to be converted

base - the expected base of the number (for example, 2, 8, 10, 16), or 0 if the method should determine the base automatically (defaults to 10). Values 0 and 2-36 are permitted. Any other value will result in an ArgumentError.

strict - if true, enforce the strict criteria for String encoding of numeric values, as required by Integer('n'), and raise an exception when those criteria are not met. Otherwise, allow lax expression of values, as permitted by String#to_i, and return a value in almost all cases (excepting illegal radix). TODO: describe the rules/criteria

Returns:

a RubyFixnum or (if necessary) a RubyBignum representing the result of the conversion, which will be zero if the conversion failed.

str2inum

@Deprecated(since="10.0")
public static RubyInteger str2inum(Ruby runtime,
 RubyString str,
 int base,
 boolean strict)

Deprecated.

str2fnum

public static RubyFloat str2fnum(Ruby runtime,
 RubyString arg)

Same as RubyNumeric.str2fnum passing false for strict.

Parameters:

runtime - the ruby runtime

arg - the string to be converted

Returns:

a RubyFloat representing the result of the conversion, which will be 0.0 if the conversion failed.

str2fnum

public static IRubyObject str2fnum(Ruby runtime,
 RubyString arg,
 boolean strict,
 boolean exception)

Converts a string representation of a floating-point number to the numeric value. Parsing starts at the beginning of the string (after leading and trailing whitespace have been removed), and stops at the end or at the first character that can't be part of a number. If the string fails to parse as a number, 0.0 is returned.

Parameters:

runtime - the ruby runtime

arg - the string to be converted

strict - if true, enforce the strict criteria for String encoding of numeric values, as required by Float('n'), and raise an exception when those criteria are not met. Otherwise, allow lax expression of values, as permitted by String#to_f, and return a value in all cases. TODO: describe the rules/criteria

Returns:

a RubyFloat representing the result of the conversion, which will be 0.0 if the conversion failed.

str2fnum

public static RubyFloat str2fnum(Ruby runtime,
 RubyString arg,
 boolean strict)

getCoerced

protected final IRubyObject[] getCoerced(ThreadContext context,
 IRubyObject other,
 boolean error)

Numeric methods. (num_*)

callCoerced

protected final IRubyObject callCoerced(ThreadContext context,
 String method,
 IRubyObject other,
 boolean err)

callCoerced

public final IRubyObject callCoerced(ThreadContext context,
 String method,
 IRubyObject other)

callCoerced

protected final IRubyObject callCoerced(ThreadContext context,
 CallSite site,
 IRubyObject other,
 boolean err)

callCoerced

public final IRubyObject callCoerced(ThreadContext context,
 CallSite site,
 IRubyObject other)

doCoerce

protected final RubyArray doCoerce(ThreadContext context,
 IRubyObject other,
 boolean err)

do_coerce

coerceRescue

protected final IRubyObject coerceRescue(ThreadContext context,
 IRubyObject other)

coerce_rescue

coerceFailed

protected final void coerceFailed(ThreadContext context,
 IRubyObject arg)

coerce_failed

coerceBin

@Deprecated
protected final IRubyObject coerceBin(ThreadContext context,
 String method,
 IRubyObject other)

Deprecated.

rb_num_coerce_bin coercion taking two arguments

coerceBin

protected final IRubyObject coerceBin(ThreadContext context,
 CallSite site,
 IRubyObject other)

coerceBit

protected final IRubyObject coerceBit(ThreadContext context,
 String method,
 IRubyObject other)

rb_num_coerce_bit coercion taking two arguments

coerceBit

protected final IRubyObject coerceBit(ThreadContext context,
 JavaSites.CheckedSites site,
 IRubyObject other)

coerceCmp

@Deprecated
protected final IRubyObject coerceCmp(ThreadContext context,
 String method,
 IRubyObject other)

Deprecated.

rb_num_coerce_cmp coercion used for comparisons

coerceCmp

protected final IRubyObject coerceCmp(ThreadContext context,
 CallSite site,
 IRubyObject other)

coerceRelOp

@Deprecated
protected final IRubyObject coerceRelOp(ThreadContext context,
 String method,
 IRubyObject other)

Deprecated.

rb_num_coerce_relop coercion used for relative operators

coerceRelOp

protected final IRubyObject coerceRelOp(ThreadContext context,
 CallSite site,
 IRubyObject other)

asNumeric

public RubyNumeric asNumeric()

op_not

public IRubyObject op_not(ThreadContext context)

Overrides:

op_not in class RubyBasicObject

singleton_method_added

public static IRubyObject singleton_method_added(ThreadContext context,
 IRubyObject self,
 IRubyObject name)

num_sadded

initialize_copy

public IRubyObject initialize_copy(ThreadContext context,
 IRubyObject arg)

num_init_copy

Overrides:

initialize_copy in class RubyBasicObject

Parameters:

context - the thread context

arg - the original

Returns:

a copy unless the same thing

coerce

@Deprecated(since="10.0")
public IRubyObject coerce(IRubyObject other)

Deprecated.

Use coerce(ThreadContext, IRubyObject) instead.

Parameters:

other -

Returns:

coerce

public IRubyObject coerce(ThreadContext context,
 IRubyObject other)

num_coerce

op_uplus

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

Deprecated.

op_uplus

public IRubyObject op_uplus(ThreadContext context)

num_uplus

num_imaginary

public IRubyObject num_imaginary(ThreadContext context)

num_imaginary

op_uminus

public IRubyObject op_uminus(ThreadContext context)

num_uminus

op_plus

public IRubyObject op_plus(ThreadContext context,
 IRubyObject other)

op_minus

public IRubyObject op_minus(ThreadContext context,
 IRubyObject other)

op_cmp

public IRubyObject op_cmp(ThreadContext context,
 IRubyObject other)

num_cmp

Overrides:

op_cmp in class RubyBasicObject

eql_p

public IRubyObject eql_p(ThreadContext context,
 IRubyObject other)

num_eql

Overrides:

eql_p in class RubyBasicObject

quo

public IRubyObject quo(ThreadContext context,
 IRubyObject other)

num_quo

div

public IRubyObject div(ThreadContext context,
 IRubyObject other)

MRI: num_div

idiv

public IRubyObject idiv(ThreadContext context,
 IRubyObject other)

MRI: rb_int_idiv and overrides

idiv

public IRubyObject idiv(ThreadContext context,
 long other)

divmod

public IRubyObject divmod(ThreadContext context,
 IRubyObject other)

num_divmod

fdiv

public IRubyObject fdiv(ThreadContext context,
 IRubyObject other)

num_fdiv

modulo

public IRubyObject modulo(ThreadContext context,
 IRubyObject other)

num_modulo

remainder

public IRubyObject remainder(ThreadContext context,
 IRubyObject y)

num_remainder

numRemainder

public IRubyObject numRemainder(ThreadContext context,
 IRubyObject y)

positiveInt

public static boolean positiveInt(ThreadContext context,
 IRubyObject num)

negativeInt

public static boolean negativeInt(ThreadContext context,
 IRubyObject num)

abs

public IRubyObject abs(ThreadContext context)

num_abs

magnitude

public IRubyObject magnitude(ThreadContext context)

num_abs/1.9

to_int

public IRubyObject to_int(ThreadContext context)

num_to_int

real_p

public IRubyObject real_p(ThreadContext context)

num_real_p

isReal

public boolean isReal()

scalar_p

@Deprecated
public IRubyObject scalar_p()

Deprecated.

integer_p

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

Deprecated.

integer_p

public IRubyObject integer_p(ThreadContext context)

num_int_p

zero_p

public IRubyObject zero_p(ThreadContext context)

num_zero_p

isZero

@Deprecated(since="10.0")
public boolean isZero()

Deprecated.

Use isZero(ThreadContext) instead.

Returns:

isZero

public boolean isZero(ThreadContext context)

nonzero_p

public IRubyObject nonzero_p(ThreadContext context)

num_nonzero_p

floor

public IRubyObject floor(ThreadContext context)

MRI: num_floor

ceil

public IRubyObject ceil(ThreadContext context)

MRI: num_ceil

round

public IRubyObject round(ThreadContext context)

MRI: num_round

truncate

public IRubyObject truncate(ThreadContext context)

MRI: num_truncate

step

public IRubyObject step(ThreadContext context,
 IRubyObject[] args,
 Block block)

num_step

intervalStepSize

public static RubyNumeric intervalStepSize(ThreadContext context,
 IRubyObject from,
 IRubyObject to,
 IRubyObject step,
 boolean excl)

floatStep

public static boolean floatStep(ThreadContext context,
 IRubyObject from,
 IRubyObject to,
 IRubyObject step,
 boolean excl,
 boolean allowEndless,
 Block block)

floatStepSize

public static double floatStepSize(double beg,
 double end,
 double unit,
 boolean excludeLast)

Returns the number of unit-sized steps between the given beg and end. NOTE: the returned value is either Double.POSITIVE_INFINITY, or a rounded value appropriate to be cast to a long MRI: ruby_float_step_size

op_num_equal

protected final IRubyObject op_num_equal(ThreadContext context,
 IRubyObject other)

num_equal, doesn't override RubyObject.op_equal

numerator

public IRubyObject numerator(ThreadContext context)

numeric_numerator

denominator

public IRubyObject denominator(ThreadContext context)

numeric_denominator

convertToRational

@Deprecated(since="10.0")
public RubyRational convertToRational()

Deprecated.

convertToRational

public RubyRational convertToRational(ThreadContext context)

to_c

public IRubyObject to_c(ThreadContext context)

numeric_to_c

real

public IRubyObject real(ThreadContext context)

numeric_real

image

public IRubyObject image(ThreadContext context)

numeric_image

abs2

public IRubyObject abs2(ThreadContext context)

numeric_abs2

arg

public IRubyObject arg(ThreadContext context)

numeric_arg

rect

public IRubyObject rect(ThreadContext context)

numeric_rect

polar

public IRubyObject polar(ThreadContext context)

numeric_polar

conjugate

public IRubyObject conjugate(ThreadContext context)

numeric_real

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 RubyBasicObject

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

isNegative

public IRubyObject isNegative(ThreadContext context)

num_negative_p

isPositive

public IRubyObject isPositive(ThreadContext context)

num_positive_p

isNegative

@Deprecated(since="10.0")
public boolean isNegative()

Deprecated.

Use isNegativeNumber(ThreadContext) instead.

Returns:

isNegativeNumber

public boolean isNegativeNumber(ThreadContext context)

isPositive

@Deprecated(since="10.0")
public boolean isPositive()

Deprecated.

Use isPositiveNumber(ThreadContext) instead.

Returns:

isPositiveNumber

public boolean isPositiveNumber(ThreadContext context)

compareWithZero

protected static IRubyObject compareWithZero(ThreadContext context,
 IRubyObject num,
 JavaSites.CheckedSites site)

finite_p

public IRubyObject finite_p(ThreadContext context)

infinite_p

public IRubyObject infinite_p(ThreadContext context)

rbClone

@Deprecated
public final IRubyObject rbClone(IRubyObject[] args)

Deprecated.

rbClone

public final IRubyObject rbClone(ThreadContext context)

rbClone

public final IRubyObject rbClone(ThreadContext context,
 IRubyObject arg)

Overrides:

rbClone in class RubyBasicObject

rbClone

public final IRubyObject rbClone()

Description copied from interface: IRubyObject

RubyMethod clone.

Specified by:

rbClone in interface IRubyObject

Overrides:

rbClone in class RubyBasicObject

Returns:

a cloned object

dup

public IRubyObject dup()

Description copied from interface: IRubyObject

RubyMethod dup.

Specified by:

dup in interface IRubyObject

Overrides:

dup in class RubyBasicObject

Returns:

a dup-ed object

numFuncall

public static IRubyObject numFuncall(ThreadContext context,
 IRubyObject x,
 CallSite site)

numFuncall

public static IRubyObject numFuncall(ThreadContext context,
 IRubyObject x,
 CallSite site,
 IRubyObject value)

fixable

public static boolean fixable(Ruby runtime,
 double f)

posFixable

public static boolean posFixable(BigInteger f)

negFixable

public static boolean negFixable(BigInteger f)

posFixable

public static boolean posFixable(double l)

negFixable

public static boolean negFixable(double l)

floor

@Deprecated
public IRubyObject floor()

Deprecated.

ceil

@Deprecated
public IRubyObject ceil()

Deprecated.

round

@Deprecated
public IRubyObject round()

Deprecated.

truncate

@Deprecated
public IRubyObject truncate()

Deprecated.

num_truncate