---------------------------------------------------------------
lines 1198-1236 of file: include/cppad/utility/thread_alloc.hpp
---------------------------------------------------------------

{xrst_begin ta_available}

Amount of Memory Available for Quick Use by a Thread
####################################################

Syntax
******
*num_bytes* = ``thread_alloc::available`` ( *thread* )

Purpose
*******
Memory being managed by :ref:`thread_alloc-name` has two states,
currently in use by the specified thread,
and quickly available for future use by the specified thread.
This function informs the program how much memory is available.

thread
******
This argument has prototype

   ``size_t`` *thread*

Either :ref:`thread_num<ta_thread_num-name>` must be the same as *thread* ,
or the current execution mode must be sequential
(not :ref:`parallel<ta_in_parallel-name>` ).

num_bytes
*********
The return value has prototype

   ``size_t`` *num_bytes*

It is the number of bytes currently available for use by the specified thread.

Example
*******
:ref:`thread_alloc.cpp-name`

{xrst_end ta_available}