master: Adapt to xrst-2024.3.28 (use new template command).

CMakeLists.txt

@@ -16,7 +16,7 @@ IF( POLICY CMP0054 )
 ENDIF( POLICY CMP0054 )
 #
 # cppad_version is used by version.sh to get the version number.
-SET(cppad_version "20240323")
+SET(cppad_version "20240324")
 SET(cppad_url          "https://coin-or.github.io/CppAD" )
 SET(cppad_description  "Differentiation of C++ Algorithms" )
 IF( NOT DEFINED CMAKE_BUILD_TYPE)

appendix/whats_new/2003.xrst

@@ -5,7 +5,6 @@
 
 {xrst_begin 2003 app}
 {xrst_spell
-   constructor constructor
    ddouble
    def
    dodds

appendix/whats_new/2011.xrst

@@ -28,7 +28,6 @@
    pkgconfig
    prefixdir
    pthreads
-   requirements requirements
    rosen
    svn
    tgz

appendix/whats_new/2021.xrst

@@ -15,7 +15,6 @@
    ocurred
    pkgconfig
    txt
-   values values
 }
 
 Release Notes for 2021

example/multi_thread/bthread/get_started.cpp

@@ -2,48 +2,19 @@
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
 // SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
-
 /*
 {xrst_begin bthread_get_started.cpp}
 {xrst_spell
    fun fun
 }
 
-Getting Started Using Boost Multi-Threading With CppAD
-######################################################
-
-in_parallel
-***********
-see :ref:`ta_parallel_setup@in_parallel` .
-
-thread_number
-*************
-see :ref:`ta_parallel_setup@thread_num` .
-
-ADFun Constructor
-*****************
-If you use the :ref:`fun_construct@Sequence Constructor` for the original
-function, you will need to clear the Taylor coefficient memory associated
-with the function using :ref:`capacity_order-name` ; e.g. ::
-
-   CppAD::ADFun fun(ax, ay);
-   fun.capacity_order(0);
-
-If you do not free the Taylor coefficient memory in ``fun`` ,
-the function assignments will allocate zero order Taylor coefficients for each
-function in ``fun_thread`` using thread zero. Depending on what you do in
-parallel mode, you may attempt to free that memory using another thread.
-For example, if you change USE_DEFAULT_ADFUN_CONSTRUCTOR to 0, you will
-get the message::
-
-   Attempt to return memory for a different thread while in parallel mode
-
-Source Code
-***********
-{xrst_literal
-   // BEGIN C++
-   // END C++
-}
+{xrst_template ,
+   example/multi_thread/get_started.xrst
+   @Name@    , Boost
+   @####@    , #####
+   @DEFAULT@ , USE_DEFAULT_ADFUN_CONSTRUCTOR
+   @Dir@     , bthread
+} 
 
 {xrst_end bthread_get_started.cpp}
 ------------------------------------------------------------------------------

example/multi_thread/get_started.xrst

@@ -0,0 +1,45 @@
+{xrst_comment: This template file has the following parameters:
+@Name@    : is the name of this threading system
+@####@    : is the underlining for the name of the threading system
+@DEFAULT@ : is macro a macro name. If it is 1 (0), 
+            the ADFun default ctor is used (is not used)
+@Dir@     : is the subdirectory of multi_thread that contins the source code 
+            for this get_started.cpp
+}
+
+Getting Started Using @Name@ Threads With CppAD
+######################@####@###################
+
+in_parallel
+***********
+see :ref:`ta_parallel_setup@in_parallel` .
+
+thread_number
+*************
+see :ref:`ta_parallel_setup@thread_num` .
+
+ADFun Constructor
+*****************
+If you use the :ref:`fun_construct@Sequence Constructor` for the original
+function, you will need to clear the Taylor coefficient memory associated
+with the function using :ref:`capacity_order-name` ; e.g. ::
+
+   CppAD::ADFun fun(ax, ay);
+   fun.capacity_order(0);
+
+If you do not free the Taylor coefficient memory in ``fun`` ,
+the function assignments will allocate zero order Taylor coefficients for each
+function in ``fun_thread`` using thread zero. Depending on what you do in
+parallel mode, you may attempt to free that memory using another thread.
+For example, if you change @DEFAULT@ from 1 to 0, you will
+get the message::
+
+   Attempt to return memory for a different thread while in parallel mode
+
+Source Code
+***********
+{xrst_literal
+   example/multi_thread/@Dir@/get_started.cpp
+   // BEGIN C++
+   // END C++
+}

example/multi_thread/openmp/get_started.cpp

@@ -9,41 +9,13 @@
    fun fun
 }
 
-Getting Started Using OpenMP With CppAD
-#######################################
-
-in_parallel
-***********
-see :ref:`ta_parallel_setup@in_parallel` .
-
-thread_number
-*************
-see :ref:`ta_parallel_setup@thread_num` .
-
-ADFun Constructor
-*****************
-If you use the :ref:`fun_construct@Sequence Constructor` for the original
-function, you will need to clear the Taylor coefficient memory associated
-with the function using :ref:`capacity_order-name` ; e.g. ::
-
-   CppAD::ADFun fun(ax, ay);
-   fun.capacity_order(0);
-
-If you do not free the Taylor coefficient memory in ``fun`` ,
-the function assignments will allocate zero order Taylor coefficients for each
-function in ``fun_thread`` using thread zero. Depending on what you do in
-parallel mode, you may attempt to free that memory using another thread.
-For example, if you change USE_DEFAULT_ADFUN_CONSTRUCTOR to 0, you will
-get the message::
-
-   Attempt to return memory for a different thread while in parallel mode
-
-Source Code
-***********
-{xrst_literal
-   // BEGIN C++
-   // END C++
-}
+{xrst_template ,
+   example/multi_thread/get_started.xrst
+   @Name@    , OpenMP
+   @####@    , ######
+   @DEFAULT@ , USE_DEFAULT_ADFUN_CONSTRUCTOR
+   @Dir@     , openmp
+} 
 
 {xrst_end openmp_get_started.cpp}
 ------------------------------------------------------------------------------

example/multi_thread/pthread/get_started.cpp

@@ -9,41 +9,13 @@
    posix
 }
 
-Getting Started Using Posix Threads With CppAD
-##############################################
-
-in_parallel
-***********
-see :ref:`ta_parallel_setup@in_parallel` .
-
-thread_number
-*************
-see :ref:`ta_parallel_setup@thread_num` .
-
-ADFun Constructor
-*****************
-If you use the :ref:`fun_construct@Sequence Constructor` for the original
-function, you will need to clear the Taylor coefficient memory associated
-with the function using :ref:`capacity_order-name` ; e.g. ::
-
-   CppAD::ADFun fun(ax, ay);
-   fun.capacity_order(0);
-
-If you do not free the Taylor coefficient memory in ``fun`` ,
-the function assignments will allocate zero order Taylor coefficients for each
-function in ``fun_thread`` using thread zero. Depending on what you do in
-parallel mode, you may attempt to free that memory using another thread.
-For example, if you change USE_DEFAULT_ADFUN_CONSTRUCTOR to 0, you will
-get the message::
-
-   Attempt to return memory for a different thread while in parallel mode
-
-Source Code
-***********
-{xrst_literal
-   // BEGIN C++
-   // END C++
-}
+{xrst_template ,
+   example/multi_thread/get_started.xrst
+   @Name@    , Posix
+   @####@    , #####
+   @DEFAULT@ , USE_DEFAULT_ADFUN_CONSTRUCTOR
+   @Dir@     , pthread
+} 
 
 {xrst_end pthread_get_started.cpp}
 ------------------------------------------------------------------------------

introduction/exp_eps.xrst

@@ -321,7 +321,6 @@ Exercises
 -----------------------------------------------------------------------------
 {xrst_begin exp_eps_rev1}
 {xrst_spell
-   forward forward
    rcll
 }
 

user_guide.xrst

@@ -13,7 +13,7 @@
 
 {xrst_comment BEGIN: Before changing see new_release.sh and check_version.sh}
 
-cppad-20240323: CppAD User's Manual
+cppad-20240324: CppAD User's Manual
 ###################################
 
 .. image:: {xrst_dir coin.png}