omp_delete_array

View page source

Return A Raw Array to The Available Memory for a Thread

Deprecated 2011-08-31

Use the function thread_alloc::delete_array instead.

Syntax

# include <cppad/utility/omp_alloc.hpp>

omp_alloc::delete_array ( array ) .

Purpose

Returns memory corresponding to a raw array (create by omp_create_array ) to the omp_available memory pool for the current thread.

Type

The type of the elements of the array.

array

The argument array has prototype

Type * array

It is a value returned by omp_create_array and not yet deleted. The Type destructor is called for each element in the array.

Thread

The current thread must be the same as when omp_create_array returned the value array . There is an exception to this rule: when the current execution mode is sequential (not parallel ) the current thread number does not matter.

Delta

The amount of memory omp_inuse will decrease by delta , and the omp_available memory will increase by delta , where Delta is the same as for the corresponding call to create_array .