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 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
|
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
<title>Qhull code</title>
<!-- Navigation links -->
</head>
<body>
<p>
<a name="TOP"><b>Up:</b></a> <a href="http://www.qhull.org">Home page</a> for Qhull (<a href="../index.htm">local</a>)<br>
<b>Up:</b> <a href="index.htm#TOC">Qhull manual</a>: contents<br>
<b>To:</b> <a href="qh-quick.htm#programs">Programs</a>
• <a href="qh-quick.htm#options">Options</a>
• <a href="qh-opto.htm#output">Output</a>
• <a href="qh-optf.htm#format">Formats</a>
• <a href="qh-optg.htm#geomview">Geomview</a>
• <a href="qh-optp.htm#print">Print</a>
• <a href="qh-optq.htm#qhull">Qhull</a>
• <a href="qh-optc.htm#prec">Precision</a>
• <a href="qh-optt.htm#trace">Trace</a>
• <a href="http://www.qhull.org/src/libqhull_r/index.htm">Functions</a> (<a href="../src/libqhull_r/index.htm">local</a>)<br>
<b>To:</b> <a href="qh-impre.htm">Imprecision</a> in Qhull<br>
<b>To:</b> <a href="#TOC">Qhull code</a>: contents<br>
</p>
<hr>
<!-- Main text of document -->
<h1><a
href="http://www.geom.uiuc.edu/graphics/pix/Special_Topics/Computational_Geometry/4dcube.html"><img
src="qh--4d.gif" alt="[4-d cube]" align="middle" width="100"
height="100"></a> Qhull code</h1>
<p>This section discusses the code for Qhull. </p>
<p><b>Copyright © 1995-2020 C.B. Barber</b></p>
<hr>
<h2><a href="#TOP">»</a><a name="TOC">Qhull code: contents</a></h2>
<ul>
<li><a href="#reentrant">Reentrant</a> Qhull
<li><a href="#convert">How to convert</a> code to reentrant Qhull
<li><a href="#64bit">Qhull</a> on 64-bit computers
<li><a href="https://github.com/qhull/qhull/wiki/Qhull-build-systems">Qhull build systems</a>
<li><a href="#cpp">Calling</a> Qhull from C++ programs
<ul>
<li><a href="#questions-cpp">Cpp questions for Qhull</a></li>
<li><a href="#coordinate-cpp">CoordinateIterator</a></li>
<li><a href="#qhull-cpp">Qhull</a></li>
<li><a href="#error-cpp">QhullError</a></li>
<li><a href="#facet-cpp">QhullFacet</a></li>
<li><a href="#facetlist-cpp">QhullFacetList</a></li>
<li><a href="#facetset-cpp">QhullFacetSet</a></li>
<li><a href="#iterator-cpp">QhullIterator</a></li>
<li><a href="#linkedlist-cpp">QhullLinkedList</a></li>
<li><a href="#point-cpp">QhullPoint</a></li>
<li><a href="#qh-cpp">QhullQh</a></li>
<li><a href="#pointset-cpp">QhullPointSet</a></li>
<li><a href="#ridge-cpp">QhullRidge</a></li>
<li><a href="#ridgeset-cpp">QhullRidgeSet</a></li>
<li><a href="#set-cpp">QhullSet</a></li>
<li><a href="#vertex-cpp">QhullVertex</a></li>
<li><a href="#vertexlist-cpp">QhullVertexList</a></li>
<li><a href="#vertexset-cpp">QhullVertexSet</a></li>
<li><a href="#rbox-cpp">RboxPoints</a></li>
</ul>
<li><a href="#library">Calling</a> Qhull from C programs
<ul>
<li><a href="#exit">How to avoid</a> exit(), fprintf(), stderr, and stdout</li>
<li><a href="#constrained">Constrained Delaunay</a>
triangulation</li>
<li><a href="#dids">Delaunay triangulations</a> and point indices</li>
<li><a href="#findfacet">Locate facet</a> with
qh_findbestfacet()</li>
<li><a href="#inc">On-line construction</a> with
qh_addpoint()</li>
<li><a href="#mem">Sets and quick memory</a> allocation</li>
<li><a href="#tricoplanar">Tricoplanar facets</a> and option 'Qt'</li>
<li><a href="#vneighbor">Vertex neighbors</a> of a vertex</li>
<li><a href="#vertices">Voronoi vertices</a> of a region</li>
<li><a href="#ridge">Voronoi vertices</a> of a ridge</li>
</ul>
</li>
<li><a href="#debug">How to debug</a> Qhull
<ul>
<li><a href="#errors">Qhull</a> errors</li>
<li><a href="#loops">Qhull</a> infinite loops</li>
<li><a href="#trace">Qhull</a> trace options</li>
<li><a href="#segfault">Qhull</a> core dumps and segfaults</li>
<li><a href="#qtest">eg/qtest.sh<a> for intermittent errors and logging</li>
<li><a href="#memory">Memory</a> errors</li>
<li><a href="#debugtip">Qhull</a> debugging tips</li>
</ul> </li>
<li><a href="#performance">Performance</a> of Qhull</li>
<li><a href="#benchmark">eg/q_benchmark</a> for optimizing Qhull</li>
<li><a href="#enhance">Enhancements</a> to Qhull</li>
<li><a href="http://www.qhull.org/src/libqhull_r/index.htm">Function</a> index to Qhull (<a href="../src/libqhull_r/index.htm">local</a>)</li>
</ul>
<hr>
<h2><a href="#TOC">»</a><a name="reentrant">Reentrant Qhull</a></h2>
<p>Qhull-2015 introduces reentrant Qhull (libqhull_r). Reentrant Qhull uses a qhT* argument instead of global data structures.
The qhT* pointer is the first argument to most Qhull routines. It allows multiple instances of Qhull to run at the same time.
It simplifies the C++ interface to Qhull.
<p>New code should be written with libqhull_r. Existing users of libqhull should consider converting to libqhull_r.
Although libqhull will be supported indefinitely, improvements may not be implemented.
Reentrant qhull is 1-2% slower than non-reentrant qhull.
<p><b>Note:</b> Reentrant Qhull is <i>not</i> thread safe. Do not invoke Qhull routines with the same qhT* pointer from multiple threads.
<h2><a href="#TOC">»</a><a name="convert">How to convert</a> code to reentrant Qhull</h2>
<p>C++ users need to convert to libqhull_r.
The new C++ interface does a better, but not perfect, job of hiding Qhull's C data structures.
The previous C++ interface was unusual due to Qhull's global data structures.
<p>All other users should consider converting to libqhull_r. The conversion is straight forward.
Most of the changes may be made with global search and replace. The resulting files
may be checked via eg/make-qhull_qh.sh. It performs the inverse mapping for comparison with
non-reentrant code.
<p>For example, even though the original conversion of libqhull to
libqhull_r required thousands of changes, the first run of reentrant Qhull (unix_r.c) produced the same
output, and nearly the same log files, as the original, non-reentrant Qhull (unix.c). The
original conversion was made without the help of eg/make-qhull_qh.sh. Conversion errors almost
always produce compiler errors.
<p>Suggestions to help with conversion.
<ul>
<li>Qhull 2019.1 introduced eg/make-qhull_qh.sh. It simplifies the task of checking the consistency
of reentrant and non-reentrant C code for Qhull.
<li>Compare qconvex_r.c with qconvex.c. Define a qhT object and a pointer it. The qhT* pointer is the first argument to most Qhull functions.
Clear <tt>qh_qh-<NOerrext</tt> before calling qh_initflags(). Invoke QHULL_LIB_CHECK to check for a compatible Qhull library.
<li>Compare user_eg2_r.c with user_eg2.c
<li>Compare user_eg_r.c with user_eg.c. If you use qhT before invoking qh_init_A, call qh_zero() to clear the qhT object.
user_eg_r.c includes multiple Qhull runs.
<li>Review user_eg3_r.cpp. As with the other programs, invoke QHULL_LIB_CHECK.
Simple C++ programs should compile as is.
<li>Compare QhullFacet.cpp with the same file in Qhull-2012.1. UsingLibQhull was replaced with the macro QH_TRY_() and '<tt>qh_qh-<NOerrext= true</tt>'.
<li>For detailed notes on libqhull_r, see "libqhull_r (reentrant Qhull)" and "Source code changes for libqhull_r" in <a href="../src/Changes.txt">Changes.txt</a>.
<li>For detailed notes on libqhullcpp, see "C++ interface" and following sections in <a href="../src/Changes.txt">Changes.txt</a>.
<li>For regexps and conversion notes, see <a href="http://www.qhull.org/html/README_r.txt">README_r.txt</a> (unedited).
</ul>
<p>Suggestions for updating src/libqhull/* from src/libqhull_r/*:
<ul>
<li>Make edits to libqhull_r/* instead of libqhull/*. The reverse update is more difficult, as desribed above.
<li>Use 'eg/make-qhull_qh.sh libqhull_r' to automatically convert libqhull_r/* to qhull_qh/*
<li>Compare src/qhull_qh/ to src/libqhull/ using Beyond Compare (<a href="https://www.scootersoftware.com/">www.scootersoftware.com</a>)
or another directory comparison utility.
<li>Configure Beyond Compare for expected differences:
<ul><li>Rules > Importance > Unimportant text<br>'$Id: ', '$DateTime: ', 'char qh_version'
<li>When updating 'Unimportant text', select 'Use for all files in parent session' and, optionally, 'Updated session defaults'
<li>Select 'Minor' to ignore unimportant text
<li>Review Rules > Importance > Mark grammar elements. Be sure to include 'Comment'
</ul>
<li>Almost all unmodified lines should be identical.
<li>Use 'Diffs' view to review diffs, and 'All' view to copy diffs. Otherwise wrong lines may be changed
<li>Copy modified lines as needed.
<li>Be careful of removing true differences, such as those involiving
<ul>
<li>DEFqhT
<li>oldqhA, oldqhB
<li>qh_QHpointer
<li>qh_last_random
<li>qh_rand_r
<li>qhmem
<li>qhstat, qhstatT
<li>rbox_inuse
<li>rboxT
<li>"renentrant" vs. "non-reentrant"
</ul>
</ul>
<h2><a href="#TOC">»</a><a name="64bit">Qhull on 64-bit computers</a></h2>
<p>Qhull compiles for 64-bit hosts. Since the size of a pointer on a 64-bit host is double the size on a 32-bit host,
memory consumption increases about 50% for simplicial facets and up-to 100% for non-simplicial facets.
If the convex hull does not fit in the computer's level 1 and level 2 cache memory, Qhull will run
slower as it retrieves data from main memory.
<p>If your data fits in 32-bits, run Qhull as 32-bit code. It will use less memory and run faster.
<p>You can check memory consumption with option <a href="qh-optt.htm#Ts">Ts</a>. It includes the size of
each data structure:
<ul>
<li>32-bit -- merge 24 ridge 20 vertex 28 facet 88 normal 24 ridge vertices 16 facet vertices or neighbors 20
<li>64-bit -- merge 32 ridge 32 vertex 48 facet 120 normal 32 ridge vertices 40 facet vertices or neighbors 48
</ul>
<p>For Qhull 2015, the maximum identifier for ridges, vertices, and facets was increased
from 24-bits to 32-bits. This allows for larger convex hulls, but may increase the size of
the corresponding data structures. The sizes for Qhull 2012.1 were
<ul>
<li>32-bit -- merge 24 ridge 16 vertex 24 facet 88
<li>64-bit -- merge 32 ridge 32 vertex 40 facet 120
</ul>
<h2><a href="#TOC">»</a><a name="cpp">Calling Qhull from
C++ programs</a></h2>
<p>Qhull 2015 uses reentrant Qhull for its C++ interface. If you used
the C++ interface from qhull 2012.1, you may need to adjust how you initialize and use
the Qhull classes. See <a href="#convert">How to convert code to reentrant Qhull</a>.
<p>
Qhull's C++ interface allows you to explore the results of running Qhull.
It provides access to Qhull's data structures.
Most of the classes derive from the corresponding qhull data structure.
For example, <a href="#facet-cpp">QhullFacet</a> is an instance of Qhull's <a href="../src/libqhull_r/libqhull_r.h#facetT">facetT</a>.
</p>
<p>You can retain most of the data in Qhull and use the C++ interface to explore its results.
Each object contains a reference to Qhull's data structure (via QhullQh), making the C++ representation less memory efficient.
</p>
<p>Besides using the C++ interface, you can also use libqhull_r directly. For example,
the FOREACHfacet_(...) macro will visit each facet in turn.
</p>
<p>The C++ interface to Qhull is incomplete. You may need to extend the interface.
If so, you will need to understand Qhull's data structures and read the code.
<p>The C++ interface is not documented. You will need to read the code and review
<code>user_eg3</code> and Qhull's test program <code>qhulltest</code>. Please consider
documenting the C++ interface with <a href="https://www.doxygen.nl">Doxygen</a> or
another javadoc-style processor.
<p><code>user_eg3</code> demonstrates the C++ interface. For example,
<code>user_eg3 eg-100</code> prints the facets generated by Qhull.
<pre>
RboxPoints rbox;
rbox.appendPoints("100");
Qhull qhull;
qhull.runQhull(rbox, "");
cout << qhull.facetList();
</pre>
<p>
The C++ iterface for RboxPoints redefines the fprintf() calls
in rboxlib.c. Instead of writing its output to stdout, RboxPoints appends
the output to a std::vector.
</p>
<ul><li>
Run Qhull with option '<a href="qh-optt.htm#Ta">Ta</a>' to annotate the
output with qh_fprintf() identifiers.
</li><li>
Redefine qh_fprintf() for these identifiers.
</li><li>
See RboxPoints.cpp for an example.
</li></ul>
<p>The same technique may be used for calling Qhull from C++. The class <code>QhullUser</code> provides
a starting point. See <code>user_eg3 eg-fifo</code> for
a demonstration of Voronoi diagrams.
</p>
<p>
Since the C++ interface uses reentrant Qhull, multiple threads may run Qhull at the same time. Each thread is
one run of Qhull.
</p>
<p>
Do <i>not</i> have two threads accessing the same Qhull instance. Qhull is not thread-safe.
</p>
<h3><a href="#TOC">»</a><a name="coordinate-cpp">CoordinateIterator</a></h3>
<p>
A CoordinateIterator or ConstCoordinateIterator [RboxPoints.cpp] is a <code>std::vector<realT>::iterator</code> for Rbox and Qhull coordinates.
It is the result type of <a href="#rbox-cpp">RboxPoints</a>.coordinates().
</p>
<p>Qhull does not use CoordinateIterator for its data structures. A point in Qhull is an array of reals instead of a std::vector.
See <a href="#point-cpp">QhullPoint</a>.
</p>
<h3><a href="#TOC">»</a><a name="qhull-cpp">Qhull</a></h3>
<p>
Qhull is the top-level class for running Qhull.
It initializes Qhull, runs the computation, and records errors.
It provides access to the global data structure <a href="#qh-cpp">QhullQh</a>,
Qhull's <a href="#facet-cpp">facets</a>, and <a href="#vertex-cpp">vertices</a>.
</p>
<h3><a href="#TOC">»</a><a name="error-cpp">QhullError</a></h3>
<p>
QhullError is derived from <code>std::exception</code>. It reports errors from Qhull and captures the output to stderr.
</p>
<p>
If error handling is not set up, Qhull exits with a code from 1 to 5. The codes are defined by
qh_ERR* in libqhull_r.h. The exit is via qh_exit() in usermem_r.c.
The C++ interface does not report the
captured output in QhullError. Call Qhull::setErrorStream to send output to cerr instead.
</p>
<h3><a href="#TOC">»</a><a name="facet-cpp">QhullFacet</a></h3>
<p>
A QhullFacet is a facet of the convex hull, a region of the Delaunay triangulation, a vertex of a Voronoi diagram,
or an intersection of the halfspace intersection about a point.
A QhullFacet has a set of <a href="#vertex-cpp">QhullVertex</a>, a set of <a href="#ridge-cpp">QhullRidge</a>, and
a set of neighboring QhullFacets.
</p>
<h3><a href="#TOC">»</a><a name="facetlist-cpp">QhullFacetList</a></h3>
<p>
A QhullFacetList is a linked list of <a href="#facet-cpp">QhullFacet</a>. The result of <code>Qhull.runQhull</code> is a QhullFacetList stored
in <a href="#qh-cpp">QhullQh</a>.
</p>
<h3><a href="#TOC">»</a><a name="facetset-cpp">QhullFacetSet</a></h3>
<p>
A QhullFacetSet is a <a href="#set-cpp">QhullSet</a> of <a href="#facet-cpp">QhullFacet</a>. QhullFacetSet may be ordered or unordered. The neighboring facets of a QhullFacet is a QhullFacetSet.
The neighbors of a <a href="#facet-cpp">QhullFacet</a> is a QhullFacetSet.
The neighbors are ordered for simplicial facets, matching the opposite vertex of the facet.
</p>
<h3><a href="#TOC">»</a><a name="iterator-cpp">QhullIterator</a></h3>
<p>
QhullIterator contains macros for defining Java-style iterator templates from a STL-style iterator template.
</p>
<h3><a href="#TOC">»</a><a name="linkedlist-cpp">QhullLinkedList</a></h3>
<p>
A QhullLinkedLIst is a template for linked lists with next and previous pointers.
<a href="#facetlist-cpp">QhullFacetList</a> and <a href="#facetlist-cpp">QhullVertexList</a> are QhullLinkedLists.
</p>
<h3><a href="#TOC">»</a><a name="point-cpp">QhullPoint</a></h3>
<p>
A QhullPoint is an array of point coordinates, typically doubles. The length of the array is <a href="#qh-cpp">QhullQh</a>.hull_dim.
The identifier of a QhullPoint is its 0-based index from QhullQh.first_point followed by QhullQh.other_points.
</p>
<h3><a href="#TOC">»</a><a name="pointset-cpp">QhullPointSet</a></h3>
<p>
A QhullPointSet is a <a href="#set-cpp">QhullSet</a> of <a href="#point-cpp">QhullPoint</a>. The QhullPointSet of a <a href="#facet-cpp">QhullFacet</a> is its coplanar points.
</p>
<h3><a href="#TOC">»</a><a name="qh-cpp">QhullQh</a></h3>
<p>
QhullQh is the root of Qhull's data structure.
It contains initialized constants, sets, buffers, and variables.
It contains an array and a set of <a href="#point-cpp">QhullPoint</a>,
a list of <a href="#facet-cpp">QhullFacet</a>, and a list of <a href="#vertex-cpp">QhullVertex</a>.
The points are the input to Qhull. The facets and vertices are the result of running Qhull.
</p>
<p>
Qhull's functions access QhullQh through the global variable, <code>qh_qh</code>.
The global data structures, qh_stat and qh_mem, record statistics and manage memory respectively.
</p>
<h3><a href="#TOC">»</a><a name="ridge-cpp">QhullRidge</a></h3>
<p>
A QhullRidge represents the edge between two <a href="#facet-cpp">QhullFacet</a>'s.
It is always simplicial with qh.hull_dim-1 <a href="#vertex-cpp">QhullVertex</a>)'s.
</p>
<h3><a href="#TOC">»</a><a name="ridgeset-cpp">QhullRidgeSet</a></h3>
<p>
A QhullRidgeSet is a <a href="#set-cpp">QhullSet</a> of <a href="#ridge-cpp">QhullRidge</a>. Each <a href="#facet-cpp">QhullFacet</a> contains a QhullRidgeSet.
</p>
<h3><a href="#TOC">»</a><a name="set-cpp">QhullSet</a></h3>
<p>
A QhullSet is a set of pointers to objects. QhullSets may be ordered or unordered. They are the core data structure for Qhull.
</p>
<h3><a href="#TOC">»</a><a name="vertex-cpp">QhullVertex</a></h3>
<p>
A QhullVertex is a vertex of the convex hull. A simplicial <a href="#facet-cpp">QhullFacet</a> has qh.hull_dim-1 vertices. A QhullVertex contains a <a href="#point-cpp">QhullPoint</a>.
It may list its neighboring <a href="#facet-cpp">QhullFacet</a>'s.
</p>
<h3><a href="#TOC">»</a><a name="vertexlist-cpp">QhullVertexList</a></h3>
<p>
A QhullVertexList is a <a href="#linkedlist-cpp">QhullLinkedList</a> of <a href="#vertex-cpp">QhullVertex</a>.
The global data structure, <a href="#qh-cpp">QhullQh</a> contains a QhullVertexList of all
the vertices.
</p>
<h3><a href="#TOC">»</a><a name="vertexset-cpp">QhullVertexSet</a></h3>
<p>
A QhullVertexSet is a <a href="#set-cpp">QhullSet</a> of <a href="#vertex-cpp">QhullVertex</a>.
The QhullVertexSet of a <a href="#facet-cpp">QhullFacet</a> is the vertices of the facet. It is
ordered for simplicial facets and unordered for non-simplicial facets.
</p>
<h3><a href="#TOC">»</a><a name="rbox-cpp">RboxPoints</a></h3>
<p>
RboxPoints is a std::vector of point coordinates (<a href="#point-cpp">QhullPoint</a>).
Its iterator is <a href="#coordinate-cpp">CoordinateIterator</a>.
</p>
<p>
<code>RboxPoints.appendPoints()</code> appends points from a variety of distributions such as uniformly distributed within a cube and random points on a sphere.
It can also append a cube's vertices or specific points.
</p>
<h3><a href="#TOC">»</a><a name="questions-cpp">Cpp questions for Qhull</a></h3>
Developing C++ code requires many conventions, idioms, and technical details.
The following questions have either
mystified the author or do not have a clear answer. See also
<a href="http://www.qhull.org/road/road-faq/xml/cpp-guideline.xml">C++ and Perl Guidelines</a>
and 'QH110nn FIX' notes in the code.
Please add notes to <a href="http://github.com/qhull/qhull/wiki">Qhull Wiki</a>.
<ul>
<li>QH11028 FIX: Should return reference, but get reference to temporary
<pre>iterator Coordinates::operator++() { return iterator(++i); }</pre>
<li>size() as size_t, size_type, or int
<li>Should all containers have a reserve()?
<li>Qhull.feasiblePoint interface
<li>How to avoid copy constructor while logging, maybeThrowQhullMessage()
<li>How to configure Qhull output. Trace and results should go to stdout/stderr
<li>Qhull and RboxPoints messaging. e.g., ~Qhull, hasQhullMessage(). Rename them as QhullErrorMessage?
<li>How to add additional output to an error message, e.g., qh_setprint
<li>Is idx the best name for an index? It's rather cryptic, but BSD strings.h defines index().
<li>Qhull::feasiblePoint Qhull::useOutputStream as field or getter?
<li>Define virtual functions for user customization of Qhull (e.g., qh_fprintf, qh_memfree,etc.)
<li>Figure out RoadError::global_log. clearQhullMessage currently clearGlobalLog
<li>Should the false QhullFacet be NULL or empty? e.g., QhullFacet::tricoplanarOwner() and QhullFacetSet::end()
<li>Should output format for floats be predefined (qh_REAL_1, 2.2g, 10.7g) or as currently set for stream
<li>Should cout << !point.defined() be blank or 'undefined'
<li>Infinite point as !defined()
<li>qlist and qlinkedlist define pointer, reference, size_type, difference_type, const_pointer, const_reference for the class but not for iterator and const_iterator
vector.h -- <pre>reference operator[](difference_type _Off) const</pre>
<li>When forwarding an implementation is base() an approriate name (e.g., Coordinates::iterator::base() as std::vector<coordT>::iterator).
<li>When forwarding an implementation, does not work "returning address of temporary"
<li>Also --, +=, and -=
<pre>iterator &operator++() { return iterator(i++); }</pre>
<li>if vector<coordT> inheritance is bad, is QhullVertexSet OK?
<li>Should QhullPointSet define pointer and reference data types?
</ul>
<h2><a href="#TOC">»</a><a name="library">Calling Qhull from
C programs</a></h2>
<p><b>Warning:</b> Qhull was not designed for calling from C
programs. You may find the <a href="#cpp">C++ interface</a> easier to use.
You will need to understand the data structures and read the code.
Most users will find it easier to call Qhull as an external
command.
<p>For examples of calling Qhull, see GNU Octave's
<a href=http://www.gnu.org/software/octave/doc/interpreter/Geometry.html>computational geometry code</a>,
and Qhull's
<a href=../src/user_eg/user_eg_r.c>user_eg_r.c</a>,
<a href=../src/user_eg2/user_eg2_r.c>user_eg2_r.c</a>, and
<a href=../src/libqhull_r/user_r.c>user_r.c</a>. To see how Qhull calls its library, read
<a href=../src/qhull/unix_r.c>unix_r.c</a>,
<a href=../src/qconvex/qconvex.c>qconvex.c</a>,
<a href=../src/qdelaunay/qdelaun.c>qdelaun.c</a>,
<a href=../src/qhalf/qhalf.c>qhalf.c</a>, and
<a href=../src/qvoronoi/qvoronoi.c>qvoronoi.c</a>. The '*_r.c' files are reentrant, otherwise they are non-reentrant.
Either version may be used. New code should use reentrant Qhull.
<p>
See <a href="http://www.qhull.org/src/libqhull_r/index.htm">Functions</a> (<a href="../src/libqhull_r/index.htm">local</a>) for
internal documentation of Qhull. The
documentation provides an overview and index. To use the library
you will need to read and understand the code. For most users, it
is better to write data to a file, call the qhull program, and
read the results from the output file.
</p>
<p>If you use non-reentrant Qhull, be aware of the macros "qh"
and "qhstat", e.g., "qh hull_dim". They are
defined in <tt>libqhull.h</tt>. They allow the global data
structures to be pre-allocated (faster access) or dynamically
allocated (allows multiple copies). </p>
<p>Qhull's <tt>Makefile</tt> produces a library, <tt>libqhull_r.a</tt>,
for inclusion in your programs. First review <tt>libqhull_r.h</tt>.
This defines the data structures used by Qhull and provides
prototypes for the top-level functions.
Most users will only need libqhull_r.h in their programs. For
example, the Qhull program is defined with <tt>libqhull_r.h</tt> and <tt>unix_r.c</tt>.
To access all functions, use <tt>qhull_ra.h</tt>. Include the file
with "<tt>#include <libqhull_r/qhull_ra.h></tt>". This
avoids potential name conflicts.</p>
<p>Qhull provides build/qhull.pc.in for pkg-config support and CMakeLists.txt for CMake.
Using back-ticks, you can compile your C program with Qhull. For example:
<pre>
gcc `pkg-config --cflags --libs qhull_r` -o my_app my_app.c
</pre>
</p>
<p>If you use the Qhull library, you are on your own as far as
bugs go. Start with small examples for which you know the output.
If you get a bug, try to duplicate it with the Qhull program. The
'<a href="qh-optt.htm#Tc">Tc</a>' option will catch many problems
as they occur. When an error occurs, use '<a
href="qh-optt.htm#Tn">T4</a> <a href="qh-optt.htm#TPn">TPn</a>'
to trace from the last point added to the hull. Compare your
trace with the trace output from the Qhull program.</p>
<p>Errors in the Qhull library are more likely than errors in the
Qhull program. These are usually due to feature interactions that
do not occur in the Qhull program. Please report all errors that
you find in the Qhull library. Please include suggestions for
improvement. </p>
<h3><a href="#TOC">»</a><a name="exit">How to avoid exit(), fprintf(), stderr, and stdout</a></h3>
<p>Qhull sends output to qh.fout and errors, log messages, and summaries to qh.ferr. qh.fout is normally
stdout and qh.ferr is stderr. qh.fout may be redefined by option '<a
href="qh-optt.htm#TO">TO</a>' or the caller. qh.ferr may be redirected to qh.fout by option '<a
href="qh-optt.htm#Tz">Tz</a>'.</p>
<p>Qhull does not use stderr, stdout, fprintf(), or exit() directly.</p>
<p>Qhull reports errors via qh_errexit() by writting a message to qh.ferr and invoking longjmp().
This returns the caller to the corresponding setjmp() (c.f., QH_TRY_ in QhullQh.h). If
qh_errexit() is not available, Qhull functions call qh_exit(). qh_exit() normally calls exit(),
but may be redefined by the user. An example is
libqhullcpp/usermem_r-cpp.cpp. It redefines qh_exit() as a 'throw'.</p>
<p>If qh_meminit() or qh_new_qhull() is called with ferr==NULL, then they set ferr to stderr.
Otherwise the Qhull libraries use qh->ferr and qh->qhmem.ferr for error output.</p>
<p>If an error occurs before qh->ferr is initialized, Qhull invokes qh_fprintf_stderr(). The user
may redefine this function along with qh_exit(), qh_malloc(), and qh_free().
<p>The Qhull libraries write output via qh_fprintf() [userprintf_r.c]. Otherwise, the Qhull
libraries do not use stdout, fprintf(), or printf(). Like qh_exit(), the user may redefine
qh_fprintf().</p>
<h3><a href="#TOC">»</a><a name="mem">sets and quick memory
allocation</a></h3>
<p>You can use <tt>mem_r.c</tt> and <tt>qset_r.c</tt> individually. <tt>Mem_r.c
</tt>implements quick-fit memory allocation. It is faster than
malloc/free in applications that allocate and deallocate lots of
memory. </p>
<p><tt>qset_r.c</tt> implements sets and related collections. It's
the inner loop of Qhull, so speed is more important than
abstraction. Set iteration is particularly fast. <tt>qset_r.c</tt>
just includes the functions needed for Qhull. </p>
<h3><a href="#TOC">»</a><a name="dids">Delaunay triangulations
and point indices</a></h3>
<p>Here some unchecked code to print the point indices of each
Delaunay triangle. Use option 'QJ' if you want to avoid
non-simplicial facets. Note that upper Delaunay regions are
skipped. These facets correspond to the furthest-site Delaunay
triangulation. </p>
<blockquote>
<pre>
facetT *facet;
vertexT *vertex, **vertexp;
FORALLfacets {
if (!facet->upperdelaunay) {
printf ("%d", qh_setsize (facet->vertices);
FOREACHvertex_(facet->vertices)
printf (" %d", qh_pointid (vertex->point));
printf ("\n");
}
}
</pre>
</blockquote>
<h3><a href="#TOC">»</a><a name="findfacet">locate a facet with
qh_findbestfacet()</a></h3>
<p>The routine qh_findbestfacet in <tt>poly2_r.c</tt> is
particularly useful. It uses a directed search to locate the
facet that is furthest below a point. </p>
<p>For Delaunay
triangulations, this facet is either the Delaunay triangle or a neighbor of
the Delaunay triangle that contains the lifted point. Qhull determines the
Delaunay triangulation by projecting the input sites to a paraboloid. The
convex hull matches the Delaunay triangulation at the input sites, but does not
match along the edges. See this <a href="qh_findbestfacet-drielsma.pdf">image</a>
by F. Drielsma. A point is green or yellow depending upon the facet returned
by qh_findbestfacet. For points near an
edge, the circumcircles overlap and the adjacent facet may be returned. </p>
<p>For convex hulls, the distance of a point to
the convex hull is either the distance to this facet or the
distance to a subface of the facet.</p>
<blockquote>
<p><b>Warning:</b> If triangulated output ('<a href="qh-optq.htm#Qt">Qt</a>') and
the best facet was triangulated, qh_findbestfacet() returns one of
the corresponding 'tricoplanar' facets. The actual best facet may be a different
tricoplanar facet from the same set of facets.
<p>
See qh_nearvertex() in poly2.c for sample code to visit each
tricoplanar facet. To identify the correct tricoplanar facet,
see Devillers, et. al., [<a href="index.htm#devi01">'01</a>]
and Mucke, et al [<a href="index.htm#muck96">'96</a>]. If you
implement this test in general dimension, please notify
<a href="mailto:qhull@qhull.org">qhull@qhull.org</a>.
</blockquote>
<p>qh_findbestfacet performs an exhaustive search if its directed
search returns a facet that is above the point. This occurs when
the point is inside the hull or if the curvature of the convex
hull is less than the curvature of a sphere centered at the point
(e.g., a point near a lens-shaped convex hull). When the later
occurs, the distance function is bimodal and a directed search
may return a facet on the far side of the convex hull. </p>
<p>Algorithms that retain the previously constructed hulls
usually avoid an exhaustive search for the best facet. You may
use a hierarchical decomposition of the convex hull [Dobkin and
Kirkpatrick <a href="index.htm#dob-kir90">'90</a>]. </p>
<p>To use qh_findbestfacet with Delaunay triangulations, lift the
point to a paraboloid by summing the squares of its coordinates
(see qh_setdelaunay in geom2_r.c). Do not scale the input with
options 'Qbk', 'QBk', 'QbB' or 'Qbb'. See Mucke, et al [<a
href="index.htm#muck96">'96</a>] for a good point location
algorithm.</p>
<p>The intersection of a ray with the convex hull may be found by
locating the facet closest to a distant point on the ray.
Intersecting the ray with the facet's hyperplane gives a new
point to test. </p>
<h3><a href="#TOC">»</a><a name="inc">on-line construction with
qh_addpoint()</a></h3>
<p>The Qhull library may be used for the on-line construction of
convex hulls, Delaunay triangulations, and halfspace
intersections about a point. It may be slower than implementations that retain
intermediate convex hulls (e.g., Clarkson's <a
href="http://www.netlib.org/voronoi/hull.html">hull
program</a>). These implementations always use a directed search.
For the on-line construction of convex hulls and halfspace
intersections, Qhull may use an exhaustive search
(qh_findbestfacet). </p>
<p>You may use qh_findbestfacet and qh_addpoint (<tt>libqhull.c</tt>) to add a point to
a convex hull. Do not modify the point's coordinates since
qh_addpoint does not make a copy of the coordinates. For Delaunay
triangulations, you need to lift the point to a paraboloid by
summing the squares of the coordinates (see qh_setdelaunay in
geom2.c). Do not scale the input with options 'Qbk', 'QBk', 'QbB'
or 'Qbb'. Do not deallocate the point's coordinates. You need to
provide a facet that is below the point (<a href="#findfacet">qh_findbestfacet</a>).
</p>
<p>You can not delete points. Another limitation is that Qhull
uses the initial set of points to determine the maximum roundoff
error (via the upper and lower bounds for each coordinate). </p>
<p>For many applications, it is better to rebuild the hull from
scratch for each new point. This is especially true if the point
set is small or if many points are added at a time.</p>
<p>Calling qh_addpoint from your program may be slower than
recomputing the convex hull with qh_qhull. This is especially
true if the added points are not appended to the qh first_point
array. In this case, Qhull must search a set to determine a
point's ID. [R. Weber] </p>
<p>See user_eg.c for examples of the on-line construction of
convex hulls, Delaunay triangulations, and halfspace
intersections. The outline is: </p>
<blockquote>
<pre>
initialize qhull with an initial set of points
qh_qhull();
for each additional point p
append p to the end of the point array or allocate p separately
lift p to the paraboloid by calling qh_setdelaunay
facet= qh_findbestfacet (p, !qh_ALL, &bestdist, &isoutside);
if (isoutside)
if (!qh_addpoint (point, facet, False))
break; /* user requested an early exit with 'TVn' or 'TCn' */
call qh_check_maxout() to compute outer planes
terminate qhull</pre>
</blockquote>
<h3><a href="#TOC">»</a><a name="constrained">Constrained Delaunay triangulation</a></h3>
<p>With a fair amount of work, Qhull is suitable for constrained
Delaunay triangulation. See Shewchuk, ACM Symposium on
Computational Geometry, Minneapolis 1998.</p>
<p>Here's a quick way to add a constraint to a Delaunay
triangulation: subdivide the constraint into pieces shorter than
the minimum feature separation. You will need an independent
check of the constraint in the output since the minimum feature
separation may be incorrect. [H. Geron] </p>
<h3><a href="#TOC">»</a><a name="tricoplanar">Tricoplanar facets and option 'Qt'</h3>
<p>Option '<a href="qh-optq.htm#Qt">Qt</a>' triangulates non-simplicial
facets (e.g., a square facet in 3-d or a cubical facet in 4-d).
All facets share the same apex (i.e., the first vertex in facet->vertices).
For each triangulated facet, Qhull
sets facet->tricoplanar true and copies facet->center, facet->normal, facet->offset, and facet->maxoutside. One of
the facets owns facet->normal; its facet->keepcentrum is true.
If facet->isarea is false, facet->triowner points to the owning
facet.
<p>Qhull sets facet->degenerate if the facet's vertices belong
to the same ridge of the non-simplicial facet.
<p>To visit each tricoplanar facet of a non-simplicial facet,
either visit all neighbors of the apex or recursively visit
all neighbors of a tricoplanar facet. The tricoplanar facets
will have the same facet->center.</p>
<p>See <a href="http://www.qhull.org/src/libqhull_r/io_r.c#detvridge">qh_detvridge</a> for an example of ignoring tricoplanar facets.</p>
<h3><a href="#TOC">»</a><a name="vertices">Voronoi vertices of a
region</a></h3>
<p>The following code iterates over all Voronoi vertices for each
Voronoi region. Qhull computes Voronoi vertices from the convex
hull that corresponds to a Delaunay triangulation. An input site
corresponds to a vertex of the convex hull and a Voronoi vertex
corresponds to an adjacent facet. A facet is
"upperdelaunay" if it corresponds to a Voronoi vertex
"at-infinity". Qhull uses qh_printvoronoi in <tt>io.c</tt>
for '<a href=qvoronoi.htm>qvoronoi</a> <a href="qh-opto.htm#o">o</a>' </p>
<blockquote>
<pre>
/* please review this code for correctness */
qh_setvoronoi_all();
FORALLvertices {
site_id = qh_pointid (vertex->point);
if (qh hull_dim == 3)
qh_order_vertexneighbors(vertex);
infinity_seen = 0;
FOREACHneighbor_(vertex) {
if (neighbor->upperdelaunay) {
if (!infinity_seen) {
infinity_seen = 1;
... process a Voronoi vertex "at infinity" ...
}
}else {
voronoi_vertex = neighbor->center;
... your code goes here ...
}
}
}
</pre>
</blockquote>
<h3><a href="#TOC">»</a><a name="ridge">Voronoi vertices of a
ridge</a></h3>
<p>Qhull uses qh_printvdiagram() in io.c to print the ridges of a
Voronoi diagram for option '<a href="qh-optf.htm#Fv2">Fv</a>'.
The helper function qh_eachvoronoi() does the real work. It calls
the callback 'printvridge' for each ridge of the Voronoi diagram.
</p>
<p>You may call qh_printvdiagram2(), qh_eachvoronoi(), or
qh_eachvoronoi_all() with your own function. If you do not need
the total number of ridges, you can skip the first call to
qh_printvdiagram2(). See qh_printvridge() and qh_printvnorm() in
io.c for examples. </p>
<h3><a href="#TOC">»</a><a name="vneighbor">vertex neighbors of
a vertex</a></h3>
<p>To visit all of the vertices that share an edge with a vertex:
</p>
<ul>
<li>Generate neighbors for each vertex with
qh_vertexneighbors in <tt>poly2.c</tt>. </li>
<li>For simplicial facets, visit the vertices of each
neighbor </li>
<li>For non-simplicial facets, <ul>
<li>Generate ridges for neighbors with qh_makeridges
in <tt>merge.c</tt>. </li>
<li>Generate ridges for a vertex with qh_vertexridges
in <tt>merge.c</tt>. </li>
<li>Visit the vertices of these ridges. </li>
</ul>
</li>
</ul>
<p>For non-simplicial facets, the ridges form a simplicial
decomposition of the (d-2)-faces between each pair of facets --
if you need 1-faces, you probably need to generate the full face
graph of the convex hull. </p>
<h2><a href="#TOC">»</a><a name="debug">How to debug</a> Qhull</h2>
<p>Qhull continually checks its execution, so most errors will stop Qhull with an error message.
Additional checking occurs for verified output ('<a href="qh-optt.htm#Tv">Tv</a>'), check
frequently ('<a href="qh-optt.htm#Tc">Tc</a>'), check for duplicate ridges ('<a href="qh-optq.htm#Q15">Q15</a>'),
and tracing at level 4 ('<a href="qh-optt.htm#Tn">T4</a>'). </p>
<p>If Qhull detects an error, it writes a descriptive error message to stderr, and exits with an exit status code (see following).
The C++ interface captures the message
in Qhull::qhullMessage. If Qhull::setErrorStream was called, it writes the error message to Qhull::errorStream.
<p>If a Qhull segfault occurs, turn on tracing with option '<a href="qh-optt.htm#Tn">T4</a>' and
flush output (qh_fprintf) with option '<a href="qh-optt.htm#Tf">Tf</a>'. See <a href="#segfault">core dumps and
segfaults</a>.
<p>If Qhull never finishes, is Qhull running slow or was there an infinite loop?
<ul>
<li>If you are running Qhull under Git for Windows or MSYS2, 'qhull' waits for stdin instead of displaying a help message.
Use 'qhull --help' instead.
<li>Turn on monitoring with option
'<a href="qh-optt.htm#TFn">TFn</a>'. Qhull normally takes approximately the same amount of time per point.
If the output is too large, it will slow down due to main memory or virtual memory.
<li>If there are large,
non-simplicial facets, see "quadradic running time" in <a href="qh-impre.htm#limit">Limitations of merged facets</a>.
<li>See <a href="#performance">Performance</a> and <a href="#loops">infinite loops</a> for further suggestions.
</ul>
<p>If a Qhull error occurs, try to simplify the problem.
<ul>
<li>If new to Qhull, start with short examples that you can work out by hand. Your problem may
be due to misunderstanding Qhull's output, or an incompatibility between your program and the Qhull libraries.
<li>Can you produce the input that triggers the problem? The input to Qhull includes the dimension,
number of points, point coordinates, and Qhull options. Qhull is usually deterministic for a particular build.
<li>Can you duplicate the problem using one of the Qhull programs (e.g., 'qhull' or 'qconvex')?
<li>Does a shorter output trigger the problem?
<li>Can you turn on tracing with option '<a href="qh-optt.htm#Tn">T4</a>'? If too much output occurs,
use the <a href="qh-optt.htm">trace options</a> to reduce the trace output.
<li>The test program, '<a href="#qtest">eg/qtest.sh</a>', repeats a qhull run for intermittent errors.
It can log a qhull run to 'qhull.log' and a reduced log, 'qhull-step.log'.
</ul>
<p>If the segfault, infinite loop, or internal error was
due to Qhull, please report the error to '<a href="mailto:bradb@shore.net">bradb@shore.net</a>.
Please include the input data (i.e., point coordinates) that triggered the error.
<h3><a href="#TOC">»</a><a name="errors">Qhull errors</a></h3>
<p>Qhull errors start with 'QH6...' and Qhull warnings start with 'QH7...'. The error message and
error code are arguments to a qh_fprintf call. After printing the error message, Qhull exits with
an exit status code. The exit status code indicates the type of error:
<ul>
<li>
qh_ERRinput (1) -- badly formed options or input. Badly formed options are reported as
Qhull warnings. Unless option '<a href="qh-optq.htm#Qw">Qw</a>' is specified, Qhull reports error
QH6035 or QH6037 and exits with qh_ERRinput. Inconsistent options typically report an error.
<br>The input to Qhull specifies the dimension
and number of points. If the input contains
fewer or more points than coordinates, Qhull reports error QH6410 and exits with qh_ERRinput.
If option '<a href="qh-optq.htm#Qa">Qa</a>' is specified, it reports warning QH7073
and continues execution. </li>
<li>
qh_ERRsingular (2) -- singular input data. If the input data is singular or flat (e.g., a line segment in 2-d),
Qhull reports error QH6114, QH6379, or QH6154. Qhull calls qh_printhelp_singular to print an explanation of the error.
It exits qhull with qh_ERRsingular. </li>
<li>
qh_ERRprec (3) -- precision error. By default, Qhull handles precision errors by merging.
If merging is not possible, or if a precision error is identified after Qhull finishes, Qhull reports an
error and calls qh_printhelp_degenerate. It exits qhull with qh_ERRprec. </li>
<li>
qh_ERRmem (4) -- memory error. If Qhull runs out of memory, it reports an error and exits qhull with qh_ERRmem. </li>
<li>
qh_ERRQhull (5) -- internal error. If Qhull detects an internal error, it reports the
error and calls qh_printhelp_internal. It exits qhull with qh_ERRQhull. </li>
<li>
qh_ERRother (6) -- other errors. If Qhull identifies an error while reporting another error, it prints
"qhull error while handling previous error" and exits Qhull with qh_ERRother. The same exit code is
used for vertex id overflow and missing exitcode for qh_errexit. </li>
<li>
qh_ERRtopology (7) -- topology error. If Qhull cannot recover from a topology error, it reports
the error and calls qh_printhelp_topology. It exits qhull with qh_ERRtopology. </li>
<li>
qh_ERRwide (8) -- wide facet error. If Qhull produces an extra-wide facet, it reports the error and
calls qh_printhelp_wide. It exits qhull with qh_ERRwide. </li>
<li>
qh_ERRdebug (9) -- debug. Use qh_ERRdebug for exits from debugging code. </li>
</ul></p>
<h3><a href="#TOC">»</a><a name="loops">Qhull infinite loops</a></h3>
Except for list traversals, most loops in Qhull are limited by a count or the size of set.
Linked lists of facets and vertices terminate with a sentinel whose next element is NULL.
If a programming error inserts a link to a previous facet or vertex, an infinite loop occurs
on the next traversal. Qhull periodically checks and corrects its linked lists for infinite loops
(<a href="http://www.qhull.org/src/libqhull_r/poly2_r.c#qh_checklists">qh_checklists</a>).
</p>
<h3><a href="#TOC">»</a><a name="trace">Qhull trace options</a></h3>
<p>Qhull's <a href="qh-optt.htm#trace">trace</a> options are the key to debugging Qhull. They describe
an execution of Qhull at various levels of detail, with various options to control what is traced.
<ul>
<li>Level 0 ('T-1') -- Key events are prefixed with '[QH00nn]'
<li>Level 1 ('T1') -- Main steps in the program are prefixed with '[QH1nnn]'.<br>
[QH1049]qh_addpoint -- When Qhull adds a point, it logs information about the point, the convex hull so far, and changes since the previous qh_addpoint.
<li>Level 2 ('T2') -- Minor steps in the program are prefixed with '[QH2nnn]'.
<li>Level 3 ('T3') -- Merge and other events are prefixed with '[QH3nnn]'.
<li>Level 4 ('T4') -- Detailed trace of Qhull execution.
<li>Level 5 ('T5') -- Memory allocations and Guassian elimination. Memory allocations are prefixed with "qh_mem " followed by address, sequence number, alloc/free, short/long, etc.
If you sort by address and sequence number, each allocate should be paired with its free.
</ul></p>
<p>These options select when tracing starts or stops. It limits the amount of tracing, especially in high dimensions.
<ul>
<li>'<a href="qh-optt.htm#TAn">TAn</a>' -- stop Qhull after adding n vertices
<li>'<a href="qh-optt.htm#TCn">TCn</a>' -- stop Qhull after building cone for point n
<li>'<a href="qh-optt.htm#TMn">TMn</a>' -- turn on tracing at merge n.
When Qhull reports an error, it reports "Last merge was #nnn".
<li>'<a href="qh-optt.htm#TPn">TPn</a>' -- turn on tracing when point n is added to hull or point n is referenced.
When Qhull reports an error, it reports "Last point added to hull was pnnn".
<li>'<a href="qh-optt.htm#TVn2">TVn</a>' -- stop Qhull after adding point n, -n for before
<li>'<a href="qh-optt.htm#TWn">TWn</a>' -- trace merge facets when width > n
</ul></p>
Additional logging by facet id (fnnn), ridge id (rnnn) or vertex id (vnnn), may be enabled by
setting qh.tracefacet_id, qh.traceridge_id,
or qh.tracevertex_id in global_r.c/qh_initqhull_start2.
<h3><a href="#TOC">»</a><a name="segfault">Qhull core dumps and segfaults</a></h3>
<p>If a segfault occurs, use option '<a href="qh-optt.htm#Tf">Tf</a>' to flush output after every qh_fprintf.
Logging will be significantly slower than normal.</p>
<p>The following debugging plan usually identifies the error
<ol>
<li>Trace execution at level 1 with flush after each qh_fprintf
and output to stdout ('<a href="qh-optt.htm#Tn">T1</a> <a href="qh-optt.htm#Tf">Tf</a> <a href="qh-optt.htm#Tz">Tz</a>').
<li>Repeat at level 4 after the last qh_addpoint (QH1049, '<a href="qh-optt.htm#TPn">TPn</a>').
Add line numbers to the log by piping the output through 'grep -n .'.
<ul>
<li>If there is too much level 4 output, repeat at level 2 to find the last
qh_mergefacet (QH2081) and then trace at level 4 from the last merge ('<a href="qh-optt.htm#TMn">TMn</a>').
<li>If there is still too much level 4 output, identify one of the last level 3 events and add debugging
to the corresponding trace3 call. Be sure to mark the code for removal. For example<br>
<pre>
if (facetA->id==4675)
qh->IStracing= 4; /* DEBUG */
trace3((qh, qh->ferr, 3020, "qh_triangulate_facet: triangulate facet f%d\n", facetA->id));
</pre>
</ul></li>
<li>Identify the location of the failure using a build of Qhull with debug symbols.
<li>Use the debugger to find relevant facet ids, ridge ids, and vertex ids. These identifiers will appear in the
level 4 log.
</ol>
<h3><a href="#TOC">»</a><a name="qtest">eg/qtest.sh for intermittent errors and logging</a></h3>
<p>For intermittent errors, use 'rbox' to generate random test cases, and <a href="../eg/qtest.sh">eg/qtest.sh</a>
to invoke multiple runs of qhull.
When a failing case is found, rerun eg/qtest.sh with the test case identifier. It produces qhull.log and the
corresponding reduced log, qhull-step.log. These logs include line numbers generated by 'grep -n .'</p>
<p>qtest.sh provides the following options
<ul>
<li>N qhull runs (qtest.sh -N 'rbox c | qhull')
<br>execute the qhull command N times with rotated input 'QR1', 'QR2', ...
<li>N random qhull runs (qtest.sh N 'rbox c | qhull')
<br>execute the qhull command N times with random rotations 'QRn', ...
<p>
<li>N 'rbox|qhull' runs (qtest.sh -N 'rbox-opts' 'qhull-opts')
<br>execute rbox and qhull N times with random inputs 't1', 't2', ...
<li>N random 'rbox|qhull' runs (qtest.sh N 'rbox-opts' 'qhull-opts')
<br>execute rbox and qhull N times with random inputs 'tnnn', ...
<p>
<li>Run qhull command (qtest.sh run 'rbox c | qhull')
<br>execute a qhull command line
<li>Run qhull QRnnn (qtest.sh run QRnnn 'rbox | qhull')
<br>execute a qhull command line with QRnnn rotated input
<li>Run rbox tnnn | qhull (qtest.sh run t... 'rbox-opts' 'qhull-opts')
<br>execute rbox and qhull commands with tnnn random input
<p>
<li>Log qhull command (qtest.sh log 'rbox c | qhull')
<br>trace (T4) a qhull command line to qhull.log and qhull-step.log
<li>Log qhull QRnnn (qtest.sh QRnnn 'rbox | qhull')
<br>trace (T4) a qhull command line with QRnnn rotated input to qhull.log and qhull-step.log
<li>Log rbox tnnn | qhull (qtest.sh tnnn 'rbox-opts' 'qhull-opts')
<br>trace (T4) rbox and qhull commands with tnnn random input to qhull.log and qhull-step.log
<p>
<li> Grep qhull.log for events (qtest.sh grep)
<br> grep qhull.log for $QH_GREP excluding $QH_GREPX to stdout
<li> Grep qhull.log for regexp (qtest.sh grep 'include-regexp')
<br> grep qhull.log for regexp|$QH_GREP excluding $QH_GREPX to stdout
<li> Grep qhull.log for include and exclude regexps (qtest.sh grep 'include-regexp' 'exclude-regexp')
<br> grep qhull.log for include|$QH_GREP excluding exclude|$QH_GREPX to stdout
<p>
<li> Grep logfile for merge events (qtest.sh grep-merge logfile)
<br> grep logfile for merge events to stdout, see #grep-merge in qtest.sh
<p>
<li> Grep logfile for step events (qtest.sh grep-merge logfile)
<br> grep logfile for step events to stdout, same as qhull-step.log
<p>
<li> Verbose logging (qtest.sh -v ...)
<br> prepend log with command and environment variables
</ul>
<h3><a href="#TOC">»</a><a name="memory">Memory errors</a></h3>
Qhull checks memory usage before exiting. To locate memory that is not freed ("QH7079 qhull internal warning (main): did not free ..."):
<ol>
<li>Run qhull with memory tracing '<a href="qh-optt.htm#Tn">T5</a>'.
<br>See 'Level 5' in <a href="#trace">Qhull trace options</a> (above)
<li>Sort lines that start with 'qh_mem'. It matches qh_memalloc with the corresponding qh_memfree.
<li>For long allocations, sort lines that contain -- qh_mem.*long:
<li>Replace -- qh_mem.*alloc.*\nqh_mem.*free.* -- with 'Match' (<a href="http://www.textpad.com">Textpad</a> supports internal newlines in match expressions).
<li>Sort by column 25 (n...). It shows unallocated actions. Long allocations are in execution order.
Short and quick allocations are in execution order.
<li>For example: qh_mem 0000000000537440 n 10053 alloc long: 128 bytes (tot 484800 cnt 1209)
<li>To check quick vs. long allocations -- grep "qh_mem .*alloc " qhull.log | sed -e 's/^.*long/long/' -e 's/^.*short/short/' -e 's/^.*quick/quick/' -e 's/bytes.*/bytes/' | sort | uniq -c >x.1
</ol></p>
<p>Option '<a href="qh-optt.htm#Ts">Ts</a>' reports
numerous memory statistics.
<h3><a href="#TOC">»</a><a name="debugtip">Qhull debugging tips</a></h3>
<ul>
<li>qh_printlists in poly2_r.c -- called during qh_addpoint. Easily inserted into existing code and a
good location for debugging code.
<li>qh_fprintf in user_r.c -- called for all Qhull output, including trace logs. A good location
for reasonably efficient debugging code.
The debugging code may refer to a facet, ridge, or vertex by setting
qh.tracefacet_id, qh.traceridge_id, or qh.tracevertex_id in global_r.c/qh_initqhull_start2.
<li>qh_tracemerge in merge_r.c -- called after each merge. It is a good location for debugging code.
</ul>
<h2><a href="#TOC">»</a><a name="performance">Performance of Qhull</a></h2>
<p>Empirically, Qhull's performance is balanced in the sense that
the average case happens on average. This may always be true if
the precision of the input is limited to at most <i>O(log n)</i>
bits. Empirically, the maximum number of vertices occurs at the
end of constructing the hull. </p>
<p>Let <i>n</i> be the number of input points, <i>v</i> be the
number of output vertices, and <i>f_v </i>be the maximum number
of facets for a convex hull of <i>v</i> vertices. If both
conditions hold, Qhull runs in <i>O(n log v)</i> in 2-d and 3-d
and <i>O(n f_v/v)</i> otherwise. The function <i>f_v</i>
increases rapidly with dimension. It is <em>O(v^floor(d/2) /
floor(d/2)!)</em>.</p>
<p>The time complexity for merging is unknown. The default options '<a
href="qh-optc.htm#C0">C-0</a>' (2-d, 3-d, 4-d) and '<a href="qh-optq.htm#Qx">Qx</a>' (5-d and higher)
handle precision problems due to floating-point
arithmetic. They are optimized for simplicial outputs. </p>
<p>When running large data sets, you should monitor Qhull's
performance with the '<a href="qh-optt.htm#TFn">TFn</a>' option.
The time per facet is approximately constant. In high-d with many
merged facets, the size of the ridge sets grows rapidly. For
example the product of 8-d simplices contains 18 facets and
500,000 ridges. This will increase the time needed per facet. </p>
<p>Additional detail is provided by QH1049 in the level-1 trace ('<a href="qh-optt.htm#Tn">T1</a>').
For each qh_addpoint, it provides vertex id, facet count, outside point count,
CPU time for the previous point, deltas for facets/hyperplanes/distplanes, and the number
of retries due to merged pinched vertices. For example:</p>
<blockquote>
[QH1049]qh_addpoint: add p260(v176) to hull of 286 facets (1.4e-12 above f830) and 2 outside at 1.192 CPU secs. Previous p710(v175) delta 0.007 CPU, 2 facets, 3 hyperplanes, 443 distplanes, 0 retries
</blockquote>
<p>As dimension increases, the number of facets and ridges in a
convex hull grows rapidly for the same number of vertices. For
example, the convex hull of 300 cospherical points in 6-d has
30,000 facets. </p>
<p>If Qhull appears to stop processing facets, check the memory
usage of Qhull. If more than 5-10% of Qhull is in virtual memory,
its performance will degrade rapidly. </p>
<p>When building hulls in 20-d and higher, you can follow the
progress of Qhull with option '<a href="qh-optt.htm#Tn">T1</a>'.
It reports each major event in processing a point. </p>
<p>To reduce memory requirements, recompile Qhull for
single-precision reals (REALfloat in <tt>user.h</tt>).
Single-precision does not work with joggle ('<a
href="qh-optq.htm#QJn">QJ</a>'). Check qh_MEMalign in <tt>user.h</tt>
and the match between free list sizes and data structure sizes
(see the end of the statistics report from '<a
href="qh-optt.htm#Ts">Ts</a>'). If free list sizes do not match,
you may be able to use a smaller qh_MEMalign. Setting
qh_COMPUTEfurthest saves a small amount of memory, as does
clearing qh_MAXoutside (both in <tt>user.h</tt>).</p>
<p>Shewchuk is working on a 3-d version of his triangle
program. It is optimized for 3-d simplicial Delaunay triangulation
and uses less memory than Qhull.</p>
<p>To reduce the size of the Qhull executable, consider
qh_NOtrace and qh_KEEPstatistics 0 in <tt>user.h</tt>. By
changing <tt>user.c </tt>you can also remove the input/output
code in <tt>io.c</tt>. If you don't need facet merging, then
version 1.01 of Qhull is much smaller. It contains some bugs that
prevent Qhull from initializing in simple test cases. It is
slower in high dimensions.</p>
<p>The precision options, '<a href="qh-optc.htm#Vn">Vn</a>', '<a
href="qh-optc.htm#Wn">Wn</a>', '<a href="qh-optc.htm#Un">Un</a>'.
'<a href="qh-optc.htm#An">A-n</a>', '<a href="qh-optc.htm#Cn">C-n</a>',
'<a href="qh-optc.htm#An2">An</a>', '<a href="qh-optc.htm#Cn2">Cn</a>',
and '<a href="qh-optq.htm#Qx">Qx</a>', may have large effects on
Qhull performance. You will need to experiment to find the best
combination for your application. </p>
<p>The verify option ('<a href="qh-optt.htm#Tv">Tv</a>') checks
every point after the hull is complete. If facet merging is used,
it checks that every point is inside every facet. This can take a
very long time if there are many points and many facets. You can
interrupt the verify without losing your output. If facet merging
is not used and there are many points and facets, Qhull uses a
directed search instead of an exhaustive search. This should be
fast enough for most point sets. Directed search is not used for
facet merging because directed search was already used for
updating the facets' outer planes.</p>
<p>The check-frequently option ('<a href="qh-optt.htm#Tc">Tc</a>')
becomes expensive as the dimension increases. The verify option
('<a href="qh-optt.htm#Tv">Tv</a>') performs many of the same
checks before outputting the results.</p>
<p>Options '<a href="qh-optq.htm#Q0">Q0</a>' (no pre-merging), '<a
href="qh-optq.htm#Q3">Q3</a>' (no checks for redundant vertices),
'<a href="qh-optq.htm#Q5">Q5</a>' (no updates for outer planes),
and '<a href="qh-optq.htm#Q8">Q8</a>' (no near-interior points)
increase Qhull's speed. The corresponding operations may not be
needed in your application.</p>
<p>In 2-d and 3-d, a partial hull may be faster to produce.
Option '<a href="qh-optq.htm#QGn">QgGn</a>' only builds facets
visible to point n. Option '<a href="qh-optq.htm#QVn">QgVn</a>'
only builds facets that contain point n. In higher-dimensions,
this does not reduce the number of facets.</p>
<p><tt>User.h</tt> includes a number of performance-related
constants. Changes may improve Qhull performance on your data
sets. To understand their effect on performance, you will need to
read the corresponding code. </p>
<p>GNU <tt>gprof</tt> reports that the dominate cost for 3-d
convex hull of cosperical points is qh_distplane(), mainly called
from qh_findbestnew(). The dominate cost for 3-d Delaunay triangulation
is creating new facets in qh_addpoint(), while qh_distplane() remains
the most expensive function.</p>
<h2><a href="#TOC">»</a><a name="benchmark">eg/q_benchmark</a> for optimizing Qhull</h2>
<p><a href="../eg/q_benchmark">eg/q_benchmark</a> and <a href="../eg/qtest.sh">eg/qtest.sh</a>
make multiple runs of Qhull for testing,
benchmarking, and debugging. They help test and analyze intermittent errors, performance issues, and precision issues.
Each release updates <a href="../eg/q_benchmark-ok.txt">eg/q_benchmark-ok.txt</a>.
<p>Qhull 2019.1 is 15% larger than Qhull 2015.2 due to enhanced error reporting, tracing, and facet merging.
The increased code size may increase startup times. </p>
<p>Qhull is single threaded. Gcc's gprof works well for profiling Qhull performance. </p>
<ul>
<li>Recompile Qhull with '-pg' added to CC_OPTS1 in qhull's Makefile. Check for optimization ('-O3').
<li>Execute a performance test of Qhull
<ul><li>See "=== Timing test cases ===" in 'eg/q_benchmark'.
</ul>
<li>Check for gmon.out from gcc's '-pg' option -- ls -l gmon.out
<li>Run gprof -- gprof qhull >gprof.txt # gprof qhull.exe >gprof.txt
<li>Review gprof.txt
<ul>
<li>The first section gives results by function, the second section, results by caller
</ul>
<li>Sample runs
<pre>rbox 500000 s >r.x; time qhull TI r.x
AIR2-/local/qhull/bin> time qhull TI r.x
Convex hull of 500000 points in 3-d:
Number of vertices: 500000
Number of facets: 999996
Statistics for: rbox 500000 s | qhull TI r.x
Number of points processed: 500000
Number of hyperplanes created: 2827999
Number of distance tests for qhull: 24786928
CPU seconds to compute hull (after input): 4.852
[4] 62.8 0.02 2.11 499996 qh_addpoint [4]
0.01 0.83 499996/499996 qh_buildcone [5]
0.04 0.56 499996/499996 qh_partitionvisible [7]
0.01 0.28 499996/499996 qh_premerge [13]
0.04 0.13 499996/499996 qh_findhorizon [19]
# 2015.2
Statistics for: rbox 500000 s | qhull TI c:/bash/local/qhull/bin/r.x
Number of vertices: 500000
Number of facets: 999996
Number of points processed: 500000
Number of hyperplanes created: 2827999
Number of distance tests for qhull: 24786929
CPU seconds to compute hull (after input): 4.477
real 0m6.334s
user 0m0.016s
sys 0m0.015s
</pre>
</ul>
<h2><a href="#TOC">»</a><a name="enhance">Enhancements to Qhull</a></h2>
<p>There are many ways in which Qhull can be improved. </p>
<pre>
Top Suggestions
- Document the C++ interface using Doxygen
- Construct the full Voronoi Diagram using the C++ interface. See "To do" in Changes.txt
- Optimize for 64-bit code
Custom facetT for simplicial facets
32-bit indices for facets and vertices
- Bulk qh_addpoint with a custom point partition
- Full-dimensional flats
Add points at right angles like 'Qz'
Ignore added facets in output (cf. f.upperDelaunay and f.good)
- Per-vertex joggle
Joggle by random flip of low-order and adjustable-order bits in mantissa
Allows consistent triangulations across distributed partitions
Detect integer input data and automatically translate to the origin
- Develop a theory for merging Qhull's non-simplicial facets
A merge creates constraints on subsequent merges, what are these constraints?
Identify topological errors in qh_findbest_test (merge_r.c)f
Prevent duplicate ridges (Q15-check-duplicates) or facets with the same vertices
Preserve facet-ridge orientation for nonsimplicial facets (ridge top/bot)
Produce conformant triangulations for nonsimplicial facets (option 'Qt', QH2088)
Should vertex merge account for facet orientation?
Rationalize the merge options qh_RATIOtwisted, qh_WIDEdupridge, etc.
Should wide merges be proportional to qh.ONEmerge or f.maxoutside?
Can dupridges be avoided with geometric and topological constraints?
Review coplanar tests across sharp ridges (coplanar horizon, qh_test_appendmerge, qh_check_maxout)
- Improve Qhull's computations, particularly qh_setfacetplane for hyperplanes
Toronto, N., McCarthy, J., "Practically accurate floating-point math,", Computing in
Science & Engineering, IEEE, July/August 2014, p. 80-95.
- Octave creates endpoints for unbounded ridges, for drawing Delaunay/Voronoi diagrams [M. Voss]
- Option to select bounded Voronoi regions [A. Uzunovic]
- Review Qhull performance. qh_next_vertexmerge and qh_check_maxout are slower than expected
Compare to Peterka et al and Li and Snoeyink, particularly 64-bit vs. 32-bit
- Use Gaussian distribution for random cospherical points in rbox
- Implement dimension reduction via Johnson-Lindenstrauss flattening
- Implement bulk qh_addpoint via a subset of the facets, perhaps a box about qh.interior_point
Allow qh_triangulate to run after each increment [coldfix, scipy #4974]
- Write incremental addPoint with bucketed inputs and facet search (CGAL)
- Compute hyperplanes in parallel (cf. qh_setfactplane)
- Create Voronoi volumes and topology in parallel
- Implement Delaunay to Voronoi tesselation [Peterka et al, 2014, www.mcs.anl.gov/papers/P5154-0614.pdf]
- Integrate 4dview with Geomview 1.9.5
- Use coverage testing to expand Qhull's test programs
- Add RPM and Debian builds to Qhull (CMake's CPackRMP and CPackDeb).
- Create a mirror/archive web site for old and new Qhull builds
- Constrain delaunay triangulations via Shewchuk's algorithm (ACM Symp. Comp. Geo., 1998)
-----------
To do for a furture version of the C++ interface
- Document C++ using Doxygen conventions (//! and //!<)
- Add defineAs() to each object
- Add Qtest::toString() functions for QhullPoint and others. QByteArray and qstrdup()
- Add toQVector() for Qt container support. QVector is preferred over QList
- Add mutable Java-style iterators for containers. Limited due to memory-allocation issues.
- Should Qhull manage the output formats for doubles? QH11010 FIX: user_r.h defines qh_REAL_1 as %6.8g
- Allocate memory for QhullSet using Qhull.qhmem. Create default constructors for QhullVertexSet etc. Also mid() etc.
- Add interior point for automatic translation?
- Write a program with concurrent Qhull
- Write QhullStat and QhullStat_test
- Add QList and vector instance of facetT*, etc.
- Generalize QhullPointSetIterator
- qh-code.htm: Document changes to C++ interface.
Organize C++ documentation into collection classes, etc.
- Review all C++ classes and C++ tests
- QhullVertexSet uses QhullSetBase::referenceSetT() to free its memory. Probably needed elsewhere
- The Boost Graph Library provides C++ classes for graph data structures. It may help
enhance Qhull's C++ interface [Dr. Dobb's 9/00 p. 29-38; OOPSLA 99 p. 399-414].
[May 2020] Suggestions
- Check that the midpoint for Voronoi option 'Fo' is not a Voronoi vertex (rbox c D2 P0 | qvoronoi Fo)
- How to detect degenerate hyperplanes for Voronoi option 'Fo' and 'Fi'?
qh_sethyperplane_gauss reports nearzero for axis parallel hyperplanes.
- Add a 'Tv' test for Voronoi option 'Fo' that does not use midpoints
[May 2019] Suggestions
------------
Precision issues
- Improve handling of data with positive, integer coordinates, particularly for Delaunay triangulation
eg Sterratt's github issue #25
Add a warning that available precision is reduced
Add an option to automatically translate the data to the origin
- Review qh.MAXcoplanar ('Un'), it varies by dimension compared to qh.ONEmerge
Topology issues
- Need theory for facet merging, vertex merging, and topological errors
- Does qh_triangulate produce a consistent orientation if qh_renamevertex is not called?
Facet and vertex merging
- Reduce the overhead of qh.NEWtentative ('Q14') and improve the speed of facet and vertex merging
- Review MRGconcavecoplanar and early out for isconcave in qh_test_nonsimplicial_merge
- Review user_r.h ratios and precision constants for merging
Pre-compute derived precision values (e.g., qh_detmaxoutside)
- Use a fixed target instead of a relative wide-max ratio.
Why should qh.MAXoutside increase when qh.max_outside increases dramatically
Why should a slow but steady increase in qh.max_outside be OK?
Define an option to specify wide-max ratio -- 100x is borderline, bad cases can produce 400x,
- Add statistics for dupridge matching in qh_matchneighbor and qh_matchdupridge. Report as a "precision problem"
- Collect statistics for MRGdegen and MRGredundant
- In qh_all_merges, why is isreduce set when qh.POSTmerging && qh.hull_dim >= 4?
- In qh_forcedmerges and qh_initmergesets, remove assumption that qh.facet_mergeset is the last temporary set
- Review comparisons for qh_compare_anglemerge and qh_compare_facetmerge (after developing a theory)
Other
- Add a version flag to 'rbox' (cf. global_r.c/qh_version). Currently, the release date is part of its help prompt.
- Review effect of qh.GOODclosest on qh_buildcone_onlygood ('Qg', QH11030 FIX). qh_findgood preserves old value if didn't find a good facet. See qh_findgood_all for disabling
- Review the rules for -REALmax -- they look inconsistent.
Why REALmax/2 and -REALmax/2? The comments say 'avoid underflow'. When was it introduced?
- Review comment in qh_matchnewfacets -- "do not allocate memory after qh.hash_table (need to free it cleanly)"
- Chase circular dependencies when compiling qhulltest with Microsoft Devstudio
Warning MSB8017 A circular dependency has been detected while executing custom build commands for item "moc\Coordinates_test.moc". This may cause incremental build to work incorrectly. qhulltest-64 C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\Common7\IDE\VC\VCTargets\Microsoft.CppCommon.targets 209
- Add 'design:' documentation for poly2_r.c/qh_triangulate
Consider splitting up
- Geomview for 4-d merge is difficult to understand. Not able to see the convexity of the edges
- Review memory sizes (mem_r.c/qh_memsize) and quick allocations for 64-bit code
- Review Qhull's collection API conventions, http://www.qhull.org/road/road-faq/xml/qhull-cpp.xml
See http://gnuwin32.sourceforge.net/packages.html and https://google-styleguide.googlecode.com/svn/trunk/cppguide.html
[Jan 2019] Suggestions
- Optimize poly_r.c/qh_update_vertexneighbors for qh_triangulate. qh_setunique and qh_setcompact are slow
- The size of maxpoints in qh_initialvertices/qh_maxsimplex should be d+3 unique points to help avoid QH6154
- Review coordT vs. realT. Should parameters and variables be coordT when they are distances or coordinates?
'coordT' is defined as 'realT'
Having computations as 'double' with coordinates stored as 'float' requires many type conversions
Expressions are often computed as 'double' anyway
Source code sometimes uses 'coordT' and sometimes 'realT'
- Need a separate, hash check for duplicate ridge vertices in a facet list -- faster than current qh_checkfacet
- Add joggle for 'almost incident' vertices (order of 100), may clean up Qt as well, projected to hyperplane
- Consider using r.mergevertex2 to optimize qh_postmerge
- Report two facets with same ridge vertices, opposite orientation (topology error)
add warning (see QH7084) for duplicate ridge with opposite orientation (only two facets in the list)
- Check 'qh_NOmerge' compiler option
[Jan 2016] Suggestions
------------
- Add a post-merge pass for Delaunay slivers. Merge into a neighbor with a circumsphere that includes the opposite point. [M. Treacy]
- Option to add a bounding box for Delaunay triangulations, e,g., nearly coincident points
- Rescale output to match 'QbB' on input [J. Metz, 1/30/2014 12:21p]
- Run through valgrind
- Notes to compgeom on conformant triangulation and Voronoi volume
- Implement weighted Delaunay triangulation and weighted Voronoi diagram [A. Liebscher]
e.g., Sugihara, "Three-dimensional convex hull as a fruitful source of diagrams," Theoretical Computer Science, 2000, 235:325-337
- testqset: test qh_setdelnth and move-to-front
- Makefile: Re-review gcc/g++ warnings. OK in 2011.
- Break up -Wextra into its components or figure out how to override -Wunused-but-set-variable
unused-but-set-variable is reporting incorrectly. All instances are annotated.
- Can countT be defined as 'int', 'unsigned int', or 64-bit int?
countT is currently defined as 'int' in qset_r.h
Vertex ID and ridge ID perhaps should be countT, They are currently 'unsigned'
Check use of 'int' vs. countT in all cpp code
Check use of 'int' vs. countT in all c code
qset_r.h defines countT -- duplicates code in user_r.h -- need to add to qset.h/user.h
countT -1 used as a flag in Coordinates.mid(), QhullFacet->id()
Also QhullPoints indexOf and lastIndexOf
Also QhullPointSet indexOf and lastIndexOf
Coordinates.indexOf assumes countT is signed (from end)
Coordinates.lastIndexOf assumes countT is signed (from end)
All error messages with countT are wrong, convert to int?
RboxPoints.qh_fprintf_rbox, etc. message 9393 assumes countT but may be int, va_arg(args, countT); Need to split
[Jan 2010] Suggestions
- Generate vcproj from qtpro files
cd qtpro && qmake -spec win32-msvc2005 -tp vc -recursive
sed -i 's/C\:\/bash\/local\/qhull\/qtpro\///' qhull-all.sln
Change qhullcpp to libqhull.dll
Allow both builds on same host (keep /tmp separate)
- C++ class for access to statistics, accumulate vs. add
- Add dialog box to RoadError-- a virtual function?
- Option 'Gt' does not make visible all facets of the mesh example, rbox 32 M1,0,1 | qhull d Gt
- Merge small volume boundary cells into unbounded regions [Dominik Szczerba]
- Postmerge with merge options
- Add modify operators and MutablePointCoordinateIterator to PointCoordinates
- Fix option Qt for conformant triangulations of merged facets
- Investigate flipped facet -- rbox 100 s D3 t1263080158 | qhull R1e-3 Tcv Qc
- Add doc comments to c++ code
- Measure performance of Qhull, seconds per point by dimension
- Report potential wraparound of 64-bit ints -- e.g., a large set or points
Documentation
- Qhull::addPoint(). Problems with qh_findbestfacet and otherpoints see
qh-code.htm#inc on-line construction with qh_addpoint()
- How to handle 64-bit possible loss of data. WARN64, ptr_intT, size_t/int
- Show custom of qh_fprintf
- cat x.x | grep 'qh_mem ' | sort | awk '{ print $2; }' | uniq -c | grep -vE ' (2|4|6|8|10|12|14|16|20|64|162)[^0-9]'
- qtpro/qhulltest contains .pro and Makefile. Remove Makefiles by setting shadow directory to ../../tmp/projectname
- Rules for use of qh_qh and multi processes
UsingQhull
errorIfAnotherUser
~QhullPoints() needs ownership of qh_qh
Does !qh_pointer work?
When is qh_qh required? Minimize the time.
qhmem, qhstat.ferr
qhull_inuse==1 when qhull globals active [not useful?]
rbox_inuse==1 when rbox globals active
- Multithreaded -- call largest dimension for infinityPoint() and origin()
- Better documentation for qhmem totshort, freesize, etc.
- how to change .h, .c, and .cpp to text/html. OK in Opera
- QhullVertex.dimension() is not quite correct, epensive
- Check globalAngleEpsilon
- Deprecate save_qhull()
[Dec 2003] Here is a partial list:
- fix finddelaunay() in user_eg.c for tricoplanar facets
- write a BGL, C++ interface to Qhull
http://www.boost.org/libs/graph/doc/table_of_contents.html
- change qh_save_qhull to swap the qhT structure instead of using pointers
- change error handling and tracing to be independent of 'qh ferr'
- determine the maximum width for a given set of parameters
- prove that directed search locates all coplanar facets
- in high-d merging, can a loop of facets become disconnected?
- find a way to improve inner hulls in 5-d and higher
- determine the best policy for facet visibility ('<a href="qh-optc.htm#Vn">Vn</a>')
- determine the limitations of '<a href="qh-optq.htm#Qg">Qg</a>'
Precision improvements:
- For 'Qt', resolve cross-linked, butterfly ridges.
May allow retriangulation in qh_addpoint().
- for Delaunay triangulations ('d' or 'v') under joggled input ('QJ'),
remove vertical facets whose lowest vertex may be coplanar with convex hull
- review use of 'Qbb' with 'd QJ'. Is MAXabs_coord better than MAXwidth?
- check Sugihara and Iri's better in-sphere test [Canadian
Conf. on Comp. Geo., 1989; Univ. of Tokyo RMI 89-05]
- replace centrum with center of mass and facet area
- handle numeric overflow in qh_normalize and elsewhere
- merge flipped facets into non-flipped neighbors.
currently they merge into best neighbor (appears ok)
- determine min norm for Cramer's rule (qh_sethyperplane_det). It looks high.
- improve facet width for very narrow distributions
New features:
- implement Matlab's tsearch() using Qhull
- compute volume of Voronoi regions. You need to determine the dual face
graph in all dimensions [see Clarkson's hull program]
- compute alpha shapes [see Clarkson's hull program]
- implement deletion of Delaunay vertices
see Devillers, ACM Symposium on Computational Geometry, Minneapolis 1999.
- compute largest empty circle [see O'Rourke, chapter 5.5.3] [Hase]
- list redundant (i.e., coincident) vertices [Spitz]
- implement Mucke, et al, ['96] for point location in Delaunay triangulations
- implement convex hull of moving points
- implement constrained Delaunay diagrams
see Shewchuk, ACM Symposium on Computational Geometry, Minneapolis 1998.
- estimate outer volume of hull
- automatically determine lower dimensional hulls
- allow "color" data for input points
need to insert a coordinate for Delaunay triangulations
Input/output improvements:
- Support the VTK Visualization Toolkit, http://www.kitware.com/vtk.html
- generate output data array for Qhull library [Gautier]
- need improved DOS window with screen fonts, scrollbar, cut/paste
- generate Geomview output for Voronoi ridges and unbounded rays
- generate Geomview output for halfspace intersection
- generate Geomview display of furthest-site Voronoi diagram
- use '<a href="qh-optg.htm#GDn">GDn</a>' to view 5-d facets in 4-d
- convert Geomview output for other 3-d viewers
- add interactive output option to avoid recomputing a hull
- orient vertex neighbors for '<a href="qh-optf.htm#Fv">Fv</a>' in 3-d and 2-d
- track total number of ridges for summary and logging
Performance improvements:
- GPU hardware acceleration, particularly for qh_setplane [D. Reese]
- optimize Qhull for 2-d Delaunay triangulations
- use O'Rourke's <a href="index.htm#orou94">'94</a> vertex->duplicate_edge
- add bucketing
- better to specialize all of the code (ca. 2-3x faster w/o meSrging)
- use updated LU decomposition to speed up hyperplane construction
- [Gill et al. 1974, Math. Comp. 28:505-35]
- construct hyperplanes from the corresponding horizon/visible facets
- for merging in high d, do not use vertex->neighbors
</pre>
<p>Please let us know about your applications and improvements. </p>
<!-- Navigation links -->
<hr>
<p>
<b>Up:</b> <a href="http://www.qhull.org">Home page</a> for Qhull (<a href="../index.htm">local</a>) <br>
<b>Up:</b> <a href="index.htm#TOC">Qhull manual</a>: contents<br>
<b>To:</b> <a href="qh-quick.htm#programs">Programs</a>
• <a href="qh-quick.htm#options">Options</a>
• <a href="qh-opto.htm#output">Output</a>
• <a href="qh-optf.htm#format">Formats</a>
• <a href="qh-optg.htm#geomview">Geomview</a>
• <a href="qh-optp.htm#print">Print</a>
• <a href="qh-optq.htm#qhull">Qhull</a>
• <a href="qh-optc.htm#prec">Precision</a>
• <a href="qh-optt.htm#trace">Trace</a>
• <a href="http://www.qhull.org/src/libqhull_r/index.htm">Functions</a> (<a href="../src/libqhull_r/index.htm">local</a>)<br>
<b>To:</b> <a href="qh-impre.htm">Imprecision</a> in Qhull<br>
<b>To:</b> <a href="#TOC">Qhull code</a>: contents<br>
<!-- GC common information -->
<hr>
<p><a href="http://www.geom.uiuc.edu/"><img src="qh--geom.gif"
align="middle" width="40" height="40"></a><i>The Geometry Center
Home Page </i></p>
<p>Comments to: <a href=mailto:qhull@qhull.org>qhull@qhull.org</a>
<br>
Created: Sept. 25, 1995 --- <!-- hhmts start --> Last modified: see Changes.txt <!-- hhmts end --> </p>
</body>
</html>
|