Prev

Next

Index-> contents reference index search external

Up-> CppAD Appendix deprecated TrackNewDel

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

TrackNewDel-> TrackNewDel.cpp

Headings-> Deprecated 2007-07-23 Syntax Purpose Include file line oldptr newlen head newptr ncopy TrackNewVec ---..Macro ---..Previously Deprecated TrackDelVec ---..Macro ---..Previously Deprecated TrackExtend ---..Macro ---..Previously Deprecated TrackCount ---..Macro ---..Previously Deprecated Multi-Threading 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}} }@)@ Routines That Track Use of New and Delete
Deprecated 2007-07-23
All these routines have been deprecated. You should use the thread_alloc memory allocator instead (which works better in both a single thread and properly in multi-threading environment).

Syntax
# include <cppad/utility/track_new_del.hpp>
newptr = TrackNewVec(file, line, newlen, oldptr)
TrackDelVec(file, line, oldptr)
newptr = TrackExtend(file, line, newlen, ncopy, oldptr)
count = TrackCount(file, line)

Purpose
These routines aid in the use of new[] and delete[] during the execution of a C++ program.

Include
The file cppad/track_new_del.hpp is included by cppad/cppad.hpp but it can also be included separately with out the rest of the CppAD include files.

file
The argument file has prototype
     const char *file
It should be the source code file name where the call to TrackNew is located. The best way to accomplish this is the use the preprocessor symbol __FILE__ for this argument.

line
The argument line has prototype
     int line
It should be the source code file line number where the call to TrackNew is located. The best way to accomplish this is the use the preprocessor symbol __LINE__ for this argument.

oldptr
The argument oldptr has prototype
     Type *oldptr
This argument is used to identify the type Type .

newlen
The argument newlen has prototype
     size_t newlen

head newptr
The return value newptr has prototype
     Type *newptr
It points to the newly allocated vector of objects that were allocated using
     new Type[newlen]

ncopy
The argument ncopy has prototype
        size_t ncopy
This specifies the number of elements that are copied from the old array to the new array. The value of ncopy must be less than or equal newlen .

TrackNewVec
If NDEBUG is defined, this routine only sets
     newptr = Type new[newlen]
The value of oldptr does not matter (except that it is used to identify Type ). If NDEBUG is not defined, TrackNewVec also tracks the this memory allocation. In this case, if memory cannot be allocated ErrorHandler is used to generate a message stating that there was not sufficient memory.

Macro
The preprocessor macro call
     CPPAD_TRACK_NEW_VEC(newlen, oldptr)
expands to
     CppAD::TrackNewVec(__FILE__, __LINE__, newlen, oldptr)

Previously Deprecated
The preprocessor macro CppADTrackNewVec is the same as CPPAD_TRACK_NEW_VEC and was previously deprecated.

TrackDelVec
This routine is used to a vector of objects that have been allocated using TrackNew or TrackExtend. If NDEBUG is defined, this routine only frees memory with
     delete [] oldptr
If NDEBUG is not defined, TrackDelete also checks that oldptr was allocated by TrackNew or TrackExtend and has not yet been freed. If this is not the case, ErrorHandler is used to generate an error message.

Macro
The preprocessor macro call
     CPPAD_TRACK_DEL_VEC(oldptr)
expands to
     CppAD::TrackDelVec(__FILE__, __LINE__, oldptr)

Previously Deprecated
The preprocessor macro CppADTrackDelVec is the same as CPPAD_TRACK_DEL_VEC was previously deprecated.

TrackExtend
This routine is used to allocate a new vector (using TrackNewVec), copy ncopy elements from the old vector to the new vector. If ncopy is greater than zero, oldptr must have been allocated using TrackNewVec or TrackExtend. In this case, the vector pointed to by oldptr must be have at least ncopy elements and it will be deleted (using TrackDelVec). Note that the dependence of TrackExtend on NDEBUG is indirectly through the routines TrackNewVec and TrackDelVec.

Macro
The preprocessor macro call
     CPPAD_TRACK_EXTEND(newlen, ncopy, oldptr)
expands to
     CppAD::TrackExtend(__FILE__, __LINE__, newlen, ncopy, oldptr)

Previously Deprecated
The preprocessor macro CppADTrackExtend is the same as CPPAD_TRACK_EXTEND and was previously deprecated.

TrackCount
The return value count has prototype
     size_t count
If NDEBUG is defined, count will be zero. Otherwise, it will be the number of vectors that have been allocated (by TrackNewVec or TrackExtend) and not yet freed (by TrackDelete).

Macro
The preprocessor macro call
     CPPAD_TRACK_COUNT()
expands to
     CppAD::TrackCount(__FILE__, __LINE__)

Previously Deprecated
The preprocessor macro CppADTrackCount is the same as CPPAD_TRACK_COUNT and was previously deprecated.

Multi-Threading
These routines cannot be used in_parallel execution mode. Use the thread_alloc routines instead.

Example
The file TrackNewDel.cpp contains an example and test of these functions. It returns true, if it succeeds, and false otherwise.

---

Input File: cppad/utility/track_new_del.hpp