Debian Codegraph @

src/common/doc/examples.h

raw
1 // List of GUDHI examples and utils - Doxygen needs at least a file tag to analyse comments
2 // Generated from scripts/cpp_examples_for_doxygen.py
3 /*! @file
4 * \section Witness_complex_example_section Witness_complex
5 * @example strong_witness_persistence.cpp
6 * @example weak_witness_persistence.cpp
7 * @example example_witness_complex_off.cpp
8 * @example example_strong_witness_complex_off.cpp
9 * @example example_nearest_landmark_table.cpp
10 * @example example_witness_complex_sphere.cpp
11 * \section Contraction_example_section Contraction
12 * @example Rips_contraction.cpp
13 * @example Garland_heckbert.cpp
14 * \section Simplex_tree_example_section Simplex_tree
15 * @example mini_simplex_tree.cpp
16 * @example cech_complex_cgal_mini_sphere_3d.cpp
17 * @example graph_expansion_with_blocker.cpp
18 * @example simple_simplex_tree.cpp
19 * @example simplex_tree_from_cliques_of_graph.cpp
20 * @example example_alpha_shapes_3_simplex_tree_from_off_file.cpp
21 * \section Persistent_cohomology_example_section Persistent_cohomology
22 * @example custom_persistence_sort.cpp
23 * @example rips_persistence_step_by_step.cpp
24 * @example persistence_from_file.cpp
25 * @example rips_persistence_via_boundary_matrix.cpp
26 * @example plain_homology.cpp
27 * @example rips_multifield_persistence.cpp
28 * @example persistence_from_simple_simplex_tree.cpp
29 * \section Subsampling_example_section Subsampling
30 * @example example_sparsify_point_set.cpp
31 * @example example_choose_n_farthest_points.cpp
32 * @example example_custom_distance.cpp
33 * @example example_pick_n_random_points.cpp
34 * \section Toplex_map_example_section Toplex_map
35 * @example simple_toplex_map.cpp
36 * \section Collapse_example_section Collapse
37 * @example distance_matrix_edge_collapse_rips_persistence.cpp
38 * @example point_cloud_edge_collapse_rips_persistence.cpp
39 * @example edge_collapse_conserve_persistence.cpp
40 * @example edge_collapse_basic_example.cpp
41 * \section Cech_complex_example_section Cech_complex
42 * @example cech_persistence.cpp
43 * @example cech_complex_example_from_points.cpp
44 * \section Bitmap_cubical_complex_example_section Bitmap_cubical_complex
45 * @example periodic_cubical_complex_persistence.cpp
46 * @example cubical_complex_persistence.cpp
47 * @example Random_bitmap_cubical_complex.cpp
48 * \section Coxeter_triangulation_example_section Coxeter_triangulation
49 * @example cell_complex_from_basic_circle_manifold.cpp
50 * @example manifold_tracing_flat_torus_with_boundary.cpp
51 * @example manifold_tracing_custom_function.cpp
52 * \section Nerve_GIC_example_section Nerve_GIC
53 * @example VoronoiGIC.cpp
54 * @example Nerve.cpp
55 * @example CoordGIC.cpp
56 * @example FuncGIC.cpp
57 * \section Tangential_complex_example_section Tangential_complex
58 * @example example_basic.cpp
59 * @example example_with_perturb.cpp
60 * \section Persistence_representations_example_section Persistence_representations
61 * @example persistence_vectors/create_persistence_vectors.cpp
62 * @example persistence_vectors/compute_scalar_product_of_persistence_vectors.cpp
63 * @example persistence_vectors/plot_persistence_vectors.cpp
64 * @example persistence_vectors/average_persistence_vectors.cpp
65 * @example persistence_vectors/compute_distance_of_persistence_vectors.cpp
66 * @example persistence_landscapes_on_grid/average_landscapes_on_grid.cpp
67 * @example persistence_landscapes_on_grid/create_landscapes_on_grid.cpp
68 * @example persistence_landscapes_on_grid/compute_distance_of_landscapes_on_grid.cpp
69 * @example persistence_landscapes_on_grid/compute_scalar_product_of_landscapes_on_grid.cpp
70 * @example persistence_landscapes_on_grid/plot_landscapes_on_grid.cpp
71 * @example persistence_intervals/compute_birth_death_range_in_persistence_diagram.cpp
72 * @example persistence_intervals/plot_persistence_Betti_numbers.cpp
73 * @example persistence_intervals/compute_bottleneck_distance.cpp
74 * @example persistence_intervals/compute_number_of_dominant_intervals.cpp
75 * @example persistence_intervals/plot_histogram_of_intervals_lengths.cpp
76 * @example persistence_intervals/plot_persistence_intervals.cpp
77 * @example persistence_heat_maps/compute_distance_of_persistence_heat_maps.cpp
78 * @example persistence_heat_maps/create_pssk.cpp
79 * @example persistence_heat_maps/create_p_h_m_weighted_by_arctan_of_their_persistence.cpp
80 * @example persistence_heat_maps/create_p_h_m_weighted_by_distance_from_diagonal.cpp
81 * @example persistence_heat_maps/create_p_h_m_weighted_by_squared_diag_distance.cpp
82 * @example persistence_heat_maps/compute_scalar_product_of_persistence_heat_maps.cpp
83 * @example persistence_heat_maps/plot_persistence_heat_map.cpp
84 * @example persistence_heat_maps/create_persistence_heat_maps.cpp
85 * @example persistence_heat_maps/average_persistence_heat_maps.cpp
86 * @example persistence_landscapes/compute_distance_of_landscapes.cpp
87 * @example persistence_landscapes/compute_scalar_product_of_landscapes.cpp
88 * @example persistence_landscapes/average_landscapes.cpp
89 * @example persistence_landscapes/plot_landscapes.cpp
90 * @example persistence_landscapes/create_landscapes.cpp
91 * @example persistence_landscape_on_grid.cpp
92 * @example persistence_intervals.cpp
93 * @example persistence_landscape.cpp
94 * @example persistence_vectors.cpp
95 * @example sliced_wasserstein.cpp
96 * @example persistence_heat_maps.cpp
97 * \section Spatial_searching_example_section Spatial_searching
98 * @example example_spatial_searching.cpp
99 * \section Bottleneck_distance_example_section Bottleneck_distance
100 * @example bottleneck_distance.cpp
101 * @example bottleneck_basic_example.cpp
102 * @example alpha_rips_persistence_bottleneck_distance.cpp
103 * \section common_example_section common
104 * @example off_file_from_shape_generator.cpp
105 * @example example_vector_double_points_off_reader.cpp
106 * @example example_CGAL_points_off_reader.cpp
107 * @example example_CGAL_3D_points_off_reader.cpp
108 * \section Alpha_complex_example_section Alpha_complex
109 * @example alpha_complex_3d_persistence.cpp
110 * @example alpha_complex_persistence.cpp
111 * @example Fast_alpha_complex_from_off.cpp
112 * @example Alpha_complex_3d_from_points.cpp
113 * @example Alpha_complex_from_off.cpp
114 * @example Weighted_alpha_complex_3d_from_points.cpp
115 * @example Weighted_alpha_complex_from_points.cpp
116 * @example Alpha_complex_from_points.cpp
117 * \section Skeleton_blocker_example_section Skeleton_blocker
118 * @example Skeleton_blocker_from_simplices.cpp
119 * @example Skeleton_blocker_link.cpp
120 * @example Skeleton_blocker_iteration.cpp
121 * \section Rips_complex_example_section Rips_complex
122 * @example rips_persistence.cpp
123 * @example rips_correlation_matrix_persistence.cpp
124 * @example sparse_rips_persistence.cpp
125 * @example rips_distance_matrix_persistence.cpp
126 * @example example_sparse_rips.cpp
127 * @example example_rips_complex_from_csv_distance_matrix_file.cpp
128 * @example example_one_skeleton_rips_from_correlation_matrix.cpp
129 * @example example_one_skeleton_rips_from_distance_matrix.cpp
130 * @example example_one_skeleton_rips_from_points.cpp
131 * @example example_rips_complex_from_off_file.cpp
132 * \section Zigzag_persistence_example_section Zigzag_persistence
133 * @example example_usage_zigzag_persistence.cpp
134 * @example example_usage_filtered_zigzag_persistence.cpp
135 * @example example_usage_filtered_zigzag_persistence_with_storage.cpp
136 * @example example_zigzag_filtration_as_input_loop.cpp
137 * @example example_zzfiltration_from_file.cpp
138 * \section Persistence_matrix_example_section Persistence_matrix
139 * @example example_representative_cycles_from_matrix.cpp
140 * @example example_simplex_tree_to_matrix.cpp
141 * \section Persistence_fields_example_section Persistence_field
142 * @example example_field_operations.cpp
143 */
144