songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improve doc

This commit is contained in:
Sébastien Loriot 2018-09-14 14:56:03 +02:00
parent 6424377a94
commit 342e815d85
4 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Surface_mesh_approximation/doc/Surface_mesh_approximation/Concepts/ErrorMetricProxy.h
View File

@ -15,25 +15,25 @@ public:
/// Number type model of `Field` and `RealEmbeddable`
typedef unspecified_type FT;
/// Triangle mesh
typedef unspecified_type TriangleMesh;
typedef unspecified_type Triangle_mesh;
/// Triangle mesh face descriptor
typedef unspecified_type face_descriptor;
/// Parameterized shape proxy
/// Shape proxy type
typedef unspecified_type Proxy;
/// @name Operations
/// A model of this concept must provide:
/// @{
/// Computes and returns fitting error from face f to proxy.
FT compute_error(const face_descriptor f, const TriangleMesh &tm, const Proxy &proxy) const;
/// returns fitting error from face f to proxy.
FT compute_error(const face_descriptor f, const Triangle_mesh &tm, const Proxy &proxy) const;
/// Computes and returns fitted proxy from a range of faces.
/// returns a fitted proxy to a range of faces.
/// @tparam FaceRange a range of
/// `boost::graph_traits<TriangleMesh>::%face_descriptor` model of `ConstRange`
/// with iterator type being model of `InputIterator`.
template <typename FaceRange>
Proxy fit_proxy(const FaceRange &faces, const TriangleMesh &tm) const;
Proxy fit_proxy(const FaceRange &faces, const Triangle_mesh &tm) const;
/// }

2
Surface_mesh_approximation/include/CGAL/Surface_mesh_approximation/L21_metric_plane_proxy.h
View File

@ -65,6 +65,8 @@ class L21_metric_plane_proxy {
typedef typename boost::property_map<TriangleMesh, Face_normal_tag>::type Face_normal_map;
typedef typename boost::property_map<TriangleMesh, Face_area_tag>::type Face_area_map;
typedef TriangleMesh Triangle_mesh;
public:
/// \name Types
/// @{

2
Surface_mesh_approximation/include/CGAL/Surface_mesh_approximation/L2_metric_plane_proxy.h
View File

@ -63,6 +63,8 @@ class L2_metric_plane_proxy {
typedef CGAL::dynamic_face_property_t<FT> Face_area_tag;
typedef typename boost::property_map<TriangleMesh, Face_area_tag>::type Face_area_map;
typedef TriangleMesh Triangle_mesh;
public:
/// \name Types
/// @{

24
Surface_mesh_approximation/include/CGAL/Variational_shape_approximation.h
View File

@ -404,7 +404,7 @@ public:
/*!
* @brief calls `run` while error decrease is greater than `cvg_threshold`.
* @param cvg_threshold the percentage of error change between two successive runs,
* should be in range (0, 1).
* should be in range `(0, 1)`.
* @param max_iterations maximum number of iterations allowed
* @param avg_interval size of error average interval to have smoother convergence curve,
* if 0 is assigned, 1 is used instead.
@ -870,7 +870,7 @@ public:
* \cgalParamBegin{face_proxy_map} a ReadWritePropertyMap with
* `boost::graph_traits<TriangleMesh>::%face_descriptor` as key and `std::size_t` as value type.
* A proxy is a set of connected faces which are placed under the same proxy patch (see \cgalFigureRef{iterations}).
* The proxy-ids are contiguous in range [0, number_of_proxies() - 1].
* The proxy-ids are contiguous in range `[0, number_of_proxies() - 1]`.
* \cgalParamEnd
* \cgalParamBegin{proxies} output iterator over proxies.
* \cgalParamEnd
@ -1024,7 +1024,7 @@ private:
* @brief randomly initializes proxies to target number of proxies.
* @note To ensure the randomness, call `std::srand()` beforehand.
* @param max_nb_proxies maximum number of proxies,
* should be in range (nb_connected_components, num_faces(*m_ptm))
* should be in range `(nb_connected_components, num_faces(*m_ptm))`
* @param nb_iterations number of re-fitting iterations
* @return number of proxies initialized
*/
@ -1044,7 +1044,7 @@ private:
/*!
* @brief incrementally initializes proxies to target number of proxies.
* @param max_nb_proxies maximum number of proxies,
* should be in range (nb_connected_components, num_faces(*m_ptm))
* should be in range `(nb_connected_components, num_faces(*m_ptm))`
* @param nb_iterations number of re-fitting iterations
* before each incremental proxy insertion
* @return number of proxies initialized
@ -1060,7 +1060,7 @@ private:
/*!
* @brief hierarchically initializes proxies to target number of proxies.
* @param max_nb_proxies maximum number of proxies,
* should be in range (nb_connected_components, num_faces(*m_ptm))
* should be in range `(nb_connected_components, num_faces(*m_ptm))`
* @param nb_iterations number of re-fitting iterations
* before each hierarchical proxy insertion
* @return number of proxies initialized
@ -1087,8 +1087,8 @@ private:
* with both maximum number of proxies and minimum error drop stop criteria,
* where the first criterion met stops the seeding.
* @note To ensure the randomness, call `std::srand()` beforehand.
* @param max_nb_proxies maximum number of proxies, should be in range (nb_connected_components, num_faces(tm) / 3)
* @param min_error_drop minimum error drop, should be in range (0.0, 1.0)
* @param max_nb_proxies maximum number of proxies, should be in range `(nb_connected_components, num_faces(tm) / 3)`
* @param min_error_drop minimum error drop, should be in range `(0.0, 1.0)`
* @param nb_iterations number of re-fitting iterations
* @return number of proxies initialized
*/
@ -1122,8 +1122,8 @@ private:
* @brief incrementally initializes proxies
* with both maximum number of proxies and minimum error drop stop criteria,
* The first criterion met stops the seeding.
* @param max_nb_proxies maximum number of proxies, should be in range (nb_connected_components, num_faces(tm) / 3)
* @param min_error_drop minimum error drop, should be in range (0.0, 1.0)
* @param max_nb_proxies maximum number of proxies, should be in range `(nb_connected_components, num_faces(tm) / 3)`
* @param min_error_drop minimum error drop, should be in range `(0.0, 1.0)`
* @param nb_iterations number of re-fitting iterations
* @return number of proxies initialized
*/
@ -1145,8 +1145,8 @@ private:
* @brief hierarchically initializes proxies
* with both maximum number of proxies and minimum error drop stop criteria,
* where the first criterion met stops the seeding.
* @param max_nb_proxies maximum number of proxies, should be in range (nb_connected_components, num_faces(tm) / 3)
* @param min_error_drop minimum error drop, should be in range (0.0, 1.0)
* @param max_nb_proxies maximum number of proxies, should be in range `(nb_connected_components, num_faces(tm) / 3)`
* @param min_error_drop minimum error drop, should be in range `(0.0, 1.0)`
* @param nb_iterations number of re-fitting iterations
* @return number of proxies initialized
*/
@ -1806,7 +1806,7 @@ private:
}
/*!
* @brief subdivides a chord recursively in range [@a chord_begin, @a chord_end).
* @brief subdivides a chord recursively in range `[@a chord_begin, @a chord_end).`
* @param chord_begin begin iterator of the chord
* @param chord_end end iterator of the chord
* @param subdivision_ratio the chord recursive split error threshold