-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathclassCGAL_1_1Modifier__base.html
262 lines (255 loc) · 13.3 KB
/
classCGAL_1_1Modifier__base.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<link rel="canonical" href="https://doc.cgal.org/latest/Miscellany/classCGAL_1_1Modifier__base.html"/>
<link rel="icon" type="image/png" href="../Manual/g-196x196-doc.png">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=11">
<meta name="generator" content="Doxygen 1.9.6">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>CGAL 6.1 - Profiling tools, Hash Map, Union-find, Modifiers: CGAL::Modifier_base< R > Class Template Reference</title>
<!-- <link href="../Manual/tabs.css" rel="stylesheet" type="text/css"/> -->
<script type="text/javascript" src="../Manual/jquery.js"></script>
<script type="text/javascript" src="../Manual/dynsections.js"></script>
<script src="../Manual/hacks.js" type="text/javascript"></script>
<!-- Manually include treeview and search to avoid bloat and to fix
paths to the directory Manual . -->
<!-- $.treeview -->
<!-- $.search -->
<link href="navtree.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../Manual/resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="../Manual/search/search.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../Manual/search/searchdata.js"></script>
<script type="text/javascript" src="../Manual/search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="../Manual/search/search.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../Manual/search/search.js"></script>
<!-- Manually done below. -->
<link href="../Manual/doxygen.css" rel="stylesheet" type="text/css">
<link href="../Manual/cgal_stylesheet.css" rel="stylesheet" type="text/css">
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
//<![CDATA[
MathJax.Hub.Config(
{
TeX: {
Macros: {
qprel: [ "{\\gtreqless}", 0],
qpx: [ "{\\mathbf{x}}", 0],
qpl: [ "{\\mathbf{l}}", 0],
qpu: [ "{\\mathbf{u}}", 0],
qpc: [ "{\\mathbf{c}}", 0],
qpb: [ "{\\mathbf{b}}", 0],
qpy: [ "{\\mathbf{y}}", 0],
qpw: [ "{\\mathbf{w}}", 0],
qplambda: [ "{\\mathbf{\\lambda}}", 0],
ssWpoint: [ "{\\bf #1}", 1],
ssWeight: [ "{w_{#1}}", 1],
dabs: [ "{\\parallel\\! #1 \\!\\parallel}", 1],
E: [ "{\\mathrm{E}}", 0],
A: [ "{\\mathrm{A}}", 0],
R: [ "{\\mathrm{R}}", 0],
N: [ "{\\mathrm{N}}", 0],
Q: [ "{\\mathrm{Q}}", 0],
Z: [ "{\\mathrm{Z}}", 0],
ccSum: [ "{\\sum_{#1}^{#2}{#3}}", 3],
ccProd: [ "{\\prod_{#1}^{#2}{#3}}", 3],
pyr: [ "{\\operatorname{Pyr}}", 0],
aff: [ "{\\operatorname{aff}}", 0],
Ac: [ "{\\cal A}", 0],
Sc: [ "{\\cal S}", 0],
},
equationNumbers: { autoNumber: "AMS" }
}
}
);
MathJax.Hub.Register.StartupHook("TeX Jax Ready",function () {
var PARSE = MathJax.InputJax.TeX.Parse,
TEXT = PARSE.prototype.InternalText;
PARSE.Augment({
InternalText: function (text,def) {
text = text.replace(/\\/g,"");
return TEXT.call(this,text,def);
}
});
});
//]]>
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<script src="modules.js" type="text/javascript"></script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="back-nav">
<ul>
<li><a href="https://www.cgal.org/">cgal.org</a></li>
<li><a href="../Manual/index.html">Top</a></li>
<li><a href="../Manual/general_intro.html">Getting Started</a></li>
<li><a href="../Manual/tutorials.html">Tutorials</a></li>
<li><a href="../Manual/packages.html">Package Overview</a></li>
<li><a href="../Manual/how_to_cite_cgal.html">Acknowledging CGAL</a></li>
</ul>
<!-- In a package SEARCHENGINE = false, so we cannot use
insertion. That's why we have to do it manually here. Notice
that we also take pngs from the Manual. -->
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">
</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)">
</span>
<span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../Manual/search/close.svg" alt=""></a>
</span>
</div>
</div>
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">CGAL 6.1 - Profiling tools, Hash Map, Union-find, Modifiers
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Code below is usually inserted by doxygen when SEARCHENGINE =
true. Notice that the path to the search directory is adjusted to
the top-level.-->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../Manual/search/",'.html');
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync" style="display: none"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classCGAL_1_1Modifier__base.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="classCGAL_1_1Modifier__base-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">CGAL::Modifier_base< R > Class Template Reference<div class="ingroups"><a class="el" href="group__MiscellanyRef.html">Profiling Tools, Hash Map, Union-find, Modifiers Reference</a></div></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include <CGAL/Modifier_base.h></code></p>
<a name="details" id="details"></a><h2 class="groupheader">Definition</h2>
<div class="textblock"><div class="compoundTemplParams">template<typename R><br>
class CGAL::Modifier_base< R ></div><p><code><a class="el" href="classCGAL_1_1Modifier__base.html" title="Modifier_base is an abstract base class providing the interface for any modifier.">Modifier_base</a></code> is an abstract base class providing the interface for any modifier. </p>
<p>A modifier is a function object derived from <code><a class="el" href="classCGAL_1_1Modifier__base.html" title="Modifier_base is an abstract base class providing the interface for any modifier.">Modifier_base</a></code> that implements the pure virtual member function <code>operator()</code>, which accepts a single reference parameter <code>R&</code> on which the modifier is allowed to work. <code>R</code> is the type of the internal representation that is to be modified.</p>
<p><b>Example</b><br>
</p>
<p>The following fragment defines a class <code>A</code> with an internal representation <code>i</code> of type <code>int</code>. It provides a member function <code>delegate()</code>, which gives a modifier access to the internal variable and checks validity thereafter. The example modifier sets the internal variable to 42. The example function applies the modifier to an instance of class <code>A</code>.</p>
<div class="fragment"><div class="line"><span class="keyword">class </span>A {</div>
<div class="line"> <span class="keywordtype">int</span> i; <span class="comment">// protected internal representation</span></div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line"> <span class="keywordtype">void</span> delegate( <a class="code hl_class" href="classCGAL_1_1Modifier__base.html">CGAL::Modifier_base<int></a>& modifier) {</div>
<div class="line"> modifier(i);</div>
<div class="line"> CGAL_postcondition( i > 0); <span class="comment">// check validity</span></div>
<div class="line"> }</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="keyword">struct </span>Modifier : <span class="keyword">public</span> <a class="code hl_class" href="classCGAL_1_1Modifier__base.html">CGAL::Modifier_base</a><int> {</div>
<div class="line"> <span class="keywordtype">void</span> operator()( <span class="keywordtype">int</span>& rep) { rep = 42;}</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> use_it() {</div>
<div class="line"> A a;</div>
<div class="line"> Modifier m;</div>
<div class="line"> a.delegate(m); <span class="comment">// a.i == 42 and A has checked that A::i > 0.</span></div>
<div class="line">}</div>
<div class="ttc" id="aclassCGAL_1_1Modifier__base_html"><div class="ttname"><a href="classCGAL_1_1Modifier__base.html">CGAL::Modifier_base</a></div><div class="ttdoc">Modifier_base is an abstract base class providing the interface for any modifier.</div><div class="ttdef"><b>Definition:</b> Modifier_base.h:46</div></div>
</div><!-- fragment --> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader">Types</h2></td></tr>
<tr class="memitem:aba3c477a58cdce6e00562858e0be297d"><td class="memItemLeft" align="right" valign="top"><a id="aba3c477a58cdce6e00562858e0be297d" name="aba3c477a58cdce6e00562858e0be297d"></a>
typedef R </td><td class="memItemRight" valign="bottom"><b>Representation</b></td></tr>
<tr class="memdesc:aba3c477a58cdce6e00562858e0be297d"><td class="mdescLeft"> </td><td class="mdescRight">the internal representation type. <br></td></tr>
<tr class="separator:aba3c477a58cdce6e00562858e0be297d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader">Operations</h2></td></tr>
<tr class="memitem:a08a0a229b834229b3d35c8fb122cb488"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCGAL_1_1Modifier__base.html#a08a0a229b834229b3d35c8fb122cb488">operator()</a> (R &rep)</td></tr>
<tr class="separator:a08a0a229b834229b3d35c8fb122cb488"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a08a0a229b834229b3d35c8fb122cb488" name="a08a0a229b834229b3d35c8fb122cb488"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08a0a229b834229b3d35c8fb122cb488">◆ </a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename R > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classCGAL_1_1Modifier__base.html">CGAL::Modifier_base</a>< R >::operator() </td>
<td>(</td>
<td class="paramtype">R & </td>
<td class="paramname"><em>rep</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section post"><dt>Postcondition</dt><dd><code>rep</code> is a valid representation. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.6-->
<!-- start footer part -->
<!-- The footer div is not part of the default but we require it to
move the footer to the bottom of the page. -->
<div id="footer">
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>CGAL</b></li><li class="navelem"><a class="el" href="classCGAL_1_1Modifier__base.html">Modifier_base</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"></a> 1.9.6 </li>
</ul>
</div>
</div>
</body>
</html>