1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
|
<!DOCTYPE HTML SYSTEM>
<!-- Generated by Lisaac shorter / html style -->
<html>
<head>
<title>
Lisaac prototype interface
</title>
</head>
<body BGCOLOR="#FFFFFF">
<br><br><strong><font color="#A020F0">Section</font></strong> <strong><font color="#A020F0">Header</font></strong>
<br><br><strong><font color="#FF0000">    +</font></strong> <strong><font color="#0000FF">name</font></strong> := <a href="COLLECTION2.html"><font color="#008000">COLLECTION2</font></a>[<font color="#008000">E</font>];
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">comment</font></strong> := <font color="#BC8F8F">"Abstract definition of a 2 dimensional collection of elements of type E."</font>;
<br><font FACE="Sans-serif" color="#000000"><B> The Lisaac standard library provides two implementations of COLLECTION2: </B></font>
<br><font FACE="Sans-serif" color="#000000"><B> ARRAY2 and FAST_ARRAY2.</B></font>
<br><font FACE="Sans-serif" color="#000000"><B> All implementations have exactly the same behavior. Switching from one implementation to</B></font>
<br><font FACE="Sans-serif" color="#000000"><B> another only change the memory used and the execution time.</B></font>
<br><br><strong><font color="#A020F0">Section</font></strong> <strong><font color="#A020F0">Inherit</font></strong>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">parent_safe_equal</font></strong>:<a href="SAFE_EQUAL.html"><font color="#008000">SAFE_EQUAL</font></a>[<font color="#008000">E</font>] :=
<br><br><strong><font color="#A020F0">Section</font></strong> <strong><font color="#A020F0">Public</font></strong>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><font FACE="Sans-serif" color="#000000"><B> Indexing:</B></font>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">lower1</font></strong>:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        First Lower index bounds.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">lower2</font></strong> :<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Second Lower index bounds.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">line_minimum</font></strong>:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Equivalent of `lower1'.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">column_minimum</font></strong>:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Equivalent of `lower2'.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">upper1</font></strong>:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        First Upper index bounds.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">upper2</font></strong> :<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Second Upper index bounds.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">line_maximum</font></strong>:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Equivalent of `upper1'.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">column_maximum</font></strong>:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Equivalent of `upper2'.</font></strong></em>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><font FACE="Sans-serif" color="#000000"><B> Reading:</B></font>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">item</font></strong> (line, column:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a>) :<font color="#008000">E</font> <-
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><font FACE="Sans-serif" color="#000000"><B> Writing:</B></font>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">put</font></strong> element:<font color="#008000">E</font> <strong><font color="#0000FF">to</font></strong> (line, column:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a>) <-
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">force</font></strong> element:<font color="#008000">E</font> <strong><font color="#0000FF">to</font></strong> (line, column:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a>) <-
<br><em><strong><font color="#707070">        Put `element' at position (`line',`column'). Collection is</font></strong></em>
<br><em><strong><font color="#707070">        resized first when (`line',`column') is not inside current</font></strong></em>
<br><em><strong><font color="#707070">        bounds. New bounds are initialized with default values.</font></strong></em>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><font FACE="Sans-serif" color="#000000"><B> Index validity:</B></font>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">valid_line</font></strong> line:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> :<a href="BOOLEAN.html"><font color="#008000">BOOLEAN</font></a> <-
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">valid_index1</font></strong> line:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> :<a href="BOOLEAN.html"><font color="#008000">BOOLEAN</font></a> <-
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">valid_column</font></strong> column:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> :<a href="BOOLEAN.html"><font color="#008000">BOOLEAN</font></a> <-
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">valid_index2</font></strong> column:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> :<a href="BOOLEAN.html"><font color="#008000">BOOLEAN</font></a> <-
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">valid_index</font></strong> (line, column:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a>) :<a href="BOOLEAN.html"><font color="#008000">BOOLEAN</font></a> <-
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><font FACE="Sans-serif" color="#000000"><B> Counting:</B></font>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">count1</font></strong>:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Size of the first dimension.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">line_count</font></strong>:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Equivalent of `count1'.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">count2</font></strong> :<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Size of the second dimension.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">column_count</font></strong> :<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Equivalent of `count2'.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">count</font></strong>:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Total number of elements.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">swap</font></strong> (line1, column1:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a>) <strong><font color="#0000FF">with</font></strong> (line2, column2:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a>) <-
<br><em><strong><font color="#707070">        Swap the element at index (`line1',`column1') with the</font></strong></em>
<br><em><strong><font color="#707070">        the element at index (`line2',`column2').</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">set_all_with</font></strong> v:<font color="#008000">E</font> <-
<br><em><strong><font color="#707070">        Set all item with value `v'.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">clear_all</font></strong> <-
<br><em><strong><font color="#707070">        Set all items to default values.</font></strong></em>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><font FACE="Sans-serif" color="#000000"><B> Creating or initializing:</B></font>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">from_collection2</font></strong> model:<a href="COLLECTION2.html"><font color="#008000">COLLECTION2</font></a>[<font color="#008000">E</font>] <-
<br><em><strong><font color="#707070">        Uses `model' to initialize Current.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">from_model</font></strong> model:<a href="COLLECTION.html"><font color="#008000">COLLECTION</font></a>[<a href="COLLECTION.html"><font color="#008000">COLLECTION</font></a>[<font color="#008000">E</font>]] <-
<br><em><strong><font color="#707070">        The `model' is used to fill line by line Current.</font></strong></em>
<br><em><strong><font color="#707070">        Assume all sub-collections of `model' have the same</font></strong></em>
<br><em><strong><font color="#707070">        number of lines.</font></strong></em>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><font FACE="Sans-serif" color="#000000"><B> Looking and comparison:</B></font>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">all_default</font></strong>:<a href="BOOLEAN.html"><font color="#008000">BOOLEAN</font></a> <-
<br><em><strong><font color="#707070">        Do all items have their type's default value?</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> '<font color="#B8860B">==</font>' other:<a href="COLLECTION2.html"><font color="#008000">COLLECTION2</font></a>[<font color="#008000">E</font>] :<a href="BOOLEAN.html"><font color="#008000">BOOLEAN</font></a> <-
<br><em><strong><font color="#707070">        Do both collections have the same `lower1', `lower2', `upper1' and `upper2', and items?</font></strong></em>
<br><em><strong><font color="#707070">        The basic `=' is used for comparison of items.</font></strong></em>
<br><em><strong><font color="#707070">        </font></strong></em>
<br><em><strong><font color="#707070">        See also `is_equal_map'.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">is_equal_map</font></strong> (other:<a href="COLLECTION2.html"><font color="#008000">COLLECTION2</font></a>[<font color="#008000">E</font>]) :<a href="BOOLEAN.html"><font color="#008000">BOOLEAN</font></a> <-
<br><em><strong><font color="#707070">        Do both collections have the same `lower1', `lower2', `upper1' and `upper2', and items?</font></strong></em>
<br><em><strong><font color="#707070">        Feature `is_equal' is used for comparison of items.</font></strong></em>
<br><em><strong><font color="#707070">        </font></strong></em>
<br><em><strong><font color="#707070">        See also `is_equal'.</font></strong></em>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><font FACE="Sans-serif" color="#000000"><B> Printing:</B></font>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">fill_tagged_out_memory</font></strong> <-
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><font FACE="Sans-serif" color="#000000"><B> Miscellaneous features:</B></font>
<br><font FACE="Sans-serif" color="#000000"><B></B></font>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">occurrences</font></strong> elt:<font color="#008000">E</font> :<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Number of occurrences using `equal'.</font></strong></em>
<br><em><strong><font color="#707070">        </font></strong></em>
<br><em><strong><font color="#707070">        See also `fast_occurrences' to chose the apropriate one.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">fast_occurrences</font></strong> elt:<font color="#008000">E</font> :<a href="INTEGER.html"><font color="#008000">INTEGER</font></a> <-
<br><em><strong><font color="#707070">        Number of occurrences using `='.</font></strong></em>
<br><em><strong><font color="#707070">        </font></strong></em>
<br><em><strong><font color="#707070">        See also `occurrences' to chose the apropriate one.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">has</font></strong> x:<font color="#008000">E</font> :<a href="BOOLEAN.html"><font color="#008000">BOOLEAN</font></a> <-
<br><em><strong><font color="#707070">        Search if a element x is in the array using `equal'.</font></strong></em>
<br><em><strong><font color="#707070">        </font></strong></em>
<br><em><strong><font color="#707070">        See also `fast_has' to chose the apropriate one.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">fast_has</font></strong> x:<font color="#008000">E</font> :<a href="BOOLEAN.html"><font color="#008000">BOOLEAN</font></a> <-
<br><em><strong><font color="#707070">        Search if a element x is in the array using `='.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">replace_all</font></strong> old_value:<font color="#008000">E</font> <strong><font color="#0000FF">with</font></strong> new_value:<font color="#008000">E</font> <-
<br><em><strong><font color="#707070">        Replace all occurences of the element `old_value' by `new_value'</font></strong></em>
<br><em><strong><font color="#707070">        using `equal' for comparison.</font></strong></em>
<br><em><strong><font color="#707070">        </font></strong></em>
<br><em><strong><font color="#707070">        See also `fast_replace_all' to choose the apropriate one.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">fast_replace_all</font></strong> old_value:<font color="#008000">E</font> <strong><font color="#0000FF">with</font></strong> new_value:<font color="#008000">E</font> <-
<br><em><strong><font color="#707070">        Replace all occurences of the element `old_value' by `new_value'</font></strong></em>
<br><em><strong><font color="#707070">        using operator `=' for comparison.</font></strong></em>
<br><em><strong><font color="#707070">        </font></strong></em>
<br><em><strong><font color="#707070">        See also `replace_all' to choose the apropriate one.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">sub_collection2</font></strong> (line_min,column_min:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a>) <strong><font color="#0000FF">to</font></strong> (line_max,column_max:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a>) :<font color="#008000">SELF</font> <-
<br><em><strong><font color="#707070">        Create a new object using selected area of `Current'.</font></strong></em>
<br><br><strong><font color="#FF0000">    -</font></strong> <strong><font color="#0000FF">set_area</font></strong> (line_min,column_min:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a>) <strong><font color="#0000FF">to</font></strong> (line_max,column_max:<a href="INTEGER.html"><font color="#008000">INTEGER</font></a>) <strong><font color="#0000FF">with</font></strong> element:<font color="#008000">E</font> <-
<br><em><strong><font color="#707070">        Set all the elements of the selected area rectangle with `element'.</font></strong></em>
</body>
</html>
|