Return Memory to thread_alloc
Keywords: return memory to thread_alloc return_memory available syntax purpose v_ptr thread ndebug example

| Prev | Next |  |  |  |  |  | ta_return_memory |

Return Memory to thread_alloc
Syntax
`thread_alloc::return_memory(v_ptr)`
Purpose
If hold_memory is false, the memory is returned to the system. Otherwise, the memory is retained by thread_alloc for quick future use by the thread that allocated to memory.
v_ptr
This argument has prototype `
void* v_ptr
` . It must be a pointer to memory that is currently in use; i.e. obtained by a previous call to get_memory and not yet returned.
Thread
Either the current thread must be the same as during the corresponding call to get_memory , or the current execution mode must be sequential (not parallel ).
NDEBUG
If `NDEBUG` is defined, `v_ptr` is not checked (this is faster). Otherwise, a list of in use pointers is searched to make sure that `v_ptr` is in the list.
Example
thread_alloc.cpp

Input File: cppad/utility/thread_alloc.hpp