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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
/* * DMNTK - Decision Model and Notation Toolkit * * Decision table recognizer * * Copyright 2018-2021 Dariusz Depta Engos Software <dariusz.depta@engos.software> * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ //! # Decision table recognizer //! //! Recognizing engine for decision tables defined using plain Unicode text. //! //! ## Introduction //! //! (tbd) Describe the way the decision table is defined as Unicode text. //! //! ## General algorithm of recognizing decision tables defined as Unicode text //! //! ### STEP 1 //! //! Take a decision table defined as Unicode text, for example: //! //! ```text //! ┌───────────────────────────┐ //! │ information item name │ //! ├───┬────────────────────┬──┴─────────────────╥────────────────────┐ //! │ U │ input expression 1 │ input expression 2 ║ output label │ //! │ ├────────────────────┼────────────────────╫────────────────────┤ //! │ │ input value 1a, │ input value 2a, ║ output value 1a, │ //! │ │ input value 1b │ input value 2b ║ output value 1b │ //! ╞═══╪════════════════════╪════════════════════╬════════════════════╡ //! │ 1 │ │ input entry 2.1 ║ output entry 1.1 │ //! ├───┤ input entry 1.1 ├────────────────────╫────────────────────┤ //! │ 2 │ │ input entry 2.2 ║ output entry 1.2 │ //! ├───┼────────────────────┼────────────────────╫────────────────────┤ //! │ 3 │ input entry 1.2 │ - ║ output entry 1.3 │ //! ├───┼────────────────────┼────────────────────╫────────────────────┤ //! │ 4 │ input entry 1.3 │ input entry 2.3 ║ output entry 1.4 │ //! └───┴────────────────────┴────────────────────╨────────────────────┘ //! ``` //! //! ### STEP 2 //! //! Remove all characters except box drawing characters. //! //! ```text //! ┌───────────────────────────┐ //! │ │ //! ├───┬────────────────────┬──┴─────────────────╥────────────────────┐ //! │ │ │ ║ │ //! │ ├────────────────────┼────────────────────╫────────────────────┤ //! │ │ │ ║ │ //! │ │ │ ║ │ //! ╞═══╪════════════════════╪════════════════════╬════════════════════╡ //! │ │ │ ║ │ //! ├───┤ ├────────────────────╫────────────────────┤ //! │ │ │ ║ │ //! ├───┼────────────────────┼────────────────────╫────────────────────┤ //! │ │ │ ║ │ //! ├───┼────────────────────┼────────────────────╫────────────────────┤ //! │ │ │ ║ │ //! └───┴────────────────────┴────────────────────╨────────────────────┘ //! ``` //! //! ### STEP 3 //! //! Remove the information item cell if present. //! //! ```text //! ┌───┬────────────────────┬────────────────────╥────────────────────┐ //! │ │ │ ║ │ //! │ ├────────────────────┼────────────────────╫────────────────────┤ //! │ │ │ ║ │ //! │ │ │ ║ │ //! ╞═══╪════════════════════╪════════════════════╬════════════════════╡ //! │ │ │ ║ │ //! ├───┤ ├────────────────────╫────────────────────┤ //! │ │ │ ║ │ //! ├───┼────────────────────┼────────────────────╫────────────────────┤ //! │ │ │ ║ │ //! ├───┼────────────────────┼────────────────────╫────────────────────┤ //! │ │ │ ║ │ //! └───┴────────────────────┴────────────────────╨────────────────────┘ //! ``` //! //! ### STEP 4 //! //! Replace all double lines with single lines. //! //! ```text //! ┌───┬────────────────────┬────────────────────┬────────────────────┐ //! │ │ │ │ │ //! │ ├────────────────────┼────────────────────┼────────────────────┤ //! │ │ │ │ │ //! │ │ │ │ │ //! ├───┼────────────────────┼────────────────────┼────────────────────┤ //! │ │ │ │ │ //! ├───┤ ├────────────────────┼────────────────────┤ //! │ │ │ │ │ //! ├───┼────────────────────┼────────────────────┼────────────────────┤ //! │ │ │ │ │ //! ├───┼────────────────────┼────────────────────┼────────────────────┤ //! │ │ │ │ │ //! └───┴────────────────────┴────────────────────┴────────────────────┘ //! ``` //! //! ### STEP 5 //! //! Add lacking single line segments. //! Map the full grid cells to regions from [STEP 2](#step-2). //! //! ```text //! ┌───┬────────────────────┬────────────────────┬────────────────────┐ //! │ │ │ │ │ //! ├───┼────────────────────┼────────────────────┼────────────────────┤ //! │ │ │ │ │ //! │ │ │ │ │ //! ├───┼────────────────────┼────────────────────┼────────────────────┤ //! │ │ │ │ │ //! ├───┼────────────────────┼────────────────────┼────────────────────┤ //! │ │ │ │ │ //! ├───┼────────────────────┼────────────────────┼────────────────────┤ //! │ │ │ │ │ //! ├───┼────────────────────┼────────────────────┼────────────────────┤ //! │ │ │ │ │ //! └───┴────────────────────┴────────────────────┴────────────────────┘ //! ``` //! //! ### STEP 6 //! //! Rearrange the matrix such a way, that the content cells from [STEP 5](#step-5) //! are split with cells simulating double lines. Cells with double lines are marked with `╳`. //! //! ```text //! ┌─┬─┬─┬─┬─┐ //! │ │ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │ │ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │╳│╳│╳│╳│╳│ //! ├─┼─┼─┼─┼─┤ //! │ │ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │ │ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │ │ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │ │ │ │╳│ │ //! └─┴─┴─┴─┴─┘ //! ``` //! //! ### STEP 7. //! //! Check if the top left cell points to the region with valid hit policy. If yes, then check if all the cells //! in the first column above the first double line point to the same region with hit policy. Example with hit policy //! placed in the top left corner is shown below. Hit policy is marked as H. Such table is a decision table with //! rules as rows. First column below the first double line should contain rule numbers marked as N. //! //! ```text //! ┌─┬─┬─┬─┬─┐ //! │H│ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │H│ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │╳│╳│╳│╳│╳│ //! ├─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ //! └─┴─┴─┴─┴─┘ //! ``` //! //! ### STEP 7a. //! //! If there is more than one row above the first double line, then the row near the double contains cells //! with default values, marked as D. In such case all the cells above default values in each column should point //! to the same region (on the left from the double line). These regions are input expressions marked as I. //! To the right is the output label. //! //! ```text //! ┌─┬─┬─┬─┬─┐ //! │H│I│I│╳│O│ //! ├─┼─┼─┼─┼─┤ //! │H│D│D│╳│D│ //! ├─┼─┼─┼─┼─┤ //! │╳│╳│╳│╳│╳│ //! ├─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ //! └─┴─┴─┴─┴─┘ //! ``` //! //! ### STEP 7b. //! //! No default values. //! //! ```text //! ┌─┬─┬─┬─┬─┐ //! │H│I│I│╳│O│ //! ├─┼─┼─┼─┼─┤ //! │╳│╳│╳│╳│╳│ //! ├─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ //! ├─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ //! └─┴─┴─┴─┴─┘ //! ``` //! //! ### STEP 7c. //! //! Multiple outputs. //! //! ```text //! ┌─┬─┬─┬─┬─┬─┐ //! │H│I│I│╳│O│O│ //! ├─┼─┼─┼─┼─┼─┤ //! │H│I│I│╳│C│C│ //! ├─┼─┼─┼─┼─┼─┤ //! │H│D│D│╳│D│D│ //! ├─┼─┼─┼─┼─┼─┤ //! │╳│╳│╳│╳│╳│╳│ //! ├─┼─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ │ //! ├─┼─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ │ //! ├─┼─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ │ //! ├─┼─┼─┼─┼─┼─┤ //! │N│ │ │╳│ │ │ //! └─┴─┴─┴─┴─┴─┘ //! ``` //! //! ### STEP 7d. //! //! Rows below the double line on the left are input entries marked as P. //! Rows below the first double line to the right are the output entries marked as T //! //! ```text //! ┌─┬─┬─┬─┬─┐ //! │H│I│I│╳│O│ //! ├─┼─┼─┼─┼─┤ //! │H│D│D│╳│D│ //! ├─┼─┼─┼─┼─┤ //! │╳│╳│╳│╳│╳│ //! ├─┼─┼─┼─┼─┤ //! │N│P│P│╳│T│ //! ├─┼─┼─┼─┼─┤ //! │N│P│P│╳│T│ //! ├─┼─┼─┼─┼─┤ //! │N│P│P│╳│T│ //! ├─┼─┼─┼─┼─┤ //! │N│P│P│╳│T│ //! └─┴─┴─┴─┴─┘ //! ``` //! //! ## Algorithm of recognizing the preferred orientation of the decision table //! //! Algorithm of recognizing the preferred orientation of the decision table is presented //! below as a decision table. Correctly constructed decision table may be presented //! horizontally (rules as rows), vertically (rules as columns) or as crosstab. //! //! Every decision table must contain minimum one vertical and one horizontal double line. //! If the decision table contains annotation clause, then the must be second horizontal //! or vertical line present. When the decision table does not contain any double lines //! or contains more than two horizontal or two vertical lines, then such decision table //! is invalid and will not be processed. This situation is covered by rules **1** and **2**. //! //! Rules **3** and **4** detect **horizontal decision table**. Horizontal decision table must //! consist of single horizontal double line, one or two vertical double lines, hit policy //! marker must be placed in the top left corner, and the rule numbers must be placed //! in the first left column below the horizontal double lines. When all these conditions //! are met, decision table is oriented **horizontally** (rules as rows). //! //! Rules **5** and **6** detect **vertical decision table**. Vertical decision table contains //! single vertical double line and one or two horizontal double line. When vertical decision //! table contains annotation clause, than contains two horizontal double lines. //! In horizontal decision table the hit policy marker must be placed in the left bottom //! corner, and the rule numbers must be placed in the last row on the right side of the vertical //! double line. When all these conditions are met, decision table is oriented **vertically** //! (rules as columns). //! //! Rule **7** detects crosstab decision table. Crosstab decision table contains exactly one //! vertical and one horizontal line. Crosstab decision table does not contain any hit policy //! marker nor rule numbers. When all these conditions are met, decision table is a **crosstab**. //! //! ```text //! ┌─────────────────────────┐ //! │ Preferred orientation │ //! ├───┬────────────────────┬┴─────────────────────┬──────────────┬──────────────╥─────────────┐ //! │ F │ Number of vertical │ Number of horizontal │ Hit policy │ Rule ║ Preferred │ //! │ │ double lines │ double lines │ │ numbers ║ orientation │ //! │ ├────────────────────┼──────────────────────┼──────────────┼──────────────╫─────────────┤ //! │ │ <1, 1, 2, >2 │ <1, 1, 2, >2 │ top-left, │ left-below, ║ horizontal, │ //! │ │ │ │ bottom-left, │ right-after, ║ vertical, │ //! │ │ │ │ not-found │ not-found ║ crosstab, │ //! │ │ │ │ │ ║ error │ //! ╞═══╪════════════════════╪══════════════════════╪══════════════╪══════════════╬═════════════╡ //! │ 1 │ <1, >2 │ - │ - │ - ║ error │ //! ├───┼────────────────────┼──────────────────────┼──────────────┼──────────────╫─────────────┤ //! │ 2 │ - │ <1, >2 │ - │ - ║ error │ //! ├───┼────────────────────┼──────────────────────┼──────────────┼──────────────╫─────────────┤ //! │ 3 │ 2 │ 1 │ top-left │ left-below ║ horizontal │ //! ├───┼────────────────────┼──────────────────────┼──────────────┼──────────────╫─────────────┤ //! │ 4 │ 1 │ 1 │ top-left │ left-below ║ horizontal │ //! ├───┼────────────────────┼──────────────────────┼──────────────┼──────────────╫─────────────┤ //! │ 5 │ 1 │ 2 │ bottom-left │ right-after ║ vertical │ //! ├───┼────────────────────┼──────────────────────┼──────────────┼──────────────╫─────────────┤ //! │ 6 │ 1 │ 1 │ bottom-left │ right-after ║ vertical │ //! ├───┼────────────────────┼──────────────────────┼──────────────┼──────────────╫─────────────┤ //! │ 7 │ 1 │ 1 │ not-found │ not-found ║ crosstab │ //! └───┴────────────────────┴──────────────────────┴──────────────┴──────────────╨─────────────┘ //! ``` //! pub extern crate dmntk_model; mod builder; mod canvas; mod errors; mod plane; mod point; mod recognizer; mod rect; #[cfg(test)] mod tests; pub use builder::build; pub use canvas::scan; pub use recognizer::Recognizer;