mirror of https://github.com/CGAL/cgal
dedicated macro for precondition
This commit is contained in:
Sébastien Loriot
parent
681120764e
commit
d8f0bc4c08
|
|
@ -351,7 +351,8 @@ ALIASES = "cgal=%CGAL" \
|
|||
"cgalParamExtra{1}=<li><b>Extra: </b>\1</li>" \
|
||||
"cgalParamNEnd=</ul> \htmlonly[block] </div> \endhtmlonly </td><td></td></tr>" \
|
||||
"cgalParamSectionBegin{1}=\cgalParamNBegin{\1}" \
|
||||
"cgalParamSectionEnd=\cgalParamNEnd"
|
||||
"cgalParamSectionEnd=\cgalParamNEnd" \
|
||||
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>"
|
||||
|
||||
# This tag can be used to specify a number of word-keyword mappings (TCL only).
|
||||
# A mapping has the form "name=value". For example adding "class=itcl::class"
|
||||
|
|
|
|||
|
|
@ -352,7 +352,8 @@ ALIASES = "cgal=%CGAL" \
|
|||
"cgalParamExtra{1}=<li><b>Extra: </b>\1</li>" \
|
||||
"cgalParamNEnd=</ul> \htmlonly[block] </div> \endhtmlonly </td><td></td></tr>" \
|
||||
"cgalParamSectionBegin{1}=\cgalParamNBegin{\1}" \
|
||||
"cgalParamSectionEnd=\cgalParamNEnd"
|
||||
"cgalParamSectionEnd=\cgalParamNEnd" \
|
||||
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>"
|
||||
|
||||
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
|
||||
# only. Doxygen will then generate output that is more tailored for C. For
|
||||
|
|
|
|||
|
|
@ -374,7 +374,8 @@ ALIASES = "cgal=%CGAL" \
|
|||
"cgalParamExtra{1}=<li><b>Extra: </b>\1</li>" \
|
||||
"cgalParamNEnd=</ul> \htmlonly[block] </div> \endhtmlonly </td><td></td></tr>" \
|
||||
"cgalParamSectionBegin{1}=\cgalParamNBegin{\1}" \
|
||||
"cgalParamSectionEnd=\cgalParamNEnd"
|
||||
"cgalParamSectionEnd=\cgalParamNEnd" \
|
||||
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>"
|
||||
|
||||
|
||||
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
|
||||
|
|
|
|||
|
|
@ -358,6 +358,7 @@ ALIASES+= "cgalParamExtra{1}=<li><b>Extra: </b>\1</li>"
|
|||
ALIASES+= "cgalParamNEnd=</ul> \htmlonly[block] </div> \endhtmlonly </td><td></td></tr>"
|
||||
ALIASES+= "cgalParamSectionBegin{1}=\cgalParamNBegin{\1}"
|
||||
ALIASES+= "cgalParamSectionEnd=\cgalParamNEnd"
|
||||
ALIASES+= "cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>"
|
||||
|
||||
|
||||
# This tag can be used to specify a number of word-keyword mappings (TCL only).
|
||||
|
|
|
|||
|
|
@ -374,7 +374,8 @@ ALIASES = "cgal=%CGAL" \
|
|||
"cgalParamExtra{1}=<li><b>Extra: </b>\1</li>" \
|
||||
"cgalParamNEnd=</ul> \htmlonly[block] </div> \endhtmlonly </td><td></td></tr>" \
|
||||
"cgalParamSectionBegin{1}=\cgalParamNBegin{\1}" \
|
||||
"cgalParamSectionEnd=\cgalParamNEnd"
|
||||
"cgalParamSectionEnd=\cgalParamNEnd" \
|
||||
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>"
|
||||
|
||||
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
|
||||
# only. Doxygen will then generate output that is more tailored for C. For
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ namespace CGAL {
|
|||
* is stopped. This time is measured using the `Real_timer` class. The default value is
|
||||
* 0 and means that there is no time limit.}
|
||||
* \cgalParamType{`double`}
|
||||
* \cgalParamExtra{\pre `time_limit >= 0`}
|
||||
* \cgalParamPrecondition{`time_limit >= 0`}
|
||||
* \cgalParamDefault{0}
|
||||
* \cgalParamNEnd
|
||||
* \cgalParamNBegin{sliver_bound}
|
||||
|
|
@ -64,7 +64,7 @@ namespace CGAL {
|
|||
* default value is 0 and means that there is no targeted bound: the exuder then runs as long
|
||||
* as it can improve the smallest dihedral angles of the set of cells incident to some vertices.}
|
||||
* \cgalParamType{`double`}
|
||||
* \cgalParamExtra{\pre `sliver_bound <= 180`}
|
||||
* \cgalParamPrecondition{`0<= sliver_bound <= 180`}
|
||||
* \cgalParamDefault{0}
|
||||
* \cgalParamNEnd
|
||||
* \cgalNamedParamsEnd
|
||||
|
|
|
|||
|
|
@ -64,13 +64,13 @@ 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 >= 0`}
|
||||
* \cgalParamPrecondition{`time_limit >= 0`}
|
||||
* \cgalParamDefault{0}
|
||||
* \cgalParamNEnd
|
||||
* \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
|
||||
|
|
@ -80,7 +80,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
|
||||
|
|
@ -88,7 +88,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.02}
|
||||
* \cgalParamNEnd
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ namespace CGAL {
|
|||
* measured using `Real_timer`.
|
||||
* The default value is 0 and means that there is no time limit.}
|
||||
* \cgalParamType{`double`}
|
||||
* \cgalParamExtra{\pre `time_limit >= 0`}
|
||||
* \cgalParamPrecondition{`time_limit >= 0`}
|
||||
* \cgalParamDefault{0}
|
||||
* \cgalParamNEnd
|
||||
* \cgalParamNBegin{max_iteration_number}
|
||||
|
|
@ -82,7 +82,7 @@ namespace CGAL {
|
|||
* the shortest edge incident to that vertex.
|
||||
* The parameter `convergence` gives the threshold ratio.}
|
||||
* \cgalParamType{`double`}
|
||||
* \cgalParamExtra{\pre `0 <= convergence <= 1`}
|
||||
* \cgalParamPrecondition{`0 <= convergence <= 1`}
|
||||
* \cgalParamDefault{0.02}
|
||||
* \cgalParamNEnd
|
||||
* \cgalParamNBegin{freeze_bound}
|
||||
|
|
@ -90,7 +90,7 @@ namespace CGAL {
|
|||
* that has a displacement less than a given percentage of the length of its shortest incident edge, is frozen (i.e.\ is
|
||||
* not relocated). The parameter `freeze_bound` gives the threshold ratio.}
|
||||
* \cgalParamType{`double`}
|
||||
* \cgalParamExtra{\pre `0 <= freeze_bound <= 1`}
|
||||
* \cgalParamPrecondition{`0 <= freeze_bound <= 1`}
|
||||
* \cgalParamDefault{0.01}
|
||||
* \cgalParamNEnd
|
||||
* \cgalParamNBegin{do_freeze}
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ namespace CGAL {
|
|||
* is stopped. This time is measured using the `Real_timer` class. The default value is
|
||||
* 0 and means that there is no time limit.}
|
||||
* \cgalParamType{`double`}
|
||||
* \cgalParamExtra{\pre `0 <= sliver_bound <= 180`}
|
||||
* \cgalParamPrecondition{`0 <= sliver_bound <= 180`}
|
||||
* \cgalParamDefault{0}
|
||||
* \cgalParamNEnd
|
||||
* \cgalParamNBegin{sliver_bound}
|
||||
|
|
@ -72,7 +72,7 @@ namespace CGAL {
|
|||
* default value is 0 and means that there is no targeted bound: the exuder then runs as long
|
||||
* as it can improve the smallest dihedral angles of the set of cells incident to some vertices.}
|
||||
* \cgalParamType{`double`}
|
||||
* \cgalParamExtra{\pre `time_limit >= 0`}
|
||||
* \cgalParamPrecondition{`time_limit >= 0`}
|
||||
* \cgalParamDefault{0}
|
||||
* \cgalParamNEnd
|
||||
* \cgalNamedParamsEnd
|
||||
|
|
|
|||
Loading…
Reference in New Issue