Prev

Next

Index-> contents reference index search external

Up-> CppAD utility thread_alloc ta_hold_memory

CppAD-> Install Introduction AD ADFun preprocessor multi_thread utility ipopt_solve Example speed Appendix

utility-> ErrorHandler NearEqual speed_test SpeedTest time_test test_boolofvoid NumericType CheckNumericType SimpleVector CheckSimpleVector nan pow_int Poly LuDetAndSolve RombergOne RombergMul Runge45 Rosen34 OdeErrControl OdeGear OdeGearControl CppAD_vector thread_alloc index_sort to_string set_union sparse_rc sparse_rcv

thread_alloc-> thread_alloc.cpp ta_parallel_setup ta_num_threads ta_in_parallel ta_thread_num ta_get_memory ta_return_memory ta_free_available ta_hold_memory ta_inuse ta_available ta_create_array ta_delete_array ta_free_all

ta_hold_memory

Headings-> Syntax Purpose value free_available

@(@\newcommand{\W}[1]{ \; #1 \; } \newcommand{\R}[1]{ {\rm #1} } \newcommand{\B}[1]{ {\bf #1} } \newcommand{\D}[2]{ \frac{\partial #1}{\partial #2} } \newcommand{\DD}[3]{ \frac{\partial^2 #1}{\partial #2 \partial #3} } \newcommand{\Dpow}[2]{ \frac{\partial^{#1}}{\partial {#2}^{#1}} } \newcommand{\dpow}[2]{ \frac{ {\rm d}^{#1}}{{\rm d}\, {#2}^{#1}} }@)@ Control When Thread Alloc Retains Memory For Future Use
Syntax
thread_alloc::hold_memory(value)

Purpose
It should be faster, even when num_thread is equal to one, for thread_alloc to hold onto memory. Calling hold_memory with value equal to true, instructs thread_alloc to hold onto memory, and put it in the available pool, after each call to return_memory .

value
If value is true, thread_alloc with hold onto memory for future quick use. If it is false, future calls to return_memory will return the corresponding memory to the system. By default (when hold_memory has not been called) thread_alloc does not hold onto memory.

free_available
Memory that is being held by thread_alloc can be returned to the system using free_available .

---

Input File: cppad/utility/thread_alloc.hpp