Prev

Next

Index-> contents reference index search external

Up-> CppAD Appendix deprecated omp_alloc

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

Appendix-> Faq directory Theory glossary Bib wish_list whats_new deprecated compare_c numeric_ad addon License

deprecated-> include_deprecated FunDeprecated CompareChange omp_max_thread TrackNewDel omp_alloc memory_leak epsilon test_vector cppad_ipopt_nlp old_atomic zdouble autotools

omp_alloc-> omp_max_num_threads omp_in_parallel omp_get_thread_num omp_get_memory omp_return_memory omp_free_available omp_inuse omp_available omp_create_array omp_delete_array omp_efficient old_max_num_threads omp_alloc.cpp

Headings-> Syntax Purpose Include Deprecated 2011-08-23 Contents

@(@\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}} }@)@A Quick OpenMP Memory Allocator Used by CppAD
Syntax
# include <cppad/omp_alloc.hpp>

Purpose
The C++ new and delete operators are thread safe, but this means that a thread may have to wait for a lock on these operations. Once memory is obtained for a thread, the omp_alloc memory allocator keeps that memory omp_available for the thread so that it can be re-used without waiting for a lock. All the CppAD memory allocations use this utility. The omp_free_available function should be used to return memory to the system (once it is no longer required by a thread).

Include
The routines in sections below are defined by cppad/omp_alloc.hpp. This file is included by cppad/cppad.hpp, but it can also be included separately with out the rest of the CppAD.

Deprecated 2011-08-23
Use thread_alloc instead.

Contents

omp_max_num_threads	Set and Get Maximum Number of Threads for omp_alloc Allocator
omp_in_parallel	Is The Current Execution in OpenMP Parallel Mode
omp_get_thread_num	Get the Current OpenMP Thread Number
omp_get_memory	Get At Least A Specified Amount of Memory
omp_return_memory	Return Memory to omp_alloc
omp_free_available	Free Memory Currently Available for Quick Use by a Thread
omp_inuse	Amount of Memory a Thread is Currently Using
omp_available	Amount of Memory Available for Quick Use by a Thread
omp_create_array	Allocate Memory and Create A Raw Array
omp_delete_array	Return A Raw Array to The Available Memory for a Thread
omp_efficient	Check If A Memory Allocation is Efficient for Another Use
old_max_num_threads	Set Maximum Number of Threads for omp_alloc Allocator
omp_alloc.cpp	OpenMP Memory Allocator: Example and Test

---

Input File: omh/appendix/deprecated/omp_alloc.omh