Modifier and Type	Class and Description
pack-priv static class	PyFloat.Derived Instances in Python of sub-classes of 'float', are represented in Java by instances of this class.
public static enum	PyFloat.Format
pack-priv static class	PyFloat.Formatter A `Formatter`, constructed from a `Spec`, with specific validations for `int.__format__`.

Modifier and Type	Field and Description
private static final String	CANNOT_CONVERT
pack-priv static final String	DIV_ZERO Used as error message text for division by zero.
public static volatile PyFloat.Format	double_format
private static final long	EXPONENT
private static final int	EXPONENT_BIAS
private static final int	EXPONENT_BITS
public static volatile PyFloat.Format	float_format
private static final long	IMPLIED_ONE
private static double	INT_LONG_BOUNDARY Smallest value that cannot be represented as an int
pack-priv static final String	MOD_ZERO Used as error message text for modulo zero.
pack-priv static final Double	NAN A constant Python `float("nan")`.
pack-priv static final Double	ONE A constant Python `float(1)`.
private static final long	SIGN
private static final long	SIGNIFICAND
private static final int	SIGNIFICAND_BITS
pack-priv static final InternalFormat.Spec	SPEC_REPR Format specification used by repr().
pack-priv static final InternalFormat.Spec	SPEC_STR Format specification used by str().
public static final PyType	TYPE The type `float`.
pack-priv final double	value Value of this `float` object.
pack-priv static final Double	ZERO A constant Python `float(0)`.

Access	Constructor and Description
pack-priv	PyFloat(PyType actual type type, double of the `float` value) Constructor for Python sub-class specifying `type`.
public	PyFloat(double v)
public	PyFloat(float v)

Method Summary

Modifier and Type	Method and Description
pack-priv Object	__float__()
pack-priv static final Object	__float__(Double self)
pack-priv static final Object	__format__(Object self, Object formatSpec)
pack-priv final PyTuple	__getnewargs__()
pack-priv static final PyTuple	__getnewargs__(Double self)
pack-priv final int	__hash__()
pack-priv static final int	__hash__(Double self)
pack-priv static final int	__hash__(double value)
pack-priv final Object	__int__()
pack-priv static final Object	__int__(Double self)
private static final Object	__int__(double v)
pack-priv static Object	__pow__(Object left, Object right, Object modulus)
pack-priv static final String	__repr__(Object self)
pack-priv static Object	__rpow__(Object right, Object left)
pack-priv static final String	__str__(Object self)
pack-priv final Object	__trunc__()
pack-priv static final Object	__trunc__(Double self)
pack-priv final PyTuple	as_integer_ratio()
pack-priv static final PyTuple	as_integer_ratio(Double self)
private static PyTuple	as_integer_ratio(double value)
pack-priv static double	Returns: converted value asDouble(Object to convert o) Convert the argument to a Java `double` value.
pack-priv static BigInteger	Returns: BigInteger equivalent. bigIntegerFromDouble(double to convert value) Convert a Java `double` to Java `BigInteger` by truncation.
private static OverflowError	cannotConvertInf(String to)
private static ValueError	cannotConvertNaN(String to)
pack-priv final Object	conjugate()
pack-priv static final Object	conjugate(Double self)
pack-priv static double	Returns: converted to `double` convertToDouble(Object to convert v) Convert a Python `float`, `int` or `bool` to a Java `double` (or throw `NoConversion`).
pack-priv static final PyTuple	Returns: `tuple` of `(x//y, x%y)` divmod(double operand x, double operand y) Inner method for `__divmod__` and `__rdivmod__`.
public static double	Returns: `double` value doubleValue(Object claimed `float` v) Present the value as a Java `double` when the argument is expected to be a Python `float` or a sub-class of it.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static String	float___getformat__(PyType type, String typestr)
public static void	float___setformat__(PyType type, String typestr, String format)
public static Object	float_fromhex(PyType type, Object o)
public Object	float_hex()
pack-priv static final double	Returns: `x//y` floordiv(double operand x, double operand y) Inner method for `__floordiv__` and `__rfloordiv__`.
private static String	Returns: formatted value formatDouble(double to format value, InternalFormat.Spec parsed format specification string spec) Format this float according to the specification passed in. Supports `__format__`, `__str__` and `__repr__`.
public Object	getImag()
public Object	getReal()
public double	getValue()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
pack-priv final boolean	is_integer()
pack-priv static final boolean	is_integer(Double self)
pack-priv static final boolean	is_integer(double self)
pack-priv static final double	Returns: `x%y` mod(double operand x, double operand y) Inner method for `__mod__` and `__rmod__`.
private static double	Returns: `x % y` modulo(double dividend x, double divisor y) Python % operator: y = n*x + z.
pack-priv static double	Returns: `v` nonzero(double value to check is not zero v, String for exception if `v==0.0` msg) Convenience function to throw a `ZeroDivisionError` if the argument is zero.
pack-priv static double	Returns: `v` nonzero(double value to check is not zero v) Convenience function to throw a `ZeroDivisionError` if the argument is zero.
pack-priv static double	Returns: `v ** w` pow(double base value v, double exponent w) Exponentiation with Python semantics.
private String	pyHexString(Double f)
private static boolean	Returns: if signs equal (works for signed zeros, etc.) sameSign(double a double u, double another double v) Test that two `double`s have the same sign.
public String	toString() Overrides org.python.core.AbstractPyObject.toString. Returns a string representation of the object.

Inherited from org.python.core.AbstractPyObject:: getType

Field Detail

CANNOT_CONVERT	back to summary
private static final String CANNOT_CONVERT

DIV_ZERO	back to summary
pack-priv static final String DIV_ZERO Used as error message text for division by zero.

double_format	back to summary
public static volatile PyFloat.Format double_format

EXPONENT	back to summary
private static final long EXPONENT

EXPONENT_BIAS	back to summary
private static final int EXPONENT_BIAS

EXPONENT_BITS	back to summary
private static final int EXPONENT_BITS

float_format	back to summary
public static volatile PyFloat.Format float_format

IMPLIED_ONE	back to summary
private static final long IMPLIED_ONE

INT_LONG_BOUNDARY	back to summary
private static double INT_LONG_BOUNDARY Smallest value that cannot be represented as an int

MOD_ZERO	back to summary
pack-priv static final String MOD_ZERO Used as error message text for modulo zero.

NAN	back to summary
pack-priv static final Double NAN A constant Python `float("nan")`.

ONE	back to summary
pack-priv static final Double ONE A constant Python `float(1)`.

SIGN	back to summary
private static final long SIGN

SIGNIFICAND	back to summary
private static final long SIGNIFICAND

SIGNIFICAND_BITS	back to summary
private static final int SIGNIFICAND_BITS

SPEC_REPR	back to summary
pack-priv static final InternalFormat.Spec SPEC_REPR Format specification used by repr().

SPEC_STR	back to summary
pack-priv static final InternalFormat.Spec SPEC_STR Format specification used by str().

TYPE	back to summary
public static final PyType TYPE The type `float`.

value	back to summary
pack-priv final double value Value of this `float` object.

ZERO	back to summary
pack-priv static final Double ZERO A constant Python `float(0)`.

Constructor Detail

PyFloat back to summary

PyFloat	back to summary
pack-priv PyFloat(PyType type, double value) Constructor for Python sub-class specifying `type`. Parameters type:PyType actual type value:double of the `float`

pack-priv PyFloat(PyType type, double value)

Constructor for Python sub-class specifying type.

Parameters

type:PyType: actual type
value:double: of the float

PyFloat	back to summary
public PyFloat(double v)

PyFloat	back to summary
public PyFloat(float v)

Method Detail

__float__	back to summary
pack-priv Object __float__()

__float__	back to summary
pack-priv static final Object __float__(Double self)

__format__	back to summary
pack-priv static final Object __format__(Object self, Object formatSpec)

__getnewargs__	back to summary
pack-priv final PyTuple __getnewargs__()

__getnewargs__	back to summary
pack-priv static final PyTuple __getnewargs__(Double self)

__hash__	back to summary
pack-priv final int __hash__()

__hash__	back to summary
pack-priv static final int __hash__(Double self)

__hash__	back to summary
pack-priv static final int __hash__(double value)

__int__	back to summary
pack-priv final Object __int__()

__int__	back to summary
pack-priv static final Object __int__(Double self)

__int__	back to summary
private static final Object __int__(double v)

__pow__	back to summary
pack-priv static Object __pow__(Object left, Object right, Object modulus)

__repr__	back to summary
pack-priv static final String __repr__(Object self)

__rpow__	back to summary
pack-priv static Object __rpow__(Object right, Object left)

__str__	back to summary
pack-priv static final String __str__(Object self)

__trunc__	back to summary
pack-priv final Object __trunc__()

__trunc__	back to summary
pack-priv static final Object __trunc__(Double self)

as_integer_ratio	back to summary
pack-priv final PyTuple as_integer_ratio()

as_integer_ratio	back to summary
pack-priv static final PyTuple as_integer_ratio(Double self)

as_integer_ratio	back to summary
private static PyTuple as_integer_ratio(double value)

asDouble back to summary

asDouble	back to summary
pack-priv static double asDouble(Object o) throws TypeError, Throwable Convert the argument to a Java `double` value. If `o` is not a Python `float` try the `__float__()` method, then `__index__()`. Parameters o:Object to convert Returns:double converted value Exceptions TypeError: if o cannot be interpreted as a `float` Throwable: from `__float__)` or `__index__`

pack-priv static double asDouble(Object o) throws TypeError, Throwable

Convert the argument to a Java double value. If o is not a Python float try the __float__() method, then __index__().

Parameters

o:Object: to convert

Returns:double

converted value

Exceptions

TypeError:: if o cannot be interpreted as a float
Throwable:: from __float__) or __index__

bigIntegerFromDouble back to summary

bigIntegerFromDouble	back to summary
pack-priv static BigInteger bigIntegerFromDouble(double value) throws OverflowError, ValueError Convert a Java `double` to Java `BigInteger` by truncation. Parameters value:double to convert Returns:BigInteger BigInteger equivalent. Exceptions OverflowError: when this is a floating infinity ValueError: when this is a floating NaN

pack-priv static BigInteger bigIntegerFromDouble(double value) throws OverflowError, ValueError

Convert a Java double to Java BigInteger by truncation.

Parameters

value:double: to convert

Returns:BigInteger

BigInteger equivalent.

Exceptions

OverflowError:: when this is a floating infinity
ValueError:: when this is a floating NaN

cannotConvertInf	back to summary
private static OverflowError cannotConvertInf(String to)

cannotConvertNaN	back to summary
private static ValueError cannotConvertNaN(String to)

conjugate	back to summary
pack-priv final Object conjugate()

conjugate	back to summary
pack-priv static final Object conjugate(Double self)

convertToDouble back to summary

pack-priv static double convertToDouble(Object v) throws NoConversion, OverflowError

Convert a Python float, int or bool to a Java double (or throw NoConversion). Conversion from an int may overflow.

If the method throws the special non-Python exception NoConversion, the caller must deal with it by throwing an appropriate Python exception or taking an alternative course of action. OverlowError could be allowed to propagate since it is a Python exception.

Parameters

v:Object: to convert

Returns:double

converted to double

Exceptions

NoConversion:: if v is not a float, int or bool
OverflowError:: if v is an int out of range

divmod back to summary

pack-priv static final PyTuple divmod(double x, double y)

Inner method for __divmod__ and __rdivmod__.

Parameters

x:double: operand
y:double: operand

Returns:PyTuple

tuple of (x//y, x%y)

doubleValue back to summary

public static double doubleValue(Object v) throws TypeError

Present the value as a Java double when the argument is expected to be a Python float or a sub-class of it.

Parameters

v:Object: claimed float

Returns:double

double value

Exceptions

TypeError:: if v is not a Python float

equals back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

float___getformat__	back to summary
public static String float___getformat__(PyType type, String typestr)

float___setformat__	back to summary
public static void float___setformat__(PyType type, String typestr, String format)

float_fromhex	back to summary
public static Object float_fromhex(PyType type, Object o)

float_hex	back to summary
public Object float_hex()

floordiv back to summary

pack-priv static final double floordiv(double x, double y)

Inner method for __floordiv__ and __rfloordiv__.

Parameters

x:double: operand
y:double: operand

Returns:double

x//y

formatDouble back to summary

private static String formatDouble(double value, InternalFormat.Spec spec)

Format this float according to the specification passed in. Supports __format__, __str__ and __repr__.

Parameters

value:double: to format
spec:InternalFormat.Spec: parsed format specification string

Returns:String

formatted value

getImag	back to summary
public Object getImag()

getReal	back to summary
public Object getReal()

getValue	back to summary
public double getValue()

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

is_integer	back to summary
pack-priv final boolean is_integer()

is_integer	back to summary
pack-priv static final boolean is_integer(Double self)

is_integer	back to summary
pack-priv static final boolean is_integer(double self)

mod back to summary

pack-priv static final double mod(double x, double y)

Inner method for __mod__ and __rmod__.

Parameters

x:double: operand
y:double: operand

Returns:double

x%y

modulo back to summary

private static double modulo(double x, double y)

Python % operator: y = n*x + z. The modulo operator always yields a result with the same sign as its second operand (or zero). (Compare java.Math.IEEEremainder)

Parameters

x:double: dividend
y:double: divisor

Returns:double

x % y

nonzero back to summary

pack-priv static double nonzero(double v, String msg)

Convenience function to throw a ZeroDivisionError if the argument is zero. (Java float arithmetic does not throw whatever the arguments.)

Parameters

v:double: value to check is not zero
msg:String: for exception if v==0.0

Returns:double

v

nonzero back to summary

pack-priv static double nonzero(double v)

Convenience function to throw a ZeroDivisionError if the argument is zero. (Java float arithmetic does not throw whatever the arguments.)

Parameters

v:double: value to check is not zero

Returns:double

v

pow back to summary

pack-priv static double pow(double v, double w)

Exponentiation with Python semantics.

Parameters

v:double: base value
w:double: exponent

Returns:double

v ** w

pyHexString	back to summary
private String pyHexString(Double f)

sameSign back to summary

private static boolean sameSign(double u, double v)

Test that two doubles have the same sign.

Parameters

u:double: a double
v:double: another double

Returns:boolean

if signs equal (works for signed zeros, etc.)

toString

back to summary

public String toString()

Overrides org.python.core.AbstractPyObject.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.python.core back to summary

pack-priv Class PyFloat.Derived

Class Inheritance

extends PyFloat
implements DictPyObject

All Implemented Interfaces

org.python.core.DictPyObject, org.python.core.CraftedPyObject

Instances in Python of sub-classes of 'float', are represented in Java by instances of this class.

Field Summary

Inherited from org.python.core.PyFloat:: DIV_ZERO double_format float_format MOD_ZERO NAN ONE SPEC_REPR SPEC_STR TYPE value ZERO

Constructor Summary

Access	Constructor and Description
protected	Derived(PyType subType, double value)

Method Summary

Modifier and Type	Method and Description
public Map<Object, Object>	getDict() Implements org.python.core.DictPyObject.getDict. The dictionary of the instance, (not necessarily a Python `dict` or writable.

Constructor Detail

Derived	back to summary
protected Derived(PyType subType, double value)

Method Detail

getDict back to summary

public Map<Object, Object> getDict()

Implements org.python.core.DictPyObject.getDict.

Doc from org.python.core.DictPyObject.getDict.

The dictionary of the instance, (not necessarily a Python dict or writable. If the returned Map is not writable, it should throw a Java UnsupportedOperationException on attempts to modify it.

Returns:Map<Object, Object>

a mapping to treat like a dictionary (not null).

Annotations

@Override

org.python.core back to summary

public final Enum PyFloat.Format

Class Inheritance

extends Enum<PyFloat.Format>

java.lang.Object
java.lang.Enum
org.python.core.PyFloat.Format

Field Summary

Modifier and Type	Field and Description
public static final PyFloat.Format	BE
private final String	format
public static final PyFloat.Format	LE
public static final PyFloat.Format	UNKNOWN

Constructor Summary

Access	Constructor and Description
private	Format(String format)

Method Summary

Modifier and Type	Method and Description
public String	format()
public static PyFloat.Format	valueOf(String name)
public static PyFloat.Format[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BE	back to summary
public static final PyFloat.Format BE

format	back to summary
private final String format

LE	back to summary
public static final PyFloat.Format LE

UNKNOWN	back to summary
public static final PyFloat.Format UNKNOWN

Constructor Detail

Format	back to summary
private Format(String format)

Method Detail

format	back to summary
public String format()

valueOf	back to summary
public static PyFloat.Format valueOf(String name)

values	back to summary
public static PyFloat.Format[] values()

org.python.core back to summary

pack-priv Class PyFloat.Formatter

Class Inheritance

extends FloatFormatter

java.lang.Object
org.python.core.stringlib.InternalFormat.AbstractFormatter
org.python.core.stringlib.FloatFormatter
org.python.core.PyFloat.Formatter

A Formatter, constructed from a Spec, with specific validations for int.__format__.

Field Summary

Modifier and Type	Field and Description
pack-priv final boolean	printf If `true`, give `printf`-style meanings to `Spec#type`.

Constructor Summary

Access	Constructor and Description
pack-priv	Formatter(InternalFormat.Spec a parsed format specification. spec, boolean f `true`, interpret `spec` `printf`-style, otherwise as `Formatter(Spec)` printf) Prepare a `Formatter` in support of `str.__mod__`, that is, traditional `printf`-style formatting.
pack-priv	Formatter(InternalFormat.Spec a parsed PEP-3101 format specification. spec) Prepare a `Formatter` in support of `float.`

Method Summary

Modifier and Type	Method and Description
public FloatFormatter	format(Object to format o) Implements abstract org.python.core.stringlib.InternalFormat.AbstractFormatter.format. Format an object into the buffer according to the specification with which this instance has been initialised.
private static InternalFormat.Spec	Returns: validated spec with defaults filled validated(InternalFormat.Spec to validate spec, boolean printf) Validations and defaults specific to `float`.

Inherited from org.python.core.stringlib.FloatFormatter:: append append append format format reset sectionLengths setMinFracDigits size uppercase

Field Detail

printf	back to summary
pack-priv final boolean printf If `true`, give `printf`-style meanings to `Spec#type`.

Constructor Detail

Formatter back to summary

pack-priv Formatter(InternalFormat.Spec spec, boolean printf) throws FormatError

Prepare a Formatter in support of str.__mod__, that is, traditional printf-style formatting.

Parameters

spec:InternalFormat.Spec: a parsed format specification.
printf:boolean: f true, interpret spec printf-style, otherwise as Formatter(Spec)

Exceptions

FormatError:: if an unsupported format character is encountered
FormatOverflow:: if a value is out of range (including the precision)

Formatter back to summary

pack-priv Formatter(InternalFormat.Spec spec) throws FormatError

Prepare a Formatter in support of float.__format__.

Parameters

spec:InternalFormat.Spec: a parsed PEP-3101 format specification.

Exceptions

FormatError:: if an unsupported format character is encountered
FormatOverflow:: if a value is out of range (including the precision)

Method Detail

format back to summary

public FloatFormatter format(Object o) throws NoConversion, FormatError

Implements abstract org.python.core.stringlib.InternalFormat.AbstractFormatter.format.

Doc from org.python.core.stringlib.InternalFormat.AbstractFormatter.format.

Format an object into the buffer according to the specification with which this instance has been initialised. The specific behaviour, and the acceptable types, are for a sub-class to define. Also, it is usually desirable for the return type in an implementing class to be a more specific.

Parameters

o:Object: to format

Returns:FloatFormatter

this formatter

Annotations

@Override

Exceptions

NoConversion:: if o is not convertible
FormatError:: from the process of formatting

validated back to summary

private static InternalFormat.Spec validated(InternalFormat.Spec spec, boolean printf) throws FormatError

Validations and defaults specific to float.

Parameters

spec:InternalFormat.Spec: to validate

Returns:InternalFormat.Spec

validated spec with defaults filled

Exceptions

FormatError:: on failure to validate

public Class PyFloat

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class PyFloat.Derived

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Enum PyFloat.Format

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class PyFloat.Formatter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail