Codebase list cppad / upstream/2015.00.00.7 doc / ta_hold_memory.xml
upstream/2015.00.00.7

Tree @upstream/2015.00.00.7 (Download .tar.gz)

ta_hold_memory.xml @upstream/2015.00.00.7 — raw · history · blame 

  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
<?xml version='1.0'?>
<html xmlns='http://www.w3.org/1999/xhtml'
      xmlns:math='http://www.w3.org/1998/Math/MathML'
>
<head>
<title>Control When Thread Alloc Retains Memory For Future Use</title>
<meta http-equiv='Content-Type' content='text/html' charset='utf-8'/>
<meta name="description" id="description" content="Control When Thread Alloc Retains Memory For Future Use"/>
<meta name="keywords" id="keywords" content=" control when thread alloc retains memory for future use thread_alloc hold syntax purpose value free_available "/>
<style type='text/css'>
body { color : black }
body { background-color : white }
A:link { color : blue }
A:visited { color : purple }
A:active { color : purple }
</style>
<script type='text/javascript' language='JavaScript' src='_ta_hold_memory_xml.js'>
</script>
</head>
<body>
<table><tr>
<td>
<a href="http://www.coin-or.org/CppAD/" target="_top"><img border="0" src="_image.gif"/></a>
</td>
<td><a href="ta_free_available.xml" target="_top">Prev</a>
</td><td><a href="ta_inuse.xml" target="_top">Next</a>
</td><td>
<select onchange='choose_across0(this)'>
<option>Index-&gt;</option>
<option>contents</option>
<option>reference</option>
<option>index</option>
<option>search</option>
<option>external</option>
</select>
</td>
<td>
<select onchange='choose_up0(this)'>
<option>Up-&gt;</option>
<option>CppAD</option>
<option>library</option>
<option>thread_alloc</option>
<option>ta_hold_memory</option>
</select>
</td>
<td>
<select onchange='choose_down3(this)'>
<option>CppAD-&gt;</option>
<option>Install</option>
<option>Introduction</option>
<option>AD</option>
<option>ADFun</option>
<option>preprocessor</option>
<option>multi_thread</option>
<option>library</option>
<option>ipopt_solve</option>
<option>Example</option>
<option>speed</option>
<option>Appendix</option>
</select>
</td>
<td>
<select onchange='choose_down2(this)'>
<option>library-&gt;</option>
<option>ErrorHandler</option>
<option>NearEqual</option>
<option>speed_test</option>
<option>SpeedTest</option>
<option>time_test</option>
<option>NumericType</option>
<option>CheckNumericType</option>
<option>SimpleVector</option>
<option>CheckSimpleVector</option>
<option>nan</option>
<option>pow_int</option>
<option>Poly</option>
<option>LuDetAndSolve</option>
<option>RombergOne</option>
<option>RombergMul</option>
<option>Runge45</option>
<option>Rosen34</option>
<option>OdeErrControl</option>
<option>OdeGear</option>
<option>OdeGearControl</option>
<option>CppAD_vector</option>
<option>thread_alloc</option>
<option>index_sort</option>
<option>BenderQuad</option>
<option>opt_val_hes</option>
<option>LuRatio</option>
</select>
</td>
<td>
<select onchange='choose_down1(this)'>
<option>thread_alloc-&gt;</option>
<option>thread_alloc.cpp</option>
<option>ta_parallel_setup</option>
<option>ta_num_threads</option>
<option>ta_in_parallel</option>
<option>ta_thread_num</option>
<option>ta_get_memory</option>
<option>ta_return_memory</option>
<option>ta_free_available</option>
<option>ta_hold_memory</option>
<option>ta_inuse</option>
<option>ta_available</option>
<option>ta_create_array</option>
<option>ta_delete_array</option>
<option>ta_free_all</option>
</select>
</td>
<td>ta_hold_memory</td>
<td>
<select onchange='choose_current0(this)'>
<option>Headings-&gt;</option>
<option>Syntax</option>
<option>Purpose</option>
<option>value</option>
<option>free_available</option>
</select>
</td>
</tr></table><br/>



<center><b><big><big>Control When Thread Alloc Retains Memory For Future Use</big></big></b></center>
<br/>
<b><big><a name="Syntax" id="Syntax">Syntax</a></big></b>

<br/>

<code><font color="blue"><span style='white-space: nowrap'>thread_alloc::hold_memory(</span></font><i><font color="black"><span style='white-space: nowrap'>value</span></font></i><font color="blue"><span style='white-space: nowrap'>)</span></font></code>


<br/>
<br/>
<b><big><a name="Purpose" id="Purpose">Purpose</a></big></b>
<br/>
It should be faster, even when 
<code><i><font color="black"><span style='white-space: nowrap'>num_thread</span></font></i></code>
 is equal to one,
for <code><font color="blue">thread_alloc</font></code> to hold onto memory.
Calling 
<code><i><font color="black"><span style='white-space: nowrap'>hold_memory</span></font></i></code>
 with 
<code><i><font color="black"><span style='white-space: nowrap'>value</span></font></i></code>
 equal to true,
instructs <code><font color="blue">thread_alloc</font></code> to hold onto memory,
and put it in the <a href="ta_available.xml" target="_top"><span style='white-space: nowrap'>available</span></a>
 pool,
after each call to <a href="ta_return_memory.xml" target="_top"><span style='white-space: nowrap'>return_memory</span></a>
. 

<br/>
<br/>
<b><big><a name="value" id="value">value</a></big></b>
<br/>
If 
<code><i><font color="black"><span style='white-space: nowrap'>value</span></font></i></code>
 is true,
<code><font color="blue">thread_alloc</font></code> with hold onto memory for future quick use.
If it is false, future calls to <a href="ta_return_memory.xml" target="_top"><span style='white-space: nowrap'>return_memory</span></a>

will return the corresponding memory to the system.
By default (when <code><font color="blue">hold_memory</font></code> has not been called)
<code><font color="blue">thread_alloc</font></code> does not hold onto memory.

<br/>
<br/>
<b><big><a name="free_available" id="free_available">free_available</a></big></b>
<br/>
Memory that is being held by <code><font color="blue">thread_alloc</font></code> can be returned
to the system using <a href="ta_free_available.xml" target="_top"><span style='white-space: nowrap'>free_available</span></a>
.


<hr/>Input File: cppad/thread_alloc.hpp

</body>
</html>