Automatic generation produced by ISE Eiffel
note description: "[ Tool bar items grouping algorithm. Huffman alogrithm. This class has no relationship with SD_TOOL_BAR_GROUP_INFO. Only SD_TOOL_BAR_GROUP_DIVIDER use this class. ]" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2017-04-14 10:05:46 -0800 (Fri, 14 Apr 2017) $" revision: "$Revision: 100203 $" class interface SD_HUFFMAN_ALGORITHM create make (a_max_group_count: INTEGER_32; a_items_width: like item_width) -- Create an object with a_max_group_count number of groups and a_items_width widths of items. require valid: a_max_group_count >= 0 not_void: a_items_width /= Void ensure set: max_group_count = a_max_group_count set: item_width = a_items_width feature -- Access generating_type: TYPE [detachable SD_HUFFMAN_ALGORITHM] -- 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 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: SD_HUFFMAN_ALGORITHM): 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: SD_HUFFMAN_ALGORITHM): 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 alias "≜" (other: SD_HUFFMAN_ALGORITHM): 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: SD_HUFFMAN_ALGORITHM) -- 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: SD_HUFFMAN_ALGORITHM) -- 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: SD_HUFFMAN_ALGORITHM -- 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: SD_HUFFMAN_ALGORITHM) -- 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: SD_HUFFMAN_ALGORITHM -- 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: SD_HUFFMAN_ALGORITHM -- 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 SD_HUFFMAN_ALGORITHM -- 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 -- Command set_group_count (a_group_count: INTEGER_32) -- Set `group_count` require valid: a_group_count > 0 and a_group_count <= max_group_count ensure set: a_group_count = group_count 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 feature -- Query best_grouping: ARRAYED_LIST [ARRAYED_LIST [INTEGER_32]] -- Best grouping. Integer is the group index. ensure not_void: Result /= Void right_order: is_right_order (Result) right_count: is_right_count (Result) best_grouping_when (a_group_count: INTEGER_32): ARRAYED_LIST [ARRAYED_LIST [INTEGER_32]] -- Best grouping when a_group_count require valid: a_group_count >= 1 and a_group_count <= max_group_count ensure not_void: Result /= Void valid: Result.count = a_group_count right_order: is_right_order (Result) right_count: is_right_count (Result) group_count: INTEGER_32 -- Group count is how many group excepted to divide. is_right_count (a_group_info: like best_grouping): BOOLEAN -- If a_group_info count right? require not_void: a_group_info /= Void set: item_width /= Void is_right_order (a_grouping: like best_grouping): BOOLEAN -- If a_grouping integer which indicate index of `item_width` order right? require not_void: a_grouping /= Void item_width: ARRAYED_LIST [INTEGER_32] -- Groups to be calculated. Integer is each group width. max_group_count: INTEGER_32 -- Maximum group count. maximum_group_width (a_group_count: INTEGER_32): INTEGER_32 -- Maximum width when divide group number to a_group_count. require valid: a_group_count > 0 and a_group_count <= max_group_count maximum_group_width_index (a_group_count: INTEGER_32): INTEGER_32 -- Maximum width group index when divide group number to a_group_count. require valid: a_group_count > 0 and a_group_count <= max_group_count ensure valid: Result > 0 and Result <= max_group_count invariant valid: group_count >= 1 and group_count <= max_group_count attached_item_width: attached item_width -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note library: "SmartDocking: Library of reusable components for Eiffel." copyright: "Copyright (c) 1984-2017, 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 SD_HUFFMAN_ALGORITHM -- Generated by Eiffel Studio --
For more details: eiffel.org