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

use precondition macro

This commit is contained in:
Sébastien Loriot 2022-09-21 16:40:22 +02:00
parent 6b07cbdadd
commit 7a6faa7c38
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Mesh_2/include/CGAL/lloyd_optimize_mesh_2.h
View File

@ -76,7 +76,7 @@ namespace CGAL
* \cgalParamNBegin{max_iteration_number}
* \cgalParamDescription{limit on the number of performed iterations. 0 means that there is
* no limit on the number of performed iterations.}
* \cgalParamExtra{\pre `max_iteration_number >=0`}
* \cgalParamPrecondition{`max_iteration_number >=0`}
* \cgalParamType{`int`}
* \cgalParamDefault{0}
* \cgalParamNEnd
@ -85,7 +85,7 @@ namespace CGAL
* \cgalParamDescription{to set up, in seconds, a CPU time limit after which the optimization process is stopped.
* This time is measured using `CGAL::Real_timer`. 0 means that there is no time limit.}
* \cgalParamType{`double`}
* \cgalParamExtra{\pre `time_limit` \f$ \geq\f$ 0}
* \cgalParamPrecondition{`time_limit` \f$ \geq\f$ 0}
* \cgalParamDefault{0}
* \cgalParamNEnd
*
@ -95,7 +95,7 @@ namespace CGAL
* of its shortest incident edge, is frozen (i.e.\ is not relocated).
* The parameter `freeze_bound` gives the threshold ratio.
* If it is set to 0, freezing of vertices is disabled.}
* \cgalParamExtra{\pre `0<= freeze_bound <=1}
* \cgalParamPrecondition{`0<= freeze_bound <=1`}
* \cgalParamType{`double`}
* \cgalParamDefault{0.001}
* \cgalParamNEnd
@ -104,7 +104,7 @@ namespace CGAL
* \cgalParamDescription{threshold ratio of stopping criterion based on convergence: the optimization process is stopped
* when at the last iteration the displacement of any vertex is less than
* a given fraction of the length of the shortest edge incident to that vertex.}
* \cgalParamExtra{\pre `0 <=convergence <= 1`}
* \cgalParamPrecondition{`0 <=convergence <= 1`}
* \cgalParamType{`double`}
* \cgalParamDefault{0.001}
* \cgalParamNEnd