note
	description: "Context constants for the Decimal Arithmetic library"
	library: "Gobo Eiffel Decimal Arithmetic Library"
	copyright: "Copyright (c) 2004-2018, Paul G. Crismer and others"
	license: "MIT License"
	date: "$Date: 2019-02-07 22:54:15 +0000 (Thu, 07 Feb 2019) $"
	revision: "$Revision: 102807 $"

class interface
	MA_DECIMAL_CONTEXT_CONSTANTS

create 
	default_create
			-- Process instances of classes with no creation clause.
			-- (Default: do nothing.)
			-- (from ANY)

feature -- Access

	Any_array_: KL_ARRAY_ROUTINES [detachable ANY]
			-- Routines that ought to be in class ARRAY
			-- (from KL_IMPORTED_ARRAY_ROUTINES)
		ensure -- from KL_IMPORTED_ARRAY_ROUTINES
			instance_free: class
			any_array_routines_not_void: Result /= Void

	Array_special_integer_: KL_ARRAY_ROUTINES [detachable SPECIAL [INTEGER_32]]
			-- Routines that ought to be in class ARRAY
			-- (from KL_IMPORTED_ARRAY_ROUTINES)
		ensure -- from KL_IMPORTED_ARRAY_ROUTINES
			instance_free: class
			special_integer_array_routines_not_void: Result /= Void

	Boolean_array_: KL_ARRAY_ROUTINES [BOOLEAN]
			-- Routines that ought to be in class ARRAY
			-- (from KL_IMPORTED_ARRAY_ROUTINES)
		ensure -- from KL_IMPORTED_ARRAY_ROUTINES
			instance_free: class
			boolean_array_routines_not_void: Result /= Void

	Detachable_string_array_routines: KL_ARRAY_ROUTINES [detachable STRING_8]
			-- Routines that ought to be in class ARRAY
			-- (from KL_IMPORTED_ARRAY_ROUTINES)
		ensure -- from KL_IMPORTED_ARRAY_ROUTINES
			instance_free: class
			detachable_string_array_routines_not_void: Result /= Void

	generating_type: TYPE [detachable MA_DECIMAL_CONTEXT_CONSTANTS]
			-- 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

	Integer_array_: KL_ARRAY_ROUTINES [INTEGER_32]
			-- Routines that ought to be in class ARRAY
			-- (from KL_IMPORTED_ARRAY_ROUTINES)
		ensure -- from KL_IMPORTED_ARRAY_ROUTINES
			instance_free: class
			integer_array_routines_not_void: Result /= Void

	String_array_: KL_ARRAY_ROUTINES [detachable STRING_8]
			-- Routines that ought to be in class ARRAY
			-- (from KL_IMPORTED_ARRAY_ROUTINES)
		ensure -- from KL_IMPORTED_ARRAY_ROUTINES
			instance_free: class
			string_array_routines_not_void: Result /= Void

	String_array_routines: KL_ARRAY_ROUTINES [STRING_8]
			-- Routines that ought to be in class ARRAY
			-- (from KL_IMPORTED_ARRAY_ROUTINES)
		ensure -- from KL_IMPORTED_ARRAY_ROUTINES
			instance_free: class
			string_array_routines_not_void: 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 (other: MA_DECIMAL_CONTEXT_CONSTANTS): 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: MA_DECIMAL_CONTEXT_CONSTANTS): BOOLEAN
			-- Is other attached to an object considered
			-- equal to current object?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			symmetric: Result implies other ~ Current
			consistent: standard_is_equal (other) implies Result

	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 (other: MA_DECIMAL_CONTEXT_CONSTANTS): 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)
	
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

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

	copy (other: MA_DECIMAL_CONTEXT_CONSTANTS)
			-- 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: MA_DECIMAL_CONTEXT_CONSTANTS)
			-- 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: MA_DECIMAL_CONTEXT_CONSTANTS
			-- 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: MA_DECIMAL_CONTEXT_CONSTANTS)
			-- 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: MA_DECIMAL_CONTEXT_CONSTANTS
			-- 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: MA_DECIMAL_CONTEXT_CONSTANTS
			-- 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

	frozen default: detachable MA_DECIMAL_CONTEXT_CONSTANTS
			-- 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
	
feature -- Constants: defaults

	Default_digits: INTEGER_32 = 9

	Default_rounding_mode: INTEGER_32
			-- Default rounding mode
		ensure
			instance_free: class
			definition: Result = Round_half_up

	Default_traps: ARRAY [INTEGER_32]
		ensure
			instance_free: class
			default_traps_not_void: Result /= Void
			has_division_by_zero: Integer_array_.has (Result, Signal_division_by_zero)
			has_invalid_operation: Integer_array_.has (Result, Signal_invalid_operation)
			has_overflow: Integer_array_.has (Result, Signal_overflow)
			has_underflow: Integer_array_.has (Result, Signal_underflow)
	
