-
Notifications
You must be signed in to change notification settings - Fork 124
/
Triangulation.h
3015 lines (2776 loc) · 117 KB
/
Triangulation.h
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
/// \ingroup base
/// \class ttk::Triangulation
/// \author Julien Tierny <[email protected]>
/// \date January 2016.
///
/// \brief Triangulation is a class that provides time and memory efficient
/// traversal methods on triangulations of piecewise linear manifolds. It
/// provides the following features:
/// -# Given a vertex, it provides: the list of edges that are connected to
/// it, the list of its neighbors, its link, its star, etc.
/// -# Given an edge, it provides: its vertices, its star, etc.
/// -# Given a triangle, its provides: its vertices, its edges, etc.
/// -# Given a tetrahedron, its provides: its vertices, its edges, its
/// neighbor tetrahedra, etc.
/// -# Given a triangulation, it provides: its list of vertices, edges,
/// triangles and tetrahedra.
///
/// Triangulation supports both explicit and implicit triangulations:
/// -# Explicit triangulations: Given a list of points and a list of cells,
/// Triangulation provides time efficient accesses (requiring adequate
/// preconditioning, see the documentation furtherdown).
/// -# Implicit triangulations: Given a regular grid (origin, spacings and
/// dimensions), Triangulation will perform an implicit triangulation of the
/// grid, enabling both time and memory efficient traversals of triangulations
/// of regular grids.
///
/// Apart from preconditions, Triangulation requires no memory overhead in
/// addition to the input data.
///
/// \note
/// Only precondition the information you need! See the documentation further
/// down.
/// \sa ttkTriangulation
#pragma once
// base code includes
#include <AbstractTriangulation.h>
#include <CompactTriangulation.h>
#include <ExplicitTriangulation.h>
#include <ImplicitTriangulation.h>
#include <PeriodicImplicitTriangulation.h>
#include <array>
namespace ttk {
class Triangulation final : public AbstractTriangulation {
public:
Triangulation();
Triangulation(const Triangulation &);
Triangulation(Triangulation &&) noexcept;
Triangulation &operator=(const Triangulation &);
Triangulation &operator=(Triangulation &&) noexcept;
~Triangulation() override;
enum class Type {
EXPLICIT,
IMPLICIT,
HYBRID_IMPLICIT,
PERIODIC,
HYBRID_PERIODIC,
COMPACT
};
/**
* Strategies for implicit & periodic triangulations preconditioning
*/
enum class STRATEGY {
/** No preconditions above a number of vertices threshold (given
by TTK_IMPLICIT_PRECONDITIONS_THRESHOLD, default to
256^3) */
DEFAULT = 0,
/** Always precondition implicit & periodic triangulations */
WITH_PRECONDITIONS = 1,
/** Never precondition implicit & periodic triangulations */
NO_PRECONDITIONS = 2,
};
/// Reset the triangulation data-structures.
/// \return Returns 0 upon success, negative values otherwise.
inline int clear() {
if(abstractTriangulation_) {
return abstractTriangulation_->clear();
}
return 0;
}
/// Computes and displays the memory footprint of the data-structure.
/// \return Returns 0 upon success, negative values otherwise.
inline size_t footprint() const {
if(abstractTriangulation_) {
return abstractTriangulation_->footprint();
}
return 0;
}
/// Get the \p localEdgeId-th edge of the \p cellId-th cell.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
///
/// In 1D, this function is equivalent to getCellNeighbor().
///
/// \pre For this function to behave correctly,
/// preconditionCellEdges() needs to be called on this object prior to any
/// traversal, in a clearly distinct pre-processing step that involves no
/// traversal at all. An error will be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
///
/// \param cellId Input global cell identifier.
/// \param localEdgeId Input local edge identifier,
/// in [0, getCellEdgeNumber()].
/// \param edgeId Output global edge identifier.
/// \return Returns 0 upon success, negative values otherwise.
/// \sa getCellEdgeNumber()
/// \sa getCellNeighbor()
inline int getCellEdge(const SimplexId &cellId,
const int &localEdgeId,
SimplexId &edgeId) const override {
// initialize output variable before early return
edgeId = -1;
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getCellEdge(cellId, localEdgeId, edgeId);
}
/// Get the number of edges for the \p cellId-th cell.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
///
/// In 1D, this function is equivalent to getCellNeighborNumber().
///
/// \pre For this function to behave correctly, preconditionCellEdges()
/// needs to be called on this object prior to any traversal, in a
/// clearly distinct pre-processing step that involves no traversal at
/// all. An error will be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \param cellId Input global cell identifier.
/// \return Returns the number of cell edges.
/// \sa getCellNeighborNumber()
inline SimplexId getCellEdgeNumber(const SimplexId &cellId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getCellEdgeNumber(cellId);
}
/// \warning
/// YOU SHOULD NOT CALL THIS FUNCTION UNLESS YOU REALLY KNOW WHAT YOU ARE
/// DOING.
///
/// Get the list of edges for all cells.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
///
/// The number of entries in this list is equal to the number of cells.
/// Each entry is a std::vector of identifiers whose size is equal to the
/// number of edges for the corresponding cell.
///
/// In implicit mode, this function will force the creation of such a
/// list (which will be time and memory consuming).
/// THIS IS USUALLY A BAD IDEA.
///
/// In 1D, this function is equivalent to getCellNeighbors().
///
/// \pre For this function to behave correctly,
/// preconditionCellEdges() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \return Returns a pointer to the cell edge list.
/// \sa getCellNeighbors()
inline const std::vector<std::vector<SimplexId>> *getCellEdges() override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return nullptr;
#endif
return abstractTriangulation_->getCellEdges();
}
inline int
getCellIncenter(SimplexId cellId, int dim, float incenter[3]) const {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getCellIncenter(cellId, dim, incenter);
}
/// Get the \p localNeighborId-th cell neighbor of the \p cellId-th cell.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
///
/// \pre For this function to behave correctly,
/// preconditionCellNeighbors() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
///
/// \param cellId Input global cell identifier.
/// \param localNeighborId Input local neighbor identifier,
/// in [0, getCellNeighborNumber()].
/// \param neighborId Output global neighbor cell identifier.
/// \return Returns 0 upon success, negative values otherwise.
/// \sa getCellNeighborNumber()
inline int getCellNeighbor(const SimplexId &cellId,
const int &localNeighborId,
SimplexId &neighborId) const override {
// initialize output variable before early return
neighborId = -1;
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getCellNeighbor(
cellId, localNeighborId, neighborId);
}
/// Get the number of cell neighbors for the \p cellId-th cell.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
///
/// \pre For this function to behave correctly,
/// preconditionCellNeighbors() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \param cellId Input global cell identifier.
/// \return Returns the number of cell neighbors.
inline SimplexId
getCellNeighborNumber(const SimplexId &cellId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getCellNeighborNumber(cellId);
}
/// \warning
/// YOU SHOULD NOT CALL THIS FUNCTION UNLESS YOU REALLY KNOW WHAT YOU ARE
/// DOING.
///
/// Get the list of cell neighbors for all cells.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
///
/// The number of entries in this list is equal to the number of cells.
/// Each entry is a std::vector of identifiers whose size is equal to the
/// number of neighbor cells for the corresponding cell.
///
/// In implicit mode, this function will force the creation of such a
/// list (which will be time and memory consuming).
/// THIS IS USUALLY A BAD IDEA.
///
/// \pre For this function to behave correctly,
/// preconditionCellNeighbors() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \return Returns a pointer to the cell neighbor list.
inline const std::vector<std::vector<SimplexId>> *
getCellNeighbors() override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return nullptr;
#endif
return abstractTriangulation_->getCellNeighbors();
}
/// Get the \p localTriangleId-th triangle id of the \p cellId-th cell.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
///
/// In 2D, this function is equivalent to getCellNeighbor().
///
/// \pre For this function to behave correctly,
/// preconditionCellTriangles() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
///
/// \param cellId Input global cell identifier.
/// \param localTriangleId Input local triangle identifier,
/// in [0, getCellTriangleNumber()].
/// \param triangleId Output global triangle identifier.
/// \return Returns 0 upon success, negative values otherwise.
/// \sa getCellTriangleNumber()
/// \sa getCellNeighbor()
inline int getCellTriangle(const SimplexId &cellId,
const int &localTriangleId,
SimplexId &triangleId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
// initialize output variable before early return
triangleId = -1;
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getCellTriangle(
cellId, localTriangleId, triangleId);
}
/// Get the number of triangles for the \p cellId-th cell.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
///
/// In 2D, this function is equivalent to getCellNeighborNumber().
///
/// \pre For this function to behave correctly,
/// preconditionCellTriangles() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \param cellId Input global cell identifier.
/// \return Returns the number of cell triangles.
/// \sa getCellNeighborNumber()
inline SimplexId
getCellTriangleNumber(const SimplexId &cellId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getCellTriangleNumber(cellId);
}
/// \warning
/// YOU SHOULD NOT CALL THIS FUNCTION UNLESS YOU REALLY KNOW WHAT YOU ARE
/// DOING.
///
/// Get the list of triangles for all cells.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
///
/// Also, the notion of triangle only makes sense if the triangulation
/// has a dimension greater than 2 (otherwise, use the cell information).
///
/// The number of entries in this list is equal to the number of cells.
/// Each entry is a std::vector of identifiers whose size is equal to the
/// number of triangles for the corresponding cell.
///
/// In implicit mode, this function will force the creation of such a
/// list (which will be time and memory consuming).
/// THIS IS USUALLY A BAD IDEA.
///
/// In 2D, this function is equivalent to getCellNeighbors().
///
/// \pre For this function to behave correctly,
/// preconditionCellTriangles() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \return Returns a pointer to the cell triangle list.
/// \sa getCellNeighbors()
inline const std::vector<std::vector<SimplexId>> *
getCellTriangles() override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return nullptr;
#endif
return abstractTriangulation_->getCellTriangles();
}
/// Get the \p localVertexId-th vertex identifier of the \p cellId-th
/// cell.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
/// \param cellId Input global cell identifier.
/// \param localVertexId Input local vertex identifier,
/// in [0, getCellVertexNumber()].
/// \param vertexId Output global vertex identifier.
/// \return Returns 0 upon success, negative values otherwise.
/// \sa getCellVertexNumber()
inline int getCellVertex(const SimplexId &cellId,
const int &localVertexId,
SimplexId &vertexId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
// initialize output variable before early return
vertexId = -1;
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getCellVertex(
cellId, localVertexId, vertexId);
}
/// Get the number of vertices in a cell.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
/// \param cellId Input global cell identifier.
/// \returns Number of vertices in the cell.
inline SimplexId
getCellVertexNumber(const SimplexId &cellId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getCellVertexNumber(cellId);
}
/// Get the dimensionality of the triangulation (this value is equal to
/// the dimension of the simplex with largest dimensionality).
/// \return Returns the dimensionality of the triangulation.
inline int getDimensionality() const override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getDimensionality();
}
/// \warning
/// YOU SHOULD NOT CALL THIS FUNCTION UNLESS YOU REALLY KNOW WHAT YOU ARE
/// DOING.
///
/// Get the list of edges of the triangulation.
///
/// Here the notion of edge only makes sense if the triangulation has a
/// dimension greater than 1 (otherwise, use the cell information).
///
/// The number of entries in this list is equal to the number of edges.
/// Each entry is a std::pair of vertex identifiers.
///
/// In implicit mode, this function will force the creation of such a
/// list (which will be time and memory consuming).
/// THIS IS USUALLY A BAD IDEA.
///
/// \pre For this function to behave correctly,
/// preconditionEdges() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \return Returns a pointer to the edge list.
inline const std::vector<std::array<SimplexId, 2>> *getEdges() override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return nullptr;
#endif
return abstractTriangulation_->getEdges();
}
/// Compute the barycenter of the points of the given edge identifier.
/// \pre For this function to behave correctly,
/// preconditionEdges() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \param edgeId Input global edge identifier.
/// \param incenter Output barycenter.
/// \return Returns 0 upon success, negative values otherwise.
/// \sa getTriangleIncenter()
/// \sa getCellIncenter()
inline int getEdgeIncenter(SimplexId edgeId, float incenter[3]) const {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getEdgeIncenter(edgeId, incenter);
}
/// Compute the barycenter of the points of the given triangle identifier.
/// \pre For this function to behave correctly,
/// preconditionTriangles() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \param triangleId Input global triangle identifier.
/// \param incenter Output barycenter.
/// \return Returns 0 upon success, negative values otherwise.
/// \sa getEdgeIncenter()
/// \sa getCellIncenter()
inline int getTriangleIncenter(SimplexId triangleId,
float incenter[3]) const {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getTriangleIncenter(triangleId, incenter);
}
/// Get the \p localLinkId-th simplex of the link of the \p edgeId-th
/// edge.
///
/// The output \p linkId refers in 2D to a vertex identifier and in 3D
/// to an edge identifier. It returns a negative value in 1D.
///
/// \pre For this function to behave correctly,
/// preconditionEdgeLinks() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \param edgeId Input global edge identifier.
/// \param localLinkId Input local link simplex identifier,
/// in [0, getEdgeLinkNumber()].
/// \param linkId Output link simplex identifier.
/// \return Returns 0 upon success, negative values otherwise.
/// \sa getEdgeLinkNumber()
inline int getEdgeLink(const SimplexId &edgeId,
const int &localLinkId,
SimplexId &linkId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
// initialize output variable before early return
linkId = -1;
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getEdgeLink(edgeId, localLinkId, linkId);
}
/// Get the number of simplicies in the link of the \p edgeId-th edge.
///
/// In 2D, this will return the number of vertices in the link, in 3D the
/// number of edges. It returns a negative value in 1D.
///
/// \pre For this function to behave correctly,
/// preconditionEdgeLinks() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \param edgeId Input global edge identifier.
/// \return Returns the number of cells in the link of the edge.
inline SimplexId getEdgeLinkNumber(const SimplexId &edgeId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getEdgeLinkNumber(edgeId);
}
/// \warning
/// YOU SHOULD NOT CALL THIS FUNCTION UNLESS YOU REALLY KNOW WHAT YOU ARE
/// DOING.
///
/// Get the list of link simplices for all edges.
///
/// The number of entries in this list is equal to the number of edges.
/// Each entry is a std::vector of identifiers representing vertices in
/// 2D and
/// edges in 3D. It returns NULL in 1D.
///
/// In implicit mode, this function will force the creation of such a
/// list (which will be time and memory consuming).
/// THIS IS USUALLY A BAD IDEA.
///
/// \pre For this function to behave correctly,
/// preconditionEdgeLinks() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \return Returns a pointer to the edge link list.
inline const std::vector<std::vector<SimplexId>> *getEdgeLinks() override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return nullptr;
#endif
return abstractTriangulation_->getEdgeLinks();
}
/// Get the \p localStarId-th cell of the star of the \p edgeId-th edge.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
///
/// Also, the notion of edge only makes sense if the triangulation has a
/// dimension greater than 1 (otherwise, use the cell information).
///
/// \pre For this function to behave correctly,
/// preconditionEdgeStars() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
///
/// \param edgeId Input global edge identifier.
/// \param localStarId Input local star cell identifier,
/// in [0, getEdgeStarNumber()].
/// \param starId Output global star cell identifier.
/// \return Returns 0 upon success, negative values otherwise.
/// \sa getEdgeStarNumber()
inline int getEdgeStar(const SimplexId &edgeId,
const int &localStarId,
SimplexId &starId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
// initialize output variable before early return
starId = -1;
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getEdgeStar(edgeId, localStarId, starId);
}
/// Get the number of star cells for the \p edgeId-th edge.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
///
/// Also, the notion of edge only makes sense if the triangulation has a
/// dimension greater than 1 (otherwise, use the cell information).
///
/// \pre For this function to behave correctly,
/// preconditionEdgeStars() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \param edgeId Input global edge identifier
/// \return Returns the number of star cells.
inline SimplexId getEdgeStarNumber(const SimplexId &edgeId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getEdgeStarNumber(edgeId);
}
/// \warning
/// YOU SHOULD NOT CALL THIS FUNCTION UNLESS YOU REALLY KNOW WHAT YOU ARE
/// DOING.
///
/// Get the list of star cell identifiers for all edges.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
///
/// Also, the notion of edge only makes sense if the triangulation has a
/// dimension greater than 1 (otherwise, use the cell information).
///
/// The number of entries in this list is equal to the number of edges.
/// Each entry is a std::vector of identifiers whose size is equal to the
/// number of star cells for the corresponding edge.
///
/// In implicit mode, this function will force the creation of such a
/// list (which will be time and memory consuming).
/// THIS IS USUALLY A BAD IDEA.
///
/// \pre For this function to behave correctly,
/// preconditionEdgeStars() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \return Returns a pointer to the edge star list.
inline const std::vector<std::vector<SimplexId>> *getEdgeStars() override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return nullptr;
#endif
return abstractTriangulation_->getEdgeStars();
}
/// Get the \p localTriangleId-th triangle id of the \p edgeId-th edge.
///
/// In 2D, this function is equivalent to getEdgeStar().
///
/// \pre For this function to behave correctly,
/// preconditionEdgeTriangles() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
///
/// \param edgeId Input global edge identifier.
/// \param localTriangleId Input local triangle identifier,
/// in [0, getEdgeTriangleNumber()].
/// \param triangleId Output global triangle identifier.
/// \return Returns 0 upon success, negative values otherwise.
/// \sa getEdgeTriangleNumber()
/// \sa getEdgeStar()
inline int getEdgeTriangle(const SimplexId &edgeId,
const int &localTriangleId,
SimplexId &triangleId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
// initialize output variable before early return
triangleId = -1;
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getEdgeTriangle(
edgeId, localTriangleId, triangleId);
}
/// Get the number of triangles for the \p edgeId-th edge.
///
/// In 2D, this function is equivalent to getEdgeStarNumber().
///
/// \pre For this function to behave correctly,
/// preconditionEdgeTriangles() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \param edgeId Input global edge identifier.
/// \return Returns the number of edge triangles.
/// \sa getEdgeStarNumber
inline SimplexId
getEdgeTriangleNumber(const SimplexId &edgeId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getEdgeTriangleNumber(edgeId);
}
/// \warning
/// YOU SHOULD NOT CALL THIS FUNCTION UNLESS YOU REALLY KNOW WHAT YOU ARE
/// DOING.
///
/// Get the list of triangles for all edges.
///
/// The number of entries in this list is equal to the number of edges.
/// Each entry is a std::vector of identifiers whose size is equal to the
/// number of triangles for the corresponding edge.
///
/// In implicit mode, this function will force the creation of such a
/// list (which will be time and memory consuming).
/// THIS IS USUALLY A BAD IDEA.
///
/// In 2D, this function is equivalent to getEdgeStars().
///
/// \pre For this function to behave correctly,
/// preconditionEdgeTriangles() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \return Returns a pointer to the edge triangle list.
/// \sa getEdgeStars
inline const std::vector<std::vector<SimplexId>> *
getEdgeTriangles() override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return nullptr;
#endif
return abstractTriangulation_->getEdgeTriangles();
}
/// Get the \p localVertexId-th vertex identifier of the \p edgeId-th
/// edge.
///
/// In 1D, this function is equivalent to getCellVertex().
///
/// \pre For this function to behave correctly,
/// preconditionEdges() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \param edgeId Input global edge identifier.
/// \param localVertexId Input local vertex identifier (0 or 1).
/// \param vertexId Output global vertex identifier.
/// \return Returns 0 upon success, negative values otherwise.
/// \sa getCellVertex()
inline int getEdgeVertex(const SimplexId &edgeId,
const int &localVertexId,
SimplexId &vertexId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
// initialize output variable before early return
vertexId = -1;
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getEdgeVertex(
edgeId, localVertexId, vertexId);
}
/// Get the internal abstract triangulation object.
/// \return Returns a pointer to the internal abstract triangulation object.
inline AbstractTriangulation *getData() {
return abstractTriangulation_;
}
/// Get the number of cells in the triangulation.
///
/// Here the notion of cell refers to the simplicices of maximal
/// dimension (3D: tetrahedra, 2D: triangles, 1D: edges).
/// \return Returns the number of cells.
inline SimplexId getNumberOfCells() const override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getNumberOfCells();
}
/// Get the number of edges in the triangulation.
///
/// In 1D, this function is equivalent to getNumberOfCells().
///
/// \pre For this function to behave correctly,
/// preconditionEdges() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \return Returns the number of edges.
/// \sa getNumberOfCells()
inline SimplexId getNumberOfEdges() const override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getNumberOfEdges();
}
/// Get the number of triangles in the triangulation.
///
/// In 2D, this function is equivalent to getNumberOfCells().
///
/// \pre For this function to behave correctly,
/// preconditionTriangles() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \return Returns the number of triangles.
/// \sa getNumberOfCells()
inline SimplexId getNumberOfTriangles() const override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getNumberOfTriangles();
}
/// Get the number of vertices in the triangulation.
/// \return Returns the number of vertices.
inline SimplexId getNumberOfVertices() const override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getNumberOfVertices();
}
/// Compute the barycenter of the points of the given tet identifier.
/// \param tetraId Input global tet identifier.
/// \param incenter Output barycenter.
/// \return Returns 0 upon success, negative values otherwise.
/// \sa getTriangleIncenter()
/// \sa getEdgeIncenter()
int getTetraIncenter(SimplexId tetraId, float incenter[3]) const {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getTetraIncenter(tetraId, incenter);
}
/// \warning
/// YOU SHOULD NOT CALL THIS FUNCTION UNLESS YOU REALLY KNOW WHAT YOU ARE
/// DOING.
///
/// Get the list of triangles of the triangulation.
///
/// Here the notion of triangle only makes sense if the triangulation has
/// a dimension greater than 2 (otherwise, use the cell information).
///
/// The number of entries in this list is equal to the number of
/// triangles.
/// Each entry is a std::vector of vertex identifiers.
///
/// In implicit mode, this function will force the creation of such a
/// list (which will be time and memory consuming).
/// THIS IS USUALLY A BAD IDEA.
/// \pre For this function to behave correctly,
/// preconditionTriangles() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \return Returns a pointer to the triangle list.
inline const std::vector<std::array<SimplexId, 3>> *
getTriangles() override {
#ifndef TTK_ENABLE_KAMIKAZE
if(isEmptyCheck())
return nullptr;
#endif
return abstractTriangulation_->getTriangles();
}
/// Get the \p localEdgeId-th edge of the \p triangleId-th triangle.
///
/// In 2D, this function is equivalent to getCellEdge().
///
/// \pre For this function to behave correctly,
/// preconditionTriangleEdges() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \param triangleId Input global triangle identifier.
/// \param localEdgeId Input local edge identifier,
/// in [0, getTriangleEdgeNumber()].
/// \param edgeId Output global edge identifier.
/// \return Returns 0 upon success, negative values otherwise.
/// \sa getTriangleEdgeNumber()
/// \sa getCellEdge()
inline int getTriangleEdge(const SimplexId &triangleId,
const int &localEdgeId,
SimplexId &edgeId) const override {
#ifndef TTK_ENABLE_KAMIKAZE
// initialize output variable before early return
edgeId = -1;
if(isEmptyCheck())
return -1;
#endif
return abstractTriangulation_->getTriangleEdge(
triangleId, localEdgeId, edgeId);
}
/// Get the number of edges of the \p triangleId-th triangle.
///
/// In 2D, this function is equivalent to getCellEdgeNumber().
///
/// \pre For this function to behave correctly,
/// preconditionTriangleEdges() needs to be called
/// on this object prior to any traversal, in a clearly distinct
/// pre-processing step that involves no traversal at all. An error will
/// be returned otherwise.
/// \note It is recommended to exclude such a preconditioning step
/// from any time performance measurement.
/// \param triangleId Input global triangle identifier.
/// \return Returns the number of cells in the link of the triangle.
/// \sa getCellEdgeNumber()
inline SimplexId
getTriangleEdgeNumber(const SimplexId &triangleId) const override {
#ifndef TTK_ENABLE_KAMIKAZE