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

fix concept page

This commit is contained in:
Lingjie Zhu 2018-01-04 10:45:04 +08:00
parent b66c35aa83
commit 2911a86b2f
3 changed files with 17 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Surface_mesh_approximation/doc/Surface_mesh_approximation/Concepts/ErrorMetric.h
View File

@ -2,19 +2,18 @@
\ingroup PkgTSMAConcepts \ingroup PkgTSMAConcepts
\cgalConcept \cgalConcept
The concept `ErrorMetric` is requied to operate on a facet and a proxy, returns the fitting error. The concept `ErrorMetric` computes the fitting error of a face to a `Proxy`, used in CGAL::VSA::Mesh_approximation.
It is used in the functions `vsa_mesh_approximation()` and `vsa_mesh_segmentation()`.
\cgalHasModel `L21Metric` \cgalHasModel `CGAL::VSA::L21_metric`
\cgalHasModel `L2Metric` \cgalHasModel `CGAL::VSA::L2_metric`
*/ */
class ErrorMetric { class ErrorMetric {
public: public:
/// A number type model of `Field` and `RealEmbeddable` /// A number type model of `Field` and `RealEmbeddable`
typedef unspecified_type FT; typedef unspecified_type FT;
/// Triangle mesh facet descriptor. /// Triangle mesh face descriptor.
typedef unspecified_type facet_descriptor; typedef unspecified_type face_descriptor;
/// Parametrized shape proxy. /// Parametrized shape proxy.
typedef unspecified_type Proxy; typedef unspecified_type Proxy;
@ -22,8 +21,8 @@ public:
/// A model of this concept must provide: /// A model of this concept must provide:
/// @{ /// @{
/// returns the fitting error of a facet f to the proxy px. /// returns the fitting error of a face f to the proxy px.
FT operator()(const facet_descriptor &f, const Proxy &px) const; FT operator()(const face_descriptor &f, const Proxy &px) const;
/// } /// }
}; };

7
Surface_mesh_approximation/doc/Surface_mesh_approximation/Concepts/Proxy.h
View File

@ -2,10 +2,11 @@
\ingroup PkgTSMAConcepts \ingroup PkgTSMAConcepts
\cgalConcept \cgalConcept
The concept `Proxy` describes the primitive shape used in the Variational Shape Approximation algorithm. The concept `Proxy` describes the primitive shape, nested within the `ErrorMetric` and `ProxyFitting` concepts.
It is nested within the `ErrorMetric` and `ProxyFitting` concepts.
\cgalHasModel `Plane_proxy` It can contain anything to store the primitive shape parameters.
\cgalHasModel `CGAL::VSA::Plane_proxy`
*/ */
class Proxy { class Proxy {

13
Surface_mesh_approximation/doc/Surface_mesh_approximation/Concepts/ProxyFitting.h
View File

@ -2,11 +2,10 @@
\ingroup PkgTSMAConcepts \ingroup PkgTSMAConcepts
\cgalConcept \cgalConcept
The concept `ProxyFitting` is required to fit a shape `Proxy` from a range of facets. The concept `ProxyFitting` fits a shape primitive `Proxy` from a range of facets, used in CGAL::VSA::Mesh_approximation.
It is used in the functions `vsa_mesh_approximation()`.
\cgalHasModel `L21ProxyFitting` \cgalHasModel `CGAL::VSA::L21_proxy_fitting`
\cgalHasModel `L2ProxyFitting` \cgalHasModel `CGAL::VSA::L2_proxy_fitting`
*/ */
class ProxyFitting { class ProxyFitting {
@ -18,9 +17,9 @@ public:
/// A model of this concept must provide: /// A model of this concept must provide:
/// @{ /// @{
/// returns the fitting proxy from a range of facets. /// returns the fitted proxy from a range of facets.
template<FacetsIterator> template <typename FacetIterator>
Proxy operator()(const FacetsIterator &beg, const FacetsIterator &end) const; Proxy operator()(const FacetIterator &beg, const FacetIterator &end) const;
/// } /// }
}; };