Prev

Next

Index-> contents reference index search external

Up-> CppAD utility thread_alloc ta_create_array

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_create_array

Headings-> Syntax Purpose Type size_min size_out array Delta Alignment Example

@(@\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}} }@)@ Allocate An Array and Call Default Constructor for its Elements
Syntax
array = thread_alloc::create_array<Type>(size_min, size_out) .

Purpose
Create a new raw array using thread_alloc memory allocator (works well in a multi-threading environment) and call default constructor for each element.

Type
The type of the elements of the array.

size_min
This argument has prototype
     size_t size_min
This is the minimum number of elements that there can be in the resulting array .

size_out
This argument has prototype
     size_t& size_out
The input value of this argument does not matter. Upon return, it is the actual number of elements in array (  size_min <= size_out ).

array
The return value array has prototype
     Type* array
It is array with size_out elements. The default constructor for Type is used to initialize the elements of array . Note that delete_array should be used to destroy the array when it is no longer needed.

Delta
The amount of memory inuse by the current thread, will increase delta where
     sizeof(Type) * (size_out + 1) > delta >= sizeof(Type) * size_out
The available memory will decrease by delta , (and the allocation will be faster) if a previous allocation with size_min between its current value and size_out is available.

Alignment
We call a memory allocation aligned if the address is a multiple of the number of bytes in a size_t value. If the system new allocator is aligned, then array pointer is also aligned.

Example
thread_alloc.cpp

---

Input File: cppad/utility/thread_alloc.hpp