cgal/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h

50 lines
877 B
C++

/*!
\ingroup PkgSurfaceMesher3Concepts
\cgalConcept
The concept `ImplicitFunction` describes a function object
whose `operator()` computes the values of a function
\f$ f : \mathbb{R}^3 \longrightarrow \mathbb{R}\f$.
\cgalHasModelsBegin
\cgalHasModelsBare{any pointer to a function of type `FT (*)(Point)`}
\cgalHasModels{CGAL::Gray_level_image_3}
\cgalHasModelsEnd
\sa `CGAL::Implicit_surface_3<Traits, Function>`
\sa `CGAL::make_surface_mesh()`
*/
class ImplicitFunction {
public:
/// \name Types
/// @{
///The following types aren't required for any pointer to a function of type `FT (*)(Point)`.
/*!
Number type
*/
typedef unspecified_type FT;
/*!
Point type
*/
typedef unspecified_type Point;
/// @}
/// \name Operations
/// @{
/*!
Returns the value \f$ f(p)\f$, where \f$ p \in\mathbb{R}^3\f$.
*/
FT operator()(Point p);
/// @}
}; /* end ImplicitFunction */