feature -- Constants: limits

	Maximum_digits: INTEGER_32 = 999999999

	Maximum_exponent: INTEGER_32 = 999999999
			-- Maximum exponent allowed

	Minimum_digits: INTEGER_32 = 1

	Minimum_exponent: INTEGER_32 = -999999999
			-- Minimum exponent allowed
	
feature -- Constants: rounding modes

	Round_ceiling: INTEGER_32 = 2
			-- Rounding mode to round to a more positive number;
			-- All discarded digits are ignored (truncated). The result is neither incremented nor decremented.

	Round_down: INTEGER_32 = 1
			-- Rounding mode to round towards zero;
			-- If any of the discarded digits are non-zero then the result should be rounded towards the next ore negative digit.

	Round_floor: INTEGER_32 = 3
			-- Rounding mode to round to a more negative number;
			-- If any of the discarded digits are non-zero then the result should be rounded towards the next more negative digit.

	Round_half_down: INTEGER_32 = 5
			-- Rounding mode to round to nearest neighbor, where an equidistant value is rounded down;
			-- If the discarded digits represent greater than half (0.5 times)
			-- the value of a one in the next position then the result should be
			-- rounded up (away from zero). Otherwise the discarded digits are ignored.

	Round_half_even: INTEGER_32 = 6
			-- Rounding mode to round to nearest neighbor, where an equidistant value is rounded to the nearest even neighbor;
			-- If the discarded digits represent greater than half (0.5 times) the value of a one in the next position then the result should be
			-- rounded up (away from zero).
			-- If they represent less than half, then the result should be rounded down.
			-- Otherwise (they represent exactly half) the result is rounded down if its rightmost digit is even, or rounded up if its
			-- rightmost digit is odd (to make an even digit).

	Round_half_up: INTEGER_32 = 4
			-- Rounding mode to round to nearest neighbor, where an equidistant value is rounded up;
			-- If the discarded digits represent greater than or equal to half (0.5 times) the value
			-- of a one in the next position then the result should be rounded up (away from zero).
			-- Otherwise the discarded digits are ignored.

	Round_unnecessary: INTEGER_32 = 7
			-- Rounding mode to assert that no rounding is necessary;
			-- Rounding (potential loss of information) is not permitted.
			-- If any of the discarded digits are non-zero then an 'ArithmeticException'should be thrown.

	Round_up: INTEGER_32 = 0
			-- Rounding mode to round away from zero;
			-- If any of the discarded digits are non-zero then the result will be rounded up (away from zero).
	
feature -- Constants: signals

	Signal_division_by_zero: INTEGER_32 = 1
			-- Non Zero dividend is divided by zero

	Signal_inexact: INTEGER_32 = 2
			-- A result is not exact, or overflows or underflows without being trapped

	Signal_invalid_operation: INTEGER_32 = 3
			-- A result would be undefined or impossible

	Signal_lost_digits: INTEGER_32 = 4
			-- Non-zero digits have been discarded before an operation

	Signal_overflow: INTEGER_32 = 5
			-- The exponent of a result is too large to be represented

	Signal_rounded: INTEGER_32 = 6
			-- A result has been rounded, that is, some zero or non-zero digits were discarded

	Signal_subnormal: INTEGER_32 = 8

	Signal_underflow: INTEGER_32 = 7
			-- The exponent of a result is too small to be represented
	
feature -- Constants: special flags

	Special_infinity: INTEGER_32 = 1

	Special_none: INTEGER_32 = 0

	Special_quiet_nan: INTEGER_32 = 3

	Special_signaling_nan: INTEGER_32 = 2
	
feature -- Constants: support

	Round_words: ARRAY [STRING_8]
			-- Textual representation of rounding modes
		ensure
			instance_free: class
			round_word_not_void: Result /= Void
			no_void_round_words: not Any_array_.has (Result, Void)

	Rounds: ARRAY [INTEGER_32]
			-- Rounding modes
		ensure
			instance_free: class
			rounds_not_void: Result /= Void

	Signal_words: ARRAY [STRING_8]
			-- Textual representation of signals
		ensure
			instance_free: class
			signal_words_not_void: Result /= Void
			no_void_signal_words: not Any_array_.has (Result, Void)

	Signals: ARRAY [INTEGER_32]
			-- Signals
		ensure
			instance_free: class
			signals_not_void: 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
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		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
		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

end -- class MA_DECIMAL_CONTEXT_CONSTANTS

Generated by ISE EiffelStudio