Automatic generation produced by ISE Eiffel
note description: "References to objects containing a double-precision real number" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2020-04-15 10:06:04 -0800 (Wed, 15 Apr 2020) $" revision: "$Revision: 104046 $" class interface REAL_64_REF create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) feature -- Access Epsilon: REAL_64 = 2.2250738585072013830903e-308 -- Minimum normalized positive floating-point number. generating_type: TYPE [detachable REAL_64_REF] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty hash_code: INTEGER_32 -- Hash code value ensure -- from HASHABLE good_hash_value: Result >= 0 item: REAL_64 -- Numeric double value Machine_epsilon: REAL_64 = 2.2204460492503130808473e-016 -- The difference between 1 and the least value greater than -- 1 that is representable in the given floating point type. Max_value: REAL_64 = 1.7976931348623157081452e+308 -- Minimum and Maximum value hold in `item`. Min_value: REAL_64 = -1.7976931348623157081452e+308 nan: REAL_64 -- Representation of not a number (NaN) ensure is_class: class negative_infinity: REAL_64 -- Representation of negative infinity ensure is_class: class one: like Current -- Neutral element for "*" and "/" ensure -- from NUMERIC result_exists: Result /= Void positive_infinity: REAL_64 -- Representation of positive infinity ensure is_class: class sign: INTEGER_32 -- Sign value (0, -1 or 1) ensure three_way: Result = three_way_comparison (zero) zero: like Current -- Neutral element for "+" and "-" ensure -- from NUMERIC result_exists: Result /= Void feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: REAL_64_REF): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: like Current): BOOLEAN -- Is other attached to an object of the same type -- as current object and identical to it? require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result ensure then -- from COMPARABLE trichotomy: Result = (not (Current < other) and not (other < Current)) is_greater alias ">" (other: REAL_64_REF): BOOLEAN -- Is current object greater than other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE definition: Result = (other < Current) is_greater_equal alias ">=" alias "≥" (other: REAL_64_REF): BOOLEAN -- Is current object greater than or equal to other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE definition: Result = (other <= Current) is_less alias "<" (other: like Current): BOOLEAN -- Is other greater than current double? require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE asymmetric: Result implies not (other < Current) is_less_equal alias "<=" alias "≤" (other: REAL_64_REF): BOOLEAN -- Is current object less than or equal to other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE definition: Result = ((Current < other) or (Current ~ other)) max alias "∨" (other: REAL_64_REF): REAL_64_REF -- The greater of current object and other -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void ensure -- from COMPARABLE current_if_not_smaller: Current >= other implies Result = Current other_if_smaller: Current < other implies Result = other min alias "∧" (other: REAL_64_REF): REAL_64_REF -- The smaller of current object and other -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void ensure -- from COMPARABLE current_if_not_greater: Current <= other implies Result = Current other_if_greater: Current > other implies Result = other frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: REAL_64_REF): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) three_way_comparison alias "⋚" (other: REAL_64_REF): INTEGER_32 -- If current object equal to other, 0; -- if smaller, -1; if greater, 1 -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void ensure -- from COMPARABLE equal_zero: (Result = 0) = (Current ~ other) smaller_negative: (Result = -1) = (Current < other) greater_positive: (Result = 1) = (Current > other) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void divisible (other: REAL_64_REF): BOOLEAN -- May current object be divided by other? require -- from NUMERIC other_exists: other /= Void ensure then not_exact_zero: Result implies (other.item /= 0.0) exponentiable (other: NUMERIC): BOOLEAN -- May current object be elevated to the power other? require -- from NUMERIC other_exists: other /= Void ensure then safe_values: ((other.conforms_to (0) and item /= 0.0) or (other.conforms_to (0.0) and item > 0.0)) implies Result is_hashable: BOOLEAN -- May current object be hashed? -- (True if it is not its type's default.) is_nan: BOOLEAN -- Is current the representation of `nan`? is_negative_infinity: BOOLEAN -- Is current the representation of `negative_infinity`? is_positive_infinity: BOOLEAN -- Is current the representation of `positive_infinity`? same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) feature -- Element change set_item (d: REAL_64) -- Make d the `item` value. feature -- Conversion ceiling: INTEGER_32 -- Smallest integral value no smaller than current object ensure result_no_smaller: Result.to_double >= item close_enough: Result.to_double - item < item.one ceiling_real_64: REAL_64 -- Smallest integral value no smaller than current object ensure result_no_smaller: Result >= item close_enough: Result - item < item.one floor: INTEGER_32 -- Greatest integral value no greater than current object ensure result_no_greater: Result.to_double <= item close_enough: item - Result.to_double < Result.one.to_double floor_real_64: REAL_64 -- Greatest integral value no greater than current object ensure result_no_greater: Result <= item close_enough: item - Result < Result.one rounded: INTEGER_32 -- Rounded integral value ensure definition: Result = sign * (abs + 0.5).floor rounded_real_64: REAL_64 -- Rounded integral value ensure definition: Result = sign.to_double * (abs + 0.5).floor_real_64 to_reference: REAL_64_REF -- Associated reference of Current ensure to_reference_not_void: Result /= Void truncated_to_integer: INTEGER_32 -- Integer part (Same sign, largest absolute -- value no greater than current object's) truncated_to_integer_64: INTEGER_64 -- Integer part (Same sign, largest absolute -- value no greater than current object's) truncated_to_real: REAL_32 -- Real part (Same sign, largest absolute -- value no greater than current object's) feature -- Duplication copy (other: REAL_64_REF) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: REAL_64_REF) -- Effect equivalent to that of: -- `copy` (other . `deep_twin`) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: REAL_64_REF -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: REAL_64_REF) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: REAL_64_REF -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: REAL_64_REF -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations abs: REAL_64 -- Absolute value ensure non_negative: Result >= 0.0 same_absolute_value: (Result = item) or (Result = - item) frozen default: detachable REAL_64_REF -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.`default` for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class identity alias "+": like Current -- Unary plus ensure -- from NUMERIC result_exists: Result /= Void minus alias "-" alias "−" (other: like Current): like Current -- Result of subtracting other require -- from NUMERIC other_exists: other /= Void ensure -- from NUMERIC result_exists: Result /= Void opposite alias "-" alias "−": like Current -- Unary minus ensure -- from NUMERIC result_exists: Result /= Void plus alias "+" (other: like Current): like Current -- Sum with other require -- from NUMERIC other_exists: other /= Void ensure -- from NUMERIC result_exists: Result /= Void commutative: Result ~ (other + Current) power alias "^" (other: REAL_64): REAL_64 -- Current double to the power other product alias "*" alias "×" (other: like Current): like Current -- Product with other require -- from NUMERIC other_exists: other /= Void ensure -- from NUMERIC result_exists: Result /= Void quotient alias "/" alias "÷" (other: like Current): like Current -- Division by other require -- from NUMERIC other_exists: other /= Void good_divisor: divisible (other) ensure -- from NUMERIC result_exists: Result /= Void feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- Printable representation of double value require -- from DEBUG_OUTPUT True require -- from ANY True ensure -- from DEBUG_OUTPUT result_not_void: Result /= Void ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void invariant sign_times_abs: not item.is_nan implies sign.to_double * abs = item -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) -- from COMPARABLE irreflexive_comparison: not (Current < Current) note copyright: "Copyright (c) 1984-2020, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class REAL_64_REF -- Generated by Eiffel Studio --
For more details: eiffel.org