From 6cf6628fedc03f2f38c3864145c181d7fb5ccce7 Mon Sep 17 00:00:00 2001 From: Brad Bell Date: Tue, 12 Nov 2024 07:32:00 -0700 Subject: [PATCH] master: fix white space below Syntax headings; see difference in 2024.xrst. --- appendix/deprecated/compare_change.xrst | 7 +++--- appendix/deprecated/fun_deprecated.xrst | 3 +-- appendix/deprecated/omp_alloc.xrst | 4 ++-- appendix/whats_new/2024.xrst | 24 +++++++++++++++++-- cppad_ipopt/src/cppad_ipopt_nlp.hpp | 1 - cppad_lib/code_gen_fun.cpp | 5 ++-- cppad_lib/csrc_writer.cpp | 3 +-- cppad_lib/temp_file.cpp | 5 ++-- example/abs_normal/abs_eval.hpp | 4 ++-- example/abs_normal/abs_min_linear.hpp | 3 +-- example/abs_normal/abs_min_quad.hpp | 1 - example/abs_normal/abs_print_mat.hpp | 4 ++-- example/abs_normal/lp_box.hpp | 3 +-- example/abs_normal/min_nso_linear.hpp | 3 +-- example/abs_normal/min_nso_quad.hpp | 1 - example/abs_normal/qp_box.hpp | 3 +-- example/abs_normal/qp_interior.hpp | 1 - example/abs_normal/simplex_method.hpp | 5 ++-- example/general/lu_vec_ad.cpp | 1 - example/json/get_started.cpp | 4 ++-- example/multi_thread/harmonic.cpp | 5 ++-- example/multi_thread/multi_atomic_three.cpp | 8 +++---- example/multi_thread/multi_atomic_two.cpp | 8 +++---- example/multi_thread/multi_chkpoint_one.cpp | 4 ++-- example/multi_thread/multi_chkpoint_two.cpp | 4 ++-- example/multi_thread/multi_newton.cpp | 1 - example/multi_thread/team_thread.hpp | 1 - include/cppad/base_require.hpp | 4 ++-- include/cppad/core/abort_recording.hpp | 4 ++-- include/cppad/core/abs.hpp | 3 +-- include/cppad/core/abs_normal_fun.hpp | 2 +- include/cppad/core/ad_assign.hpp | 2 +- include/cppad/core/ad_binary.hpp | 4 ++-- include/cppad/core/ad_ctor.hpp | 3 +-- include/cppad/core/ad_io.hpp | 4 ++-- include/cppad/core/ad_to_string.hpp | 4 ++-- include/cppad/core/atan2.hpp | 4 ++-- include/cppad/core/atomic/four/call.hpp | 1 - include/cppad/core/atomic/four/ctor.hpp | 3 +-- include/cppad/core/atomic/four/for_type.hpp | 4 ++-- .../cppad/core/atomic/four/jac_sparsity.hpp | 6 ++--- include/cppad/core/atomic/three/afun.hpp | 2 +- include/cppad/core/atomic/three/ctor.hpp | 3 +-- include/cppad/core/atomic/three/for_type.hpp | 4 ++-- .../cppad/core/atomic/three/hes_sparsity.hpp | 1 - .../cppad/core/atomic/three/jac_sparsity.hpp | 1 - .../cppad/core/atomic/three/rev_depend.hpp | 3 +-- include/cppad/core/atomic/two/afun.hpp | 2 +- include/cppad/core/atomic/two/atomic.hpp | 3 +-- include/cppad/core/atomic/two/clear.hpp | 4 ++-- include/cppad/core/atomic/two/ctor.hpp | 3 +-- .../cppad/core/atomic/two/for_sparse_hes.hpp | 2 +- .../cppad/core/atomic/two/for_sparse_jac.hpp | 5 ++-- include/cppad/core/atomic/two/option.hpp | 4 ++-- .../cppad/core/atomic/two/rev_sparse_hes.hpp | 4 ++-- .../cppad/core/atomic/two/rev_sparse_jac.hpp | 5 ++-- include/cppad/core/azmul.hpp | 2 +- include/cppad/core/base2ad.hpp | 4 ++-- include/cppad/core/base_hash.hpp | 4 ++-- include/cppad/core/bender_quad.hpp | 3 +-- include/cppad/core/bool_fun.hpp | 6 ++--- include/cppad/core/capacity_order.hpp | 2 +- include/cppad/core/check_for_nan.hpp | 3 +-- .../cppad/core/chkpoint_one/chkpoint_one.hpp | 1 - include/cppad/core/chkpoint_two/chk_fun.xrst | 4 ++-- include/cppad/core/chkpoint_two/ctor.hpp | 3 +-- include/cppad/core/chkpoint_two/dynamic.hpp | 4 ++-- include/cppad/core/compare.hpp | 5 ++-- include/cppad/core/compound_assign.hpp | 4 ++-- include/cppad/core/con_dyn_var.hpp | 1 - include/cppad/core/cond_exp.hpp | 2 +- include/cppad/core/cppad_assert.hpp | 8 +++---- include/cppad/core/dependent.hpp | 2 +- include/cppad/core/discrete/discrete.hpp | 3 +-- include/cppad/core/discrete/user.xrst | 3 +-- include/cppad/core/epsilon.hpp | 4 ++-- include/cppad/core/equal_op_seq.hpp | 4 ++-- include/cppad/core/for_hes_sparsity.hpp | 1 - include/cppad/core/for_jac_sparsity.hpp | 3 +-- include/cppad/core/for_one.hpp | 4 ++-- include/cppad/core/for_sparse_hes.hpp | 5 ++-- include/cppad/core/for_sparse_jac.hpp | 8 +++---- include/cppad/core/for_two.hpp | 4 ++-- .../cppad/core/forward/compare_change.xrst | 6 ++--- include/cppad/core/forward/forward.hpp | 3 +-- include/cppad/core/forward/forward_dir.xrst | 5 ++-- include/cppad/core/forward/forward_one.xrst | 4 ++-- include/cppad/core/forward/forward_order.xrst | 3 +-- include/cppad/core/forward/forward_two.xrst | 4 ++-- include/cppad/core/forward/forward_zero.xrst | 8 +++---- include/cppad/core/forward/size_order.xrst | 4 ++-- include/cppad/core/fun_check.hpp | 9 +++---- include/cppad/core/fun_construct.hpp | 1 - include/cppad/core/fun_property.xrst | 1 - include/cppad/core/function_name.xrst | 3 +-- include/cppad/core/graph/cpp_graph.hpp | 3 +-- include/cppad/core/graph/from_graph.hpp | 1 - include/cppad/core/graph/from_json.hpp | 3 +-- include/cppad/core/graph/to_graph.hpp | 1 - include/cppad/core/graph/to_json.hpp | 5 ++-- include/cppad/core/hessian.hpp | 3 +-- .../cppad/core/independent/independent.hpp | 4 ++-- include/cppad/core/independent/user.xrst | 3 +-- include/cppad/core/integer.hpp | 4 ++-- include/cppad/core/jacobian.hpp | 4 ++-- include/cppad/core/lu_ratio.hpp | 5 ++-- include/cppad/core/near_equal_ext.hpp | 4 ++-- include/cppad/core/new_dynamic.hpp | 4 ++-- include/cppad/core/num_skip.hpp | 2 +- include/cppad/core/numeric_limits.hpp | 3 +-- include/cppad/core/omp_max_thread.hpp | 5 ++-- include/cppad/core/opt_val_hes.hpp | 4 ++-- include/cppad/core/optimize.hpp | 3 +-- include/cppad/core/parallel_ad.hpp | 2 +- include/cppad/core/pow.hpp | 4 ++-- include/cppad/core/print_for.hpp | 1 - include/cppad/core/rev_hes_sparsity.hpp | 1 - include/cppad/core/rev_jac_sparsity.hpp | 3 +-- include/cppad/core/rev_one.hpp | 4 ++-- include/cppad/core/rev_sparse_hes.hpp | 8 +++---- include/cppad/core/rev_sparse_jac.hpp | 8 +++---- include/cppad/core/rev_two.hpp | 4 ++-- include/cppad/core/sign.hpp | 4 ++-- include/cppad/core/sparse_hes.hpp | 3 +-- include/cppad/core/sparse_hessian.hpp | 3 +-- include/cppad/core/sparse_jac.hpp | 3 +-- include/cppad/core/sparse_jacobian.hpp | 3 +-- include/cppad/core/standard_math.hpp | 4 ++-- include/cppad/core/std_math_11.hpp | 2 +- include/cppad/core/subgraph_jac_rev.hpp | 3 +-- include/cppad/core/subgraph_reverse.hpp | 1 - include/cppad/core/subgraph_sparsity.hpp | 3 +-- include/cppad/core/testvector.hpp | 3 +-- include/cppad/core/to_csrc.hpp | 3 +-- include/cppad/core/unary_minus.hpp | 5 ++-- include/cppad/core/unary_plus.hpp | 5 ++-- include/cppad/core/value.hpp | 2 +- include/cppad/core/var2par.hpp | 4 ++-- include/cppad/core/vec_ad/user.xrst | 11 ++++----- include/cppad/core/vec_ad/vec_ad.hpp | 3 +-- .../atomic_four/lin_ode/base_solver.hpp | 1 - .../cppad/example/atomic_four/lin_ode/get.hpp | 4 ++-- .../example/atomic_four/lin_ode/lin_ode.xrst | 3 +-- .../cppad/example/atomic_four/lin_ode/set.hpp | 4 ++-- .../cppad/example/atomic_four/mat_mul/get.hpp | 4 ++-- .../example/atomic_four/mat_mul/mat_mul.xrst | 3 +-- .../cppad/example/atomic_four/mat_mul/set.hpp | 4 ++-- .../example/atomic_four/vector/vector.xrst | 3 +-- include/cppad/example/base_adolc.hpp | 6 ++--- include/cppad/example/cppad_eigen.hpp | 4 +--- include/cppad/ipopt/solve.hpp | 1 - include/cppad/local/atomic_index.hpp | 3 +-- include/cppad/local/graph/cpp_graph_itr.hpp | 4 ++-- include/cppad/local/graph/csrc_writer.hpp | 4 ++-- include/cppad/local/graph/json_lexer.hpp | 5 ++-- include/cppad/local/graph/json_parser.hpp | 4 ++-- include/cppad/local/graph/json_writer.hpp | 4 ++-- include/cppad/local/op_code_dyn.hpp | 5 ++-- .../cppad/local/optimize/get_cexp_info.hpp | 1 - .../cppad/local/optimize/get_op_previous.hpp | 3 +-- include/cppad/local/optimize/match_op.hpp | 1 - include/cppad/local/optimize/optimize_run.hpp | 1 - include/cppad/local/record/comp_op.hpp | 5 ++-- include/cppad/local/record/cond_exp.hpp | 3 +-- include/cppad/local/record/put_dyn_atomic.hpp | 1 - include/cppad/local/record/put_var_atomic.hpp | 3 +-- include/cppad/local/record/put_var_vecad.hpp | 4 ++-- include/cppad/local/sparse/size_setvec.hpp | 2 +- include/cppad/local/sparse/unary_op.hpp | 3 +-- include/cppad/local/sweep/for_hes.hpp | 1 - include/cppad/local/sweep/forward0.hpp | 1 - include/cppad/local/sweep/rev_jac.hpp | 1 - .../cppad/local/utility/cppad_vector_itr.hpp | 14 +++++------ include/cppad/local/utility/vector_bool.hpp | 3 +-- include/cppad/local/val_graph/fun2val.hpp | 1 - include/cppad/local/val_graph/op_iterator.hpp | 3 +-- include/cppad/local/val_graph/val2fun.hpp | 1 - include/cppad/local/var_op/binary_op.xrst | 1 - include/cppad/local/var_op/discrete_op.hpp | 1 - include/cppad/local/var_op/unary_op.xrst | 2 +- include/cppad/speed/det_33.hpp | 8 +++---- include/cppad/speed/det_by_lu.hpp | 3 +-- include/cppad/speed/det_by_minor.hpp | 3 +-- include/cppad/speed/det_grad_33.hpp | 8 +++---- include/cppad/speed/det_of_minor.hpp | 3 +-- include/cppad/speed/mat_sum_sq.hpp | 8 +++---- include/cppad/speed/ode_evaluate.hpp | 6 ++--- include/cppad/speed/sparse_hes_fun.hpp | 8 +++---- include/cppad/speed/sparse_jac_fun.hpp | 8 +++---- include/cppad/speed/uniform_01.hpp | 6 ++--- include/cppad/utility/check_numeric_type.hpp | 8 +++---- include/cppad/utility/create_dll_lib.hpp | 3 +-- include/cppad/utility/elapsed_seconds.hpp | 8 +++---- include/cppad/utility/error_handler.hpp | 1 - include/cppad/utility/index_sort.hpp | 8 +++---- include/cppad/utility/link_dll_lib.hpp | 4 +--- include/cppad/utility/lu_factor.hpp | 6 ++--- include/cppad/utility/lu_invert.hpp | 8 +++---- include/cppad/utility/lu_solve.hpp | 8 +++---- include/cppad/utility/memory_leak.hpp | 4 +--- include/cppad/utility/nan.hpp | 4 +--- include/cppad/utility/near_equal.hpp | 8 +++---- include/cppad/utility/ode_err_control.hpp | 1 - include/cppad/utility/ode_gear.hpp | 8 +++---- include/cppad/utility/ode_gear_control.hpp | 3 +-- include/cppad/utility/omp_alloc.hpp | 3 +-- include/cppad/utility/poly.hpp | 8 +++---- include/cppad/utility/pow_int.hpp | 8 +++---- include/cppad/utility/romberg_mul.hpp | 11 ++++----- include/cppad/utility/romberg_one.hpp | 8 +++---- include/cppad/utility/rosen_34.hpp | 3 +-- include/cppad/utility/runge_45.hpp | 3 +-- include/cppad/utility/set_union.hpp | 8 +++---- include/cppad/utility/sparse2eigen.hpp | 6 ++--- include/cppad/utility/sparse_rcv.hpp | 3 +-- include/cppad/utility/speed_test.hpp | 8 +++---- include/cppad/utility/test_boolofvoid.hpp | 6 ++--- include/cppad/utility/thread_alloc.hpp | 3 +-- include/cppad/utility/time_test.hpp | 3 +-- include/cppad/utility/to_string.hpp | 8 +++---- include/cppad/utility/track_new_del.hpp | 6 ++--- include/cppad/utility/vector.hpp | 3 +-- include/cppad/utility/vector_bool.hpp | 3 +-- include/cppad/utility/xrst/cppad_vector.xrst | 3 +-- include/cppad/wno_conversion.hpp | 4 ++-- introduction/exp_2.hpp | 7 +++--- introduction/exp_eps.hpp | 7 +++--- speed/adolc/alloc_mat.cpp | 1 - speed/main.cpp | 4 ++-- speed/src/dev_link.xrst | 5 ++-- speed/src/link.xrst | 5 ++-- speed/src/link_sparse_hessian.cpp | 4 ++-- speed/src/link_sparse_hessian.hpp | 3 +-- test_more/compare_c/det_by_minor.c | 4 ++-- xrst/install/testvector.xrst | 2 +- xrst/reverse/reverse_any.xrst | 4 ++-- xrst/reverse/reverse_one.xrst | 4 ++-- xrst/reverse/reverse_two.xrst | 4 ++-- xrst/thread_alloc.xrst | 4 ++-- 239 files changed, 386 insertions(+), 564 deletions(-) diff --git a/appendix/deprecated/compare_change.xrst b/appendix/deprecated/compare_change.xrst index cc230a5a8..a3438e194 100644 --- a/appendix/deprecated/compare_change.xrst +++ b/appendix/deprecated/compare_change.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin CompareChange app} @@ -9,9 +9,10 @@ Comparison Changes During Zero Order Forward Mode Syntax ****** -*c* = *f* . ``CompareChange`` () +| *c* = *f* . ``CompareChange`` () -**See Also** +See Also +******** :ref:`FunCheck-name` Deprecated 2015-01-20 diff --git a/appendix/deprecated/fun_deprecated.xrst b/appendix/deprecated/fun_deprecated.xrst index 112d0d739..82aa8277a 100644 --- a/appendix/deprecated/fun_deprecated.xrst +++ b/appendix/deprecated/fun_deprecated.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin fun_deprecated app} @@ -9,7 +9,6 @@ ADFun Object Deprecated Member Functions Syntax ****** - | *f* . ``Dependent`` ( *y* ) | *o* = *f* . ``Order`` () | *m* = *f* . ``Memory`` () diff --git a/appendix/deprecated/omp_alloc.xrst b/appendix/deprecated/omp_alloc.xrst index fd85a4d9a..e6bea5071 100644 --- a/appendix/deprecated/omp_alloc.xrst +++ b/appendix/deprecated/omp_alloc.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-22 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin omp_alloc app} @@ -9,7 +9,7 @@ A Quick OpenMP Memory Allocator Used by CppAD Syntax ****** -``# include `` +| ``# include `` Purpose ******* diff --git a/appendix/whats_new/2024.xrst b/appendix/whats_new/2024.xrst index fd3538e53..9e03ba1a4 100644 --- a/appendix/whats_new/2024.xrst +++ b/appendix/whats_new/2024.xrst @@ -5,6 +5,7 @@ {xrst_begin 2024 app} {xrst_spell + au bitwise boostvector bostvector @@ -33,9 +34,28 @@ Release Notes for 2024 mm-dd ***** +11-12 +===== +Remove extra unintended white space below Syntax headings +that was introduced when the CppAD documentation was converted from +omhelp to sphinx; see :ref:`2022-12-16<2022@mm-dd@12-16>` . +For example: + +Old Syntax +---------- + + ``atomic_user`` *a_square_root* + +*a_square_root* ( *au* , *ay* ) + +New Syntax +---------- +| ``atomic_user`` *a_square_root* +| *a_square_root* ( *au* , *ay* ) + 10-04 ===== -The :ref:`jit_compile.cpp-name` example line was missing +The :ref:`jit_compile.cpp-name` example line was missing CPPAD_C_COMPILER_CMD in the line (this has been fixed):: const char* cmd = CPPAD_C_COMPILER_CMD " --version > temp"; @@ -45,7 +65,7 @@ CPPAD_C_COMPILER_CMD in the line (this has been fixed):: #. The *include_eigen* argument was removed from the :ref:`cmake-name` command because Eigen is available using most package managers; see :ref:`cmake@Eigen` . -#. Remove *boost_dir* and *eigen_dir* from :ref:`configure-name` +#. Remove *boost_dir* and *eigen_dir* from :ref:`configure-name` (they no longer have any effect). 09-28 diff --git a/cppad_ipopt/src/cppad_ipopt_nlp.hpp b/cppad_ipopt/src/cppad_ipopt_nlp.hpp index 1871f5e0a..402bd9dbc 100644 --- a/cppad_ipopt/src/cppad_ipopt_nlp.hpp +++ b/cppad_ipopt/src/cppad_ipopt_nlp.hpp @@ -25,7 +25,6 @@ This interface to Ipopt is deprecated, use :ref:`ipopt_solve-name` instead. Syntax ****** - | # ``include`` ``"cppad_ipopt_nlp.hpp"`` | ``cppad_ipopt_solution`` *solution* ; | ``cppad_ipopt_nlp`` *cppad_nlp* ( diff --git a/cppad_lib/code_gen_fun.cpp b/cppad_lib/code_gen_fun.cpp index f98df7d01..ae605f6f1 100644 --- a/cppad_lib/code_gen_fun.cpp +++ b/cppad_lib/code_gen_fun.cpp @@ -1,6 +1,6 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin code_gen_fun} @@ -14,8 +14,7 @@ Generate Source Code and Compile an AD Function Syntax ****** - - # ``include `` +| # ``include `` Constructors ============ diff --git a/cppad_lib/csrc_writer.cpp b/cppad_lib/csrc_writer.cpp index de168dad9..6f5767f43 100644 --- a/cppad_lib/csrc_writer.cpp +++ b/cppad_lib/csrc_writer.cpp @@ -10,8 +10,7 @@ Converts Cpp Graph to C Source Syntax ****** -``csrc_writer(%os%, %graph_obj%, %c_type%)`` -``%`` +| ``csrc_writer`` ( *os* , *graph_obj* , *c_type* ) Prototype ********* diff --git a/cppad_lib/temp_file.cpp b/cppad_lib/temp_file.cpp index 6546b2913..240b4a3ca 100644 --- a/cppad_lib/temp_file.cpp +++ b/cppad_lib/temp_file.cpp @@ -1,6 +1,6 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin temp_file dev} @@ -13,8 +13,7 @@ Create a New Empty Temporary File Syntax ****** - - *file_name* = ``temp_file`` () +| *file_name* = ``temp_file`` () file_name ********* diff --git a/example/abs_normal/abs_eval.hpp b/example/abs_normal/abs_eval.hpp index 9942e8487..16ddf7fe1 100644 --- a/example/abs_normal/abs_eval.hpp +++ b/example/abs_normal/abs_eval.hpp @@ -2,7 +2,7 @@ # define CPPAD_EXAMPLE_ABS_NORMAL_ABS_EVAL_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin abs_eval} @@ -11,7 +11,7 @@ abs_normal: Evaluate First Order Approximation Syntax ****** -*g_tilde* = ``abs_eval`` ( *n* , *m* , *s* , *g_hat* , *g_jac* , *delta_x* ) +| *g_tilde* = ``abs_eval`` ( *n* , *m* , *s* , *g_hat* , *g_jac* , *delta_x* ) Prototype ********* diff --git a/example/abs_normal/abs_min_linear.hpp b/example/abs_normal/abs_min_linear.hpp index 5c796d2f5..ecece0421 100644 --- a/example/abs_normal/abs_min_linear.hpp +++ b/example/abs_normal/abs_min_linear.hpp @@ -2,7 +2,7 @@ # define CPPAD_EXAMPLE_ABS_NORMAL_ABS_MIN_LINEAR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin abs_min_linear} @@ -16,7 +16,6 @@ abs_normal: Minimize a Linear Abs-normal Approximation Syntax ****** - | *ok* = ``abs_min_linear`` ( | |tab| *level* , *n* , *m* , *s* , | |tab| *g_hat* , *g_jac* , *bound* , *epsilon* , *maxitr* , *delta_x* diff --git a/example/abs_normal/abs_min_quad.hpp b/example/abs_normal/abs_min_quad.hpp index 23afe026c..b275d88d5 100644 --- a/example/abs_normal/abs_min_quad.hpp +++ b/example/abs_normal/abs_min_quad.hpp @@ -16,7 +16,6 @@ abs_normal: Minimize a Linear Abs-normal Approximation Syntax ****** - | *ok* = ``abs_min_quad`` ( | |tab| *level* , *n* , *m* , *s* , | |tab| *g_hat* , *g_jac* , *hessian* , *bound* , *epsilon* , *maxitr* , *delta_x* diff --git a/example/abs_normal/abs_print_mat.hpp b/example/abs_normal/abs_print_mat.hpp index dc5157aef..8511c7007 100644 --- a/example/abs_normal/abs_print_mat.hpp +++ b/example/abs_normal/abs_print_mat.hpp @@ -2,7 +2,7 @@ # define CPPAD_EXAMPLE_ABS_NORMAL_ABS_PRINT_MAT_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin abs_print_mat} @@ -15,7 +15,7 @@ abs_normal: Print a Vector or Matrix Syntax ****** -``abs_print_mat`` ( *name* , *nr* , *nc* , *mat* ) +| ``abs_print_mat`` ( *name* , *nr* , *nc* , *mat* ) Prototype ********* diff --git a/example/abs_normal/lp_box.hpp b/example/abs_normal/lp_box.hpp index 431e9032a..efcb908d0 100644 --- a/example/abs_normal/lp_box.hpp +++ b/example/abs_normal/lp_box.hpp @@ -2,7 +2,7 @@ # define CPPAD_EXAMPLE_ABS_NORMAL_LP_BOX_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin lp_box} @@ -16,7 +16,6 @@ abs_normal: Solve a Linear Program With Box Constraints Syntax ****** - | *ok* = ``lp_box`` ( | |tab| *level* , *A* , *b* , *c* , *d* , *maxitr* , *xout* | ) diff --git a/example/abs_normal/min_nso_linear.hpp b/example/abs_normal/min_nso_linear.hpp index 2f3e2d5ba..586941ce2 100644 --- a/example/abs_normal/min_nso_linear.hpp +++ b/example/abs_normal/min_nso_linear.hpp @@ -2,7 +2,7 @@ # define CPPAD_EXAMPLE_ABS_NORMAL_MIN_NSO_LINEAR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin min_nso_linear} @@ -15,7 +15,6 @@ Non-Smooth Optimization Using Abs-normal Linear Approximations Syntax ****** - | *ok* = ``min_nso_linear`` ( | |tab| *level* , *g* , *a* , *epsilon* , *maxitr* , *b_in* , *x_in* , *x_out* | ) diff --git a/example/abs_normal/min_nso_quad.hpp b/example/abs_normal/min_nso_quad.hpp index d28f03d1a..7262e41c2 100644 --- a/example/abs_normal/min_nso_quad.hpp +++ b/example/abs_normal/min_nso_quad.hpp @@ -15,7 +15,6 @@ Non-Smooth Optimization Using Abs-normal Quadratic Approximations Syntax ****** - | *ok* = ``min_nso_quad`` ( | |tab| *level* , *f* , *g* , *a* , *epsilon* , *maxitr* , *b_in* , *x_in* , *x_out* | ) diff --git a/example/abs_normal/qp_box.hpp b/example/abs_normal/qp_box.hpp index d7a24c523..3ba45b96b 100644 --- a/example/abs_normal/qp_box.hpp +++ b/example/abs_normal/qp_box.hpp @@ -2,7 +2,7 @@ # define CPPAD_EXAMPLE_ABS_NORMAL_QP_BOX_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin qp_box} @@ -17,7 +17,6 @@ abs_normal: Solve a Quadratic Program With Box Constraints Syntax ****** - | *ok* = ``qp_box`` ( | |tab| *level* , *a* , *b* , *c* , *C* , *g* , *G* , *epsilon* , *maxitr* , *xin* , *xout* | ) diff --git a/example/abs_normal/qp_interior.hpp b/example/abs_normal/qp_interior.hpp index 02307ca0d..5e53b3c30 100644 --- a/example/abs_normal/qp_interior.hpp +++ b/example/abs_normal/qp_interior.hpp @@ -20,7 +20,6 @@ Solve a Quadratic Program Using Interior Point Method Syntax ****** - | *ok* = ``qp_interior`` ( | *level* , *c* , *C* , *g* , *G* , *epsilon* , *maxitr* , *xin* , *xout* , *yout* , *sout* | ) diff --git a/example/abs_normal/simplex_method.hpp b/example/abs_normal/simplex_method.hpp index 516a61fa6..c3d4595b5 100644 --- a/example/abs_normal/simplex_method.hpp +++ b/example/abs_normal/simplex_method.hpp @@ -2,7 +2,7 @@ # define CPPAD_EXAMPLE_ABS_NORMAL_SIMPLEX_METHOD_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin simplex_method} @@ -17,8 +17,7 @@ abs_normal: Solve a Linear Program Using Simplex Method Syntax ****** - - *ok* = ``simplex_method`` ( *level* , *b* , *A* , *c* , *maxitr* , *xout* ) +| *ok* = ``simplex_method`` ( *level* , *b* , *A* , *c* , *maxitr* , *xout* ) Prototype ********* diff --git a/example/general/lu_vec_ad.cpp b/example/general/lu_vec_ad.cpp index 7552b53f5..5df9ad6de 100644 --- a/example/general/lu_vec_ad.cpp +++ b/example/general/lu_vec_ad.cpp @@ -16,7 +16,6 @@ Lu Factor and Solve with Recorded Pivoting Syntax ****** - | ``int lu_vec_ad`` ( | |tab| ``size_t`` *n* , | |tab| ``size_t`` *m* , diff --git a/example/json/get_started.cpp b/example/json/get_started.cpp index f37255a73..23e9aa981 100644 --- a/example/json/get_started.cpp +++ b/example/json/get_started.cpp @@ -1,6 +1,6 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin json_get_started.cpp} @@ -50,7 +50,7 @@ Include the CppAD core functions: Syntax ****** -*ok* = ``get_started`` () +| *ok* = ``get_started`` () {xrst_spell_off} {xrst_code cpp} */ bool get_started(void) diff --git a/example/multi_thread/harmonic.cpp b/example/multi_thread/harmonic.cpp index 214d92930..1c84467a2 100644 --- a/example/multi_thread/harmonic.cpp +++ b/example/multi_thread/harmonic.cpp @@ -1,6 +1,6 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin harmonic_common} @@ -75,8 +75,7 @@ Set Up Multi-threading Sum of 1/i Syntax ****** - - *ok* = ``harmonic_setup`` ( *num_sum* ) +| *ok* = ``harmonic_setup`` ( *num_sum* ) Purpose ******* diff --git a/example/multi_thread/multi_atomic_three.cpp b/example/multi_thread/multi_atomic_three.cpp index a826ff0ce..83f29d650 100644 --- a/example/multi_thread/multi_atomic_three.cpp +++ b/example/multi_thread/multi_atomic_three.cpp @@ -1,6 +1,6 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -14,10 +14,8 @@ Defines a atomic_three Operation that Computes Square Root Syntax ****** - - ``atomic_user`` *a_square_root* - -*a_square_root* ( *au* , *ay* ) +| ``atomic_user`` *a_square_root* +| *a_square_root* ( *au* , *ay* ) Purpose ******* diff --git a/example/multi_thread/multi_atomic_two.cpp b/example/multi_thread/multi_atomic_two.cpp index 688bd4787..76e58b158 100644 --- a/example/multi_thread/multi_atomic_two.cpp +++ b/example/multi_thread/multi_atomic_two.cpp @@ -1,6 +1,6 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -14,10 +14,8 @@ Defines a atomic_two Operation that Computes Square Root Syntax ****** - - ``atomic_user`` *a_square_root* - -*a_square_root* ( *au* , *ay* ) +| ``atomic_user`` *a_square_root* +| *a_square_root* ( *au* , *ay* ) Purpose ******* diff --git a/example/multi_thread/multi_chkpoint_one.cpp b/example/multi_thread/multi_chkpoint_one.cpp index ad2c4b776..f25a3e047 100644 --- a/example/multi_thread/multi_chkpoint_one.cpp +++ b/example/multi_thread/multi_chkpoint_one.cpp @@ -1,6 +1,6 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -14,7 +14,7 @@ chkpoint_one Algorithm that Computes Square Root Syntax ****** -*checkpoint_algo* ( *au* , *ay* ) +| *checkpoint_algo* ( *au* , *ay* ) Purpose ******* diff --git a/example/multi_thread/multi_chkpoint_two.cpp b/example/multi_thread/multi_chkpoint_two.cpp index 39d762e40..42cac5d61 100644 --- a/example/multi_thread/multi_chkpoint_two.cpp +++ b/example/multi_thread/multi_chkpoint_two.cpp @@ -1,6 +1,6 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -14,7 +14,7 @@ chkpoint_two Algorithm that Computes Square Root Syntax ****** -*checkpoint_algo* ( *au* , *ay* ) +| *checkpoint_algo* ( *au* , *ay* ) Purpose ******* diff --git a/example/multi_thread/multi_newton.cpp b/example/multi_thread/multi_newton.cpp index 290de323f..01e774279 100644 --- a/example/multi_thread/multi_newton.cpp +++ b/example/multi_thread/multi_newton.cpp @@ -87,7 +87,6 @@ Set Up Multi-Threaded Newton Method Syntax ****** - | *ok* = ``multi_newton_setup`` ( | |tab| *num_sub* , *xlow* , *xup* , *epsilon* , *max_itr* , *num_threads* | ) diff --git a/example/multi_thread/team_thread.hpp b/example/multi_thread/team_thread.hpp index 9d7d13d5c..5fa6c04a2 100644 --- a/example/multi_thread/team_thread.hpp +++ b/example/multi_thread/team_thread.hpp @@ -16,7 +16,6 @@ Specifications for A Team of AD Threads Syntax ****** - | ``include`` ``"team_thread.hpp"`` | *ok* = ``team_create`` ( *num_threads* ) | *ok* = ``team_work`` ( *worker* ) diff --git a/include/cppad/base_require.hpp b/include/cppad/base_require.hpp index 2e8aac505..9a1db440a 100644 --- a/include/cppad/base_require.hpp +++ b/include/cppad/base_require.hpp @@ -2,7 +2,7 @@ # define CPPAD_BASE_REQUIRE_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -16,7 +16,7 @@ AD Requirements for a CppAD Base Type Syntax ****** -``# include `` +| ``# include `` Purpose ******* diff --git a/include/cppad/core/abort_recording.hpp b/include/cppad/core/abort_recording.hpp index 05ab5774d..91ce6e6aa 100644 --- a/include/cppad/core/abort_recording.hpp +++ b/include/cppad/core/abort_recording.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ABORT_RECORDING_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin abort_recording} @@ -12,7 +12,7 @@ Abort Recording of an Operation Sequence Syntax ****** -``AD`` < *Base* >:: ``abort_recording`` () +| ``AD`` < *Base* >:: ``abort_recording`` () Purpose ******* diff --git a/include/cppad/core/abs.hpp b/include/cppad/core/abs.hpp index c876fca79..23d4fe575 100644 --- a/include/cppad/core/abs.hpp +++ b/include/cppad/core/abs.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ABS_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -18,7 +18,6 @@ AD Absolute Value Functions: abs, fabs Syntax ****** - | *y* = ``abs`` ( *x* ) | *y* = ``fabs`` ( *x* ) diff --git a/include/cppad/core/abs_normal_fun.hpp b/include/cppad/core/abs_normal_fun.hpp index d39f08b81..07a143f0f 100644 --- a/include/cppad/core/abs_normal_fun.hpp +++ b/include/cppad/core/abs_normal_fun.hpp @@ -12,7 +12,7 @@ Create An Abs-normal Representation of a Function Syntax ****** -*f* . ``abs_normal_fun`` ( *g* , *a* ) +| *f* . ``abs_normal_fun`` ( *g* , *a* ) f * diff --git a/include/cppad/core/ad_assign.hpp b/include/cppad/core/ad_assign.hpp index 04a54287a..d23a7301b 100644 --- a/include/cppad/core/ad_assign.hpp +++ b/include/cppad/core/ad_assign.hpp @@ -15,7 +15,7 @@ AD Assignment Operator Syntax ****** -*y* = *x* +| *y* = *x* Purpose ******* diff --git a/include/cppad/core/ad_binary.hpp b/include/cppad/core/ad_binary.hpp index cc7f60d52..860358224 100644 --- a/include/cppad/core/ad_binary.hpp +++ b/include/cppad/core/ad_binary.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_AD_BINARY_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -17,7 +17,7 @@ AD Binary Arithmetic Operators Syntax ****** -*z* = *x* *Op* *y* +| *z* = *x* *Op* *y* Purpose ******* diff --git a/include/cppad/core/ad_ctor.hpp b/include/cppad/core/ad_ctor.hpp index b27fbcafe..3b2109a68 100644 --- a/include/cppad/core/ad_ctor.hpp +++ b/include/cppad/core/ad_ctor.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_AD_CTOR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -15,7 +15,6 @@ AD Constructors Syntax ****** - | ``AD`` < *Base* > *ay* () | ``AD`` < *Base* > *ay* ( *x* ) diff --git a/include/cppad/core/ad_io.hpp b/include/cppad/core/ad_io.hpp index 111780e5d..ad770f113 100644 --- a/include/cppad/core/ad_io.hpp +++ b/include/cppad/core/ad_io.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_AD_IO_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -16,7 +16,7 @@ AD Input Stream Operator Syntax ****** -*is* >> *x* +| *is* >> *x* Purpose ******* diff --git a/include/cppad/core/ad_to_string.hpp b/include/cppad/core/ad_to_string.hpp index a4a8d433d..6b4d41bbf 100644 --- a/include/cppad/core/ad_to_string.hpp +++ b/include/cppad/core/ad_to_string.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_AD_TO_STRING_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,7 +13,7 @@ Convert An AD or Base Type to String Syntax ****** -*s* = ``to_string`` ( *value* ) . +| *s* = ``to_string`` ( *value* ) . See Also ******** diff --git a/include/cppad/core/atan2.hpp b/include/cppad/core/atan2.hpp index 09f8785c6..010b44fd5 100644 --- a/include/cppad/core/atan2.hpp +++ b/include/cppad/core/atan2.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATAN2_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -14,7 +14,7 @@ AD Two Argument Inverse Tangent Function Syntax ****** -*theta* = ``atan2`` ( *y* , *x* ) +| *theta* = ``atan2`` ( *y* , *x* ) Purpose ******* diff --git a/include/cppad/core/atomic/four/call.hpp b/include/cppad/core/atomic/four/call.hpp index 6740efd6c..b43b00569 100644 --- a/include/cppad/core/atomic/four/call.hpp +++ b/include/cppad/core/atomic/four/call.hpp @@ -12,7 +12,6 @@ Calling an Atomic Function Syntax ****** - | *afun* ( *ax* , *ay* ) | *ay* = *afun* ( *call_id* , *ax* , *ay* ) diff --git a/include/cppad/core/atomic/four/ctor.hpp b/include/cppad/core/atomic/four/ctor.hpp index c49893be2..49faf6dd8 100644 --- a/include/cppad/core/atomic/four/ctor.hpp +++ b/include/cppad/core/atomic/four/ctor.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_FOUR_CTOR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_four_ctor} @@ -12,7 +12,6 @@ Atomic Function Constructor Syntax ****** - | ``class`` *atomic_user* : ``public CppAD::atomic_four<`` *Base* > { | ``public:`` | |tab| *atomic_user* ( *ctor_arg_list* ) : ``CppAD::atomic_four<`` *Base* >( *name* ) diff --git a/include/cppad/core/atomic/four/for_type.hpp b/include/cppad/core/atomic/four/for_type.hpp index c3f310b43..ed5bb029a 100644 --- a/include/cppad/core/atomic/four/for_type.hpp +++ b/include/cppad/core/atomic/four/for_type.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_FOUR_FOR_TYPE_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_four_for_type} @@ -12,7 +12,7 @@ Atomic Function Forward Type Calculation Syntax ****** -*ok* = *afun* . ``for_type`` ( *call_id* , *type_x* , *type_y* ) +| *ok* = *afun* . ``for_type`` ( *call_id* , *type_x* , *type_y* ) Prototype ********* diff --git a/include/cppad/core/atomic/four/jac_sparsity.hpp b/include/cppad/core/atomic/four/jac_sparsity.hpp index b31aed746..16d19ccf3 100644 --- a/include/cppad/core/atomic/four/jac_sparsity.hpp +++ b/include/cppad/core/atomic/four/jac_sparsity.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_FOUR_JAC_SPARSITY_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -14,8 +14,8 @@ Atomic Function Jacobian Sparsity Patterns Syntax ****** -You can define one or the other of the following callbacks, -but you should not define both. +| You can define one or the other of the following callbacks, +| but you should not define both. Preferred ========= diff --git a/include/cppad/core/atomic/three/afun.hpp b/include/cppad/core/atomic/three/afun.hpp index 2271cef07..f4a2810d7 100644 --- a/include/cppad/core/atomic/three/afun.hpp +++ b/include/cppad/core/atomic/three/afun.hpp @@ -12,7 +12,7 @@ Using AD Version of an Atomic Function Syntax ****** -*afun* ( *ax* , *ay* ) +| *afun* ( *ax* , *ay* ) Prototype ********* diff --git a/include/cppad/core/atomic/three/ctor.hpp b/include/cppad/core/atomic/three/ctor.hpp index 8a748a094..f6ba115e0 100644 --- a/include/cppad/core/atomic/three/ctor.hpp +++ b/include/cppad/core/atomic/three/ctor.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_THREE_CTOR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_three_ctor} @@ -12,7 +12,6 @@ Atomic Function Constructor Syntax ****** - | ``class`` *atomic_user* : ``public CppAD::atomic_three<`` *Base* > { | ``public:`` | |tab| *atomic_user* ( *ctor_arg_list* ) : ``CppAD::atomic_three<`` *Base* >( *name* ) diff --git a/include/cppad/core/atomic/three/for_type.hpp b/include/cppad/core/atomic/three/for_type.hpp index a92ef92b7..378725221 100644 --- a/include/cppad/core/atomic/three/for_type.hpp +++ b/include/cppad/core/atomic/three/for_type.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_THREE_FOR_TYPE_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_three_for_type} @@ -12,7 +12,7 @@ Atomic Function Forward Type Calculation Syntax ****** -*ok* = *afun* . ``for_type`` ( *parameter_x* , *type_x* , *type_y* ) +| *ok* = *afun* . ``for_type`` ( *parameter_x* , *type_x* , *type_y* ) Prototype ========= diff --git a/include/cppad/core/atomic/three/hes_sparsity.hpp b/include/cppad/core/atomic/three/hes_sparsity.hpp index 5e11fdf1f..8ccbbf339 100644 --- a/include/cppad/core/atomic/three/hes_sparsity.hpp +++ b/include/cppad/core/atomic/three/hes_sparsity.hpp @@ -12,7 +12,6 @@ Atomic Function Hessian Sparsity Patterns Syntax ****** - | *ok* = *afun* . ``hes_sparsity`` ( | |tab| *parameter_x* , *type_x* , *select_x* , *select_y* , *pattern_out* | ) diff --git a/include/cppad/core/atomic/three/jac_sparsity.hpp b/include/cppad/core/atomic/three/jac_sparsity.hpp index 451197ec2..a3846c2c4 100644 --- a/include/cppad/core/atomic/three/jac_sparsity.hpp +++ b/include/cppad/core/atomic/three/jac_sparsity.hpp @@ -12,7 +12,6 @@ Atomic Function Jacobian Sparsity Patterns Syntax ****** - | *ok* = *afun* . ``jac_sparsity`` ( | |tab| *parameter_x* , *type_x* , *dependency* , *select_x* , *select_y* , *pattern_out* | ) diff --git a/include/cppad/core/atomic/three/rev_depend.hpp b/include/cppad/core/atomic/three/rev_depend.hpp index ab5d3adb8..918877eb0 100644 --- a/include/cppad/core/atomic/three/rev_depend.hpp +++ b/include/cppad/core/atomic/three/rev_depend.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_THREE_REV_DEPEND_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_three_rev_depend} @@ -12,7 +12,6 @@ Atomic Function Reverse Dependency Calculation Syntax ****** - | *ok* = *afun* . ``rev_depend`` ( | |tab| *parameter_x* , *type_x* , *depend_x* , *depend_y* | ) diff --git a/include/cppad/core/atomic/two/afun.hpp b/include/cppad/core/atomic/two/afun.hpp index de0e1176a..ec5cd6298 100644 --- a/include/cppad/core/atomic/two/afun.hpp +++ b/include/cppad/core/atomic/two/afun.hpp @@ -12,7 +12,7 @@ Using AD Version of Atomic Function Syntax ****** -*afun* ( *ax* , *ay* ) +| *afun* ( *ax* , *ay* ) Purpose ******* diff --git a/include/cppad/core/atomic/two/atomic.hpp b/include/cppad/core/atomic/two/atomic.hpp index 7207fbf53..cb8767e4a 100644 --- a/include/cppad/core/atomic/two/atomic.hpp +++ b/include/cppad/core/atomic/two/atomic.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_TWO_ATOMIC_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_two app} @@ -25,7 +25,6 @@ Use :ref:`atomic_three-name` instead. Syntax ****** - | *atomic_user* *afun* ( *ctor_arg_list* ) | *afun* ( *ax* , *ay* ) | *ok* = *afun* . ``forward`` ( *p* , *q* , *vx* , *vy* , *tx* , *ty* ) diff --git a/include/cppad/core/atomic/two/clear.hpp b/include/cppad/core/atomic/two/clear.hpp index c79cda840..d54c0a1f4 100644 --- a/include/cppad/core/atomic/two/clear.hpp +++ b/include/cppad/core/atomic/two/clear.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_TWO_CLEAR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_two_clear app} @@ -12,7 +12,7 @@ Free Static Variables Syntax ****** -``atomic_base`` < *Base* >:: ``clear`` () +| ``atomic_base`` < *Base* >:: ``clear`` () Purpose ******* diff --git a/include/cppad/core/atomic/two/ctor.hpp b/include/cppad/core/atomic/two/ctor.hpp index ba0890d2a..73cd243da 100644 --- a/include/cppad/core/atomic/two/ctor.hpp +++ b/include/cppad/core/atomic/two/ctor.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_TWO_CTOR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_two_ctor app} @@ -12,7 +12,6 @@ Atomic Function Constructor Syntax ****** - | *atomic_user afun* ( *ctor_arg_list* ) | ``atomic_base`` < *Base* >( *name* , *sparsity* ) diff --git a/include/cppad/core/atomic/two/for_sparse_hes.hpp b/include/cppad/core/atomic/two/for_sparse_hes.hpp index 8a3c0b62f..6fd13493e 100644 --- a/include/cppad/core/atomic/two/for_sparse_hes.hpp +++ b/include/cppad/core/atomic/two/for_sparse_hes.hpp @@ -16,7 +16,7 @@ Atomic Forward Hessian Sparsity Patterns Syntax ****** -*ok* = *afun* . ``for_sparse_hes`` ( *vx* , *r* , *s* , *h* , *x* ) +| *ok* = *afun* . ``for_sparse_hes`` ( *vx* , *r* , *s* , *h* , *x* ) Deprecated 2016-06-27 ********************* diff --git a/include/cppad/core/atomic/two/for_sparse_jac.hpp b/include/cppad/core/atomic/two/for_sparse_jac.hpp index 454eaeb0f..ebeb353cd 100644 --- a/include/cppad/core/atomic/two/for_sparse_jac.hpp +++ b/include/cppad/core/atomic/two/for_sparse_jac.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_TWO_FOR_SPARSE_JAC_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_two_for_sparse_jac app} @@ -15,8 +15,7 @@ Atomic Forward Jacobian Sparsity Patterns Syntax ****** - - *ok* = *afun* . ``for_sparse_jac`` ( *q* , *r* , *s* , *x* ) +| *ok* = *afun* . ``for_sparse_jac`` ( *q* , *r* , *s* , *x* ) Deprecated 2016-06-27 ********************* diff --git a/include/cppad/core/atomic/two/option.hpp b/include/cppad/core/atomic/two/option.hpp index 3639bdde6..e0b0cecec 100644 --- a/include/cppad/core/atomic/two/option.hpp +++ b/include/cppad/core/atomic/two/option.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_TWO_OPTION_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_two_option app} @@ -15,7 +15,7 @@ Set Atomic Function Options Syntax ****** -*afun* . ``option`` ( *option_value* ) +| *afun* . ``option`` ( *option_value* ) Scope ***** diff --git a/include/cppad/core/atomic/two/rev_sparse_hes.hpp b/include/cppad/core/atomic/two/rev_sparse_hes.hpp index 9835ee539..3a14cd09f 100644 --- a/include/cppad/core/atomic/two/rev_sparse_hes.hpp +++ b/include/cppad/core/atomic/two/rev_sparse_hes.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_TWO_REV_SPARSE_HES_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_two_rev_sparse_hes app} @@ -16,7 +16,7 @@ Atomic Reverse Hessian Sparsity Patterns Syntax ****** -*ok* = *afun* . ``rev_sparse_hes`` ( *vx* , *s* , *t* , *q* , *r* , *u* , *v* , *x* ) +| *ok* = *afun* . ``rev_sparse_hes`` ( *vx* , *s* , *t* , *q* , *r* , *u* , *v* , *x* ) Deprecated 2016-06-27 ********************* diff --git a/include/cppad/core/atomic/two/rev_sparse_jac.hpp b/include/cppad/core/atomic/two/rev_sparse_jac.hpp index e8102c0fe..b7d92656c 100644 --- a/include/cppad/core/atomic/two/rev_sparse_jac.hpp +++ b/include/cppad/core/atomic/two/rev_sparse_jac.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_ATOMIC_TWO_REV_SPARSE_JAC_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_two_rev_sparse_jac app} @@ -17,8 +17,7 @@ Atomic Reverse Jacobian Sparsity Patterns Syntax ****** - - *ok* = *afun* . ``rev_sparse_jac`` ( *q* , *rt* , *st* , *x* ) +| *ok* = *afun* . ``rev_sparse_jac`` ( *q* , *rt* , *st* , *x* ) Deprecated 2016-06-27 ********************* diff --git a/include/cppad/core/azmul.hpp b/include/cppad/core/azmul.hpp index c751e6aa7..5e840880d 100644 --- a/include/cppad/core/azmul.hpp +++ b/include/cppad/core/azmul.hpp @@ -15,7 +15,7 @@ Absolute Zero Multiplication Syntax ****** -*z* = ``azmul`` ( *x* , *y* ) +| *z* = ``azmul`` ( *x* , *y* ) Purpose ******* diff --git a/include/cppad/core/base2ad.hpp b/include/cppad/core/base2ad.hpp index 82e1a70e3..e63b51101 100644 --- a/include/cppad/core/base2ad.hpp +++ b/include/cppad/core/base2ad.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_BASE2AD_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin base2ad} @@ -12,7 +12,7 @@ Create an AD Function From a Base Function Syntax ****** -*af* = *f* . ``base2ad`` () +| *af* = *f* . ``base2ad`` () See Also ******** diff --git a/include/cppad/core/base_hash.hpp b/include/cppad/core/base_hash.hpp index ae1b8f573..8dec8d333 100644 --- a/include/cppad/core/base_hash.hpp +++ b/include/cppad/core/base_hash.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_BASE_HASH_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin base_hash} @@ -16,7 +16,7 @@ Base Type Requirements for Hash Coding Values Syntax ****** -*code* = ``hash_code`` ( *x* ) +| *code* = ``hash_code`` ( *x* ) Purpose ******* diff --git a/include/cppad/core/bender_quad.hpp b/include/cppad/core/bender_quad.hpp index 7a99dd64d..d126c44ef 100644 --- a/include/cppad/core/bender_quad.hpp +++ b/include/cppad/core/bender_quad.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_BENDER_QUAD_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin BenderQuad app} @@ -18,7 +18,6 @@ Computing Jacobian and Hessian of Bender's Reduced Objective Syntax ****** - | # ``include `` | *BenderQuad* ( ``x`` , ``y`` , ``fun`` , ``g`` , ``gx`` , ``gxx`` ) diff --git a/include/cppad/core/bool_fun.hpp b/include/cppad/core/bool_fun.hpp index f04739d50..75551894c 100644 --- a/include/cppad/core/bool_fun.hpp +++ b/include/cppad/core/bool_fun.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_BOOL_FUN_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,14 +13,12 @@ AD Boolean Functions Syntax ****** - | ``CPPAD_BOOL_UNARY`` ( *Base* , *unary_name* ) | *b* = *unary_name* ( *u* ) | *b* = *unary_name* ( *x* ) | ``CPPAD_BOOL_BINARY`` ( *Base* , *binary_name* ) | *b* = *binary_name* ( *u* , *v* ) - -*b* = *binary_name* ( *x* , *y* ) +| *b* = *binary_name* ( *x* , *y* ) Purpose ******* diff --git a/include/cppad/core/capacity_order.hpp b/include/cppad/core/capacity_order.hpp index f7bbeb824..0fa4004ab 100644 --- a/include/cppad/core/capacity_order.hpp +++ b/include/cppad/core/capacity_order.hpp @@ -18,7 +18,7 @@ Controlling Taylor Coefficients Memory Allocation Syntax ****** -*f* . ``capacity_order`` ( *c* ) +| *f* . ``capacity_order`` ( *c* ) See Also ======== diff --git a/include/cppad/core/check_for_nan.hpp b/include/cppad/core/check_for_nan.hpp index a7993af2a..e83d2f7ef 100644 --- a/include/cppad/core/check_for_nan.hpp +++ b/include/cppad/core/check_for_nan.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_CHECK_FOR_NAN_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin check_for_nan} @@ -14,7 +14,6 @@ Check an ADFun Object For Nan Results Syntax ****** - | *f* . ``check_for_nan`` ( *b* ) | *b* = *f* . ``check_for_nan`` () | ``get_check_for_nan`` ( *vec* , *file* ) diff --git a/include/cppad/core/chkpoint_one/chkpoint_one.hpp b/include/cppad/core/chkpoint_one/chkpoint_one.hpp index c3a2e660c..ddeaf675d 100644 --- a/include/cppad/core/chkpoint_one/chkpoint_one.hpp +++ b/include/cppad/core/chkpoint_one/chkpoint_one.hpp @@ -30,7 +30,6 @@ Use :ref:`chkpoint_two-name` instead. Syntax ****** - | ``checkpoint`` < *Base* > *atom_fun* ( | |tab| *name* , *algo* , *ax* , *ay* , *sparsity* , *optimize* | ) diff --git a/include/cppad/core/chkpoint_two/chk_fun.xrst b/include/cppad/core/chkpoint_two/chk_fun.xrst index 354edb428..9697b31fa 100644 --- a/include/cppad/core/chkpoint_two/chk_fun.xrst +++ b/include/cppad/core/chkpoint_two/chk_fun.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin chkpoint_two_chk_fun} @@ -9,7 +9,7 @@ Using Checkpoint Functions Syntax ****** -*chk_fun* ( *ax* , *ay* ) +| *chk_fun* ( *ax* , *ay* ) Purpose ******* diff --git a/include/cppad/core/chkpoint_two/ctor.hpp b/include/cppad/core/chkpoint_two/ctor.hpp index 00657a37d..fd12ee3e3 100644 --- a/include/cppad/core/chkpoint_two/ctor.hpp +++ b/include/cppad/core/chkpoint_two/ctor.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_CHKPOINT_TWO_CTOR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin chkpoint_two_ctor} @@ -15,7 +15,6 @@ Checkpoint Function Constructor Syntax ****** - | ``chkpoint_two`` < *Base* > *chk_fun* ( *fun* , *name* , | |tab| *internal_bool* , *use_hes_sparsity* , *use_base2ad* , *use_in_parallel* | ) diff --git a/include/cppad/core/chkpoint_two/dynamic.hpp b/include/cppad/core/chkpoint_two/dynamic.hpp index 96a074c94..fcf083001 100644 --- a/include/cppad/core/chkpoint_two/dynamic.hpp +++ b/include/cppad/core/chkpoint_two/dynamic.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_CHKPOINT_TWO_DYNAMIC_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin chkpoint_two_dynamic} @@ -15,7 +15,7 @@ Dynamic Parameters in Checkpoint Functions Syntax ****** -*chk_fun* . ``new_dynamic`` ( *dynamic* ) +| *chk_fun* . ``new_dynamic`` ( *dynamic* ) Prototype ********* diff --git a/include/cppad/core/compare.hpp b/include/cppad/core/compare.hpp index 05d782156..478be9a42 100644 --- a/include/cppad/core/compare.hpp +++ b/include/cppad/core/compare.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_COMPARE_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -14,8 +14,7 @@ AD Binary Comparison Operators Syntax ****** - -*b* = *x* *Op* *y* +| *b* = *x* *Op* *y* Purpose ******* diff --git a/include/cppad/core/compound_assign.hpp b/include/cppad/core/compound_assign.hpp index 76882d107..60d807d5e 100644 --- a/include/cppad/core/compound_assign.hpp +++ b/include/cppad/core/compound_assign.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_COMPOUND_ASSIGN_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -17,7 +17,7 @@ AD Compound Assignment Operators Syntax ****** -*x* *Op* *y* +| *x* *Op* *y* Purpose ******* diff --git a/include/cppad/core/con_dyn_var.hpp b/include/cppad/core/con_dyn_var.hpp index ca51093f3..2c2c58b92 100644 --- a/include/cppad/core/con_dyn_var.hpp +++ b/include/cppad/core/con_dyn_var.hpp @@ -14,7 +14,6 @@ Constant, Dynamic, Parameter, and Variable Syntax ****** - | *b* = ``Constant`` ( *x* ) | *b* = ``Dynamic`` ( *x* ) | *b* = ``Parameter`` ( *x* ) diff --git a/include/cppad/core/cond_exp.hpp b/include/cppad/core/cond_exp.hpp index c44eee5fb..d5b50a9ff 100644 --- a/include/cppad/core/cond_exp.hpp +++ b/include/cppad/core/cond_exp.hpp @@ -17,7 +17,7 @@ AD Conditional Expressions Syntax ****** -*result* = ``CondExp`` *Rel* ( *left* , *right* , *if_true* , *if_false* ) +| *result* = ``CondExp`` *Rel* ( *left* , *right* , *if_true* , *if_false* ) Purpose ******* diff --git a/include/cppad/core/cppad_assert.hpp b/include/cppad/core/cppad_assert.hpp index bb78b588f..683b3bee3 100644 --- a/include/cppad/core/cppad_assert.hpp +++ b/include/cppad/core/cppad_assert.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_CPPAD_ASSERT_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /*! @@ -22,10 +22,8 @@ CppAD Assertions During Execution Syntax ****** - - ``CPPAD_ASSERT_KNOWN`` ( *exp* , *msg* ) - -``CPPAD_ASSERT_UNKNOWN`` ( *exp* ) +| ``CPPAD_ASSERT_KNOWN`` ( *exp* , *msg* ) +| ``CPPAD_ASSERT_UNKNOWN`` ( *exp* ) Purpose ******* diff --git a/include/cppad/core/dependent.hpp b/include/cppad/core/dependent.hpp index 50e8564bc..bbac64cee 100644 --- a/include/cppad/core/dependent.hpp +++ b/include/cppad/core/dependent.hpp @@ -12,7 +12,7 @@ Stop Recording and Store Operation Sequence Syntax ****** -*f* . ``Dependent`` ( *x* , *y* ) +| *f* . ``Dependent`` ( *x* , *y* ) Stop Recording ************** diff --git a/include/cppad/core/discrete/discrete.hpp b/include/cppad/core/discrete/discrete.hpp index ba9597cce..227075d42 100644 --- a/include/cppad/core/discrete/discrete.hpp +++ b/include/cppad/core/discrete/discrete.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_DISCRETE_DISCRETE_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include # include @@ -20,7 +20,6 @@ Create a Discrete AD Function Syntax ****** - | ``CPPAD_DISCRETE_FUNCTION`` ( *Base* , *name* ) | ``name`` ( *ax* , *ay* ) diff --git a/include/cppad/core/discrete/user.xrst b/include/cppad/core/discrete/user.xrst index 5c45fb47a..eff5916e8 100644 --- a/include/cppad/core/discrete/user.xrst +++ b/include/cppad/core/discrete/user.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- /* @@ -14,7 +14,6 @@ Discrete AD Functions Syntax ****** - | ``CPPAD_DISCRETE_FUNCTION`` ( *Base* , *name* ) | *y* = *name* ( *x* ) | *ay* = *name* ( *ax* ) diff --git a/include/cppad/core/epsilon.hpp b/include/cppad/core/epsilon.hpp index 985ad78d1..474154608 100644 --- a/include/cppad/core/epsilon.hpp +++ b/include/cppad/core/epsilon.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_EPSILON_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -19,7 +19,7 @@ You should use the :ref:`numeric_limits-name` ``epsilon`` instead. Syntax ****** -*eps* = ``epsilon`` < *Float* >() +| *eps* = ``epsilon`` < *Float* >() Purpose ******* diff --git a/include/cppad/core/equal_op_seq.hpp b/include/cppad/core/equal_op_seq.hpp index a3e390e5f..8c197f217 100644 --- a/include/cppad/core/equal_op_seq.hpp +++ b/include/cppad/core/equal_op_seq.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_EQUAL_OP_SEQ_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -14,7 +14,7 @@ Check if Two Value are Identically Equal Syntax ****** -*b* = ``EqualOpSeq`` ( *x* , *y* ) +| *b* = ``EqualOpSeq`` ( *x* , *y* ) Purpose ******* diff --git a/include/cppad/core/for_hes_sparsity.hpp b/include/cppad/core/for_hes_sparsity.hpp index 65eb3b95a..95b727def 100644 --- a/include/cppad/core/for_hes_sparsity.hpp +++ b/include/cppad/core/for_hes_sparsity.hpp @@ -16,7 +16,6 @@ Forward Mode Hessian Sparsity Patterns Syntax ****** - | *f* . ``for_hes_sparsity`` ( | |tab| *select_domain* , *select_range* , *internal_bool* , *pattern_out* | ) diff --git a/include/cppad/core/for_jac_sparsity.hpp b/include/cppad/core/for_jac_sparsity.hpp index 3d2f4800e..8c95fc9e1 100644 --- a/include/cppad/core/for_jac_sparsity.hpp +++ b/include/cppad/core/for_jac_sparsity.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_FOR_JAC_SPARSITY_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin for_jac_sparsity} @@ -12,7 +12,6 @@ Forward Mode Jacobian Sparsity Patterns Syntax ****** - | *f* . ``for_jac_sparsity`` ( | |tab| *pattern_in* , *transpose* , *dependency* , *internal_bool* , *pattern_out* | ) diff --git a/include/cppad/core/for_one.hpp b/include/cppad/core/for_one.hpp index f7f9ce2fe..f6cb72495 100644 --- a/include/cppad/core/for_one.hpp +++ b/include/cppad/core/for_one.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_FOR_ONE_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -16,7 +16,7 @@ First Order Partial Derivative: Driver Routine Syntax ****** -*dy* = *f* . ``ForOne`` ( *x* , *j* ) +| *dy* = *f* . ``ForOne`` ( *x* , *j* ) Purpose ******* diff --git a/include/cppad/core/for_sparse_hes.hpp b/include/cppad/core/for_sparse_hes.hpp index 4006bfab4..68739e208 100644 --- a/include/cppad/core/for_sparse_hes.hpp +++ b/include/cppad/core/for_sparse_hes.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_FOR_SPARSE_HES_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -17,8 +17,7 @@ Hessian Sparsity Pattern: Forward Mode Syntax ****** - - *h* = *f* . ``ForSparseHes`` ( *r* , *s* ) +| *h* = *f* . ``ForSparseHes`` ( *r* , *s* ) Purpose ******* diff --git a/include/cppad/core/for_sparse_jac.hpp b/include/cppad/core/for_sparse_jac.hpp index 420508125..226312d75 100644 --- a/include/cppad/core/for_sparse_jac.hpp +++ b/include/cppad/core/for_sparse_jac.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_FOR_SPARSE_JAC_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,10 +13,8 @@ Jacobian Sparsity Pattern: Forward Mode Syntax ****** - - *s* = *f* . ``ForSparseJac`` ( *q* , *r* ) - -*s* = *f* . ``ForSparseJac`` ( *q* , *r* , *transpose* , *dependency* ) +| *s* = *f* . ``ForSparseJac`` ( *q* , *r* ) +| *s* = *f* . ``ForSparseJac`` ( *q* , *r* , *transpose* , *dependency* ) Purpose ******* diff --git a/include/cppad/core/for_two.hpp b/include/cppad/core/for_two.hpp index 18e6ed146..47dfb4aaa 100644 --- a/include/cppad/core/for_two.hpp +++ b/include/cppad/core/for_two.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_FOR_TWO_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -16,7 +16,7 @@ Forward Mode Second Partial Derivative Driver Syntax ****** -*ddy* = *f* . ``ForTwo`` ( *x* , *j* , *k* ) +| *ddy* = *f* . ``ForTwo`` ( *x* , *j* , *k* ) Purpose ******* diff --git a/include/cppad/core/forward/compare_change.xrst b/include/cppad/core/forward/compare_change.xrst index 3fdb96313..d194e667d 100644 --- a/include/cppad/core/forward/compare_change.xrst +++ b/include/cppad/core/forward/compare_change.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin compare_change} @@ -9,12 +9,12 @@ Comparison Changes Between Taping and Zero Order Forward Syntax ****** - | *f* . ``compare_change_count`` ( *count* ) | *number* = *f* . ``compare_change_number`` () | *op_index* = *f* . ``compare_change_op_index`` () -**See Also** +See Also +******** :ref:`FunCheck-name` Purpose diff --git a/include/cppad/core/forward/forward.hpp b/include/cppad/core/forward/forward.hpp index 6a958f229..685dfbe3d 100644 --- a/include/cppad/core/forward/forward.hpp +++ b/include/cppad/core/forward/forward.hpp @@ -26,8 +26,7 @@ Multiple orders, one direction, forward mode Taylor coefficients Syntax ****** - - *yq* = *f* . ``Forward`` ( *q* , *xq* , *s* ) +| *yq* = *f* . ``Forward`` ( *q* , *xq* , *s* ) Prototype ********* diff --git a/include/cppad/core/forward/forward_dir.xrst b/include/cppad/core/forward/forward_dir.xrst index e405b9c96..a47ae5464 100644 --- a/include/cppad/core/forward/forward_dir.xrst +++ b/include/cppad/core/forward/forward_dir.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin forward_dir} {xrst_spell @@ -14,8 +14,7 @@ Multiple Directions Forward Mode Syntax ****** - - *yq* = *f* . ``Forward`` ( *q* , *r* , *xq* ) +| *yq* = *f* . ``Forward`` ( *q* , *r* , *xq* ) Purpose ******* diff --git a/include/cppad/core/forward/forward_one.xrst b/include/cppad/core/forward/forward_one.xrst index 687fec56f..2943d1169 100644 --- a/include/cppad/core/forward/forward_one.xrst +++ b/include/cppad/core/forward/forward_one.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin forward_one} @@ -9,7 +9,7 @@ First Order Forward Mode: Derivative Values Syntax ****** -*y1* = *f* . ``Forward`` (1, *x1* ) +| *y1* = *f* . ``Forward`` (1, *x1* ) Purpose ******* diff --git a/include/cppad/core/forward/forward_order.xrst b/include/cppad/core/forward/forward_order.xrst index 30bef00cb..dafbbd888 100644 --- a/include/cppad/core/forward/forward_order.xrst +++ b/include/cppad/core/forward/forward_order.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin forward_order} {xrst_spell @@ -17,7 +17,6 @@ Multiple Order Forward Mode Syntax ****** - | *yq* = *f* . ``Forward`` ( *q* , *xq* ) | *yq* = *f* . ``Forward`` ( *q* , *xq* , *s* ) diff --git a/include/cppad/core/forward/forward_two.xrst b/include/cppad/core/forward/forward_two.xrst index 4ed699be9..9e748ddb3 100644 --- a/include/cppad/core/forward/forward_two.xrst +++ b/include/cppad/core/forward/forward_two.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin forward_two} @@ -9,7 +9,7 @@ Second Order Forward Mode: Derivative Values Syntax ****** -*y2* = *f* . ``Forward`` (2, *x2* ) +| *y2* = *f* . ``Forward`` (2, *x2* ) Purpose ******* diff --git a/include/cppad/core/forward/forward_zero.xrst b/include/cppad/core/forward/forward_zero.xrst index 679cc95cb..925b68395 100644 --- a/include/cppad/core/forward/forward_zero.xrst +++ b/include/cppad/core/forward/forward_zero.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin forward_zero} {xrst_spell @@ -13,10 +13,8 @@ Zero Order Forward Mode: Function Values Syntax ****** - - *y0* = *f* . ``Forward`` (0, *x0* ) - -*y0* = *f* . ``Forward`` (0, *x0* , *s* ) +| *y0* = *f* . ``Forward`` (0, *x0* ) +| *y0* = *f* . ``Forward`` (0, *x0* , *s* ) Purpose ******* diff --git a/include/cppad/core/forward/size_order.xrst b/include/cppad/core/forward/size_order.xrst index 2465ae87b..4a08830d0 100644 --- a/include/cppad/core/forward/size_order.xrst +++ b/include/cppad/core/forward/size_order.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin size_order} @@ -9,7 +9,7 @@ Number Taylor Coefficient Orders Currently Stored Syntax ****** -*s* = *f* . ``size_order`` () +| *s* = *f* . ``size_order`` () See Also ======== diff --git a/include/cppad/core/fun_check.hpp b/include/cppad/core/fun_check.hpp index f02e8fe59..02a73c188 100644 --- a/include/cppad/core/fun_check.hpp +++ b/include/cppad/core/fun_check.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_FUN_CHECK_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,10 +13,11 @@ Check an ADFun Sequence of Operations Syntax ****** -*ok* = ``FunCheck`` ( *f* , *g* , *x* , *r* , *a* ) +| *ok* = ``FunCheck`` ( *f* , *g* , *x* , *r* , *a* ) -**See Also** -:ref:`CompareChange-name` +See Also +******** +:ref:`FunCheck-name` Purpose ******* diff --git a/include/cppad/core/fun_construct.hpp b/include/cppad/core/fun_construct.hpp index 254e38cf9..8b20236c3 100644 --- a/include/cppad/core/fun_construct.hpp +++ b/include/cppad/core/fun_construct.hpp @@ -15,7 +15,6 @@ Construct an ADFun Object and Stop Recording Syntax ****** - | ``ADFun`` < *Base* > *f* ( *ax* , *ay* ); | ``ADFun`` < *Base* > *f* | *f* . ``swap`` ( *g* ) diff --git a/include/cppad/core/fun_property.xrst b/include/cppad/core/fun_property.xrst index 6eda3ddf4..dfe692445 100644 --- a/include/cppad/core/fun_property.xrst +++ b/include/cppad/core/fun_property.xrst @@ -10,7 +10,6 @@ ADFun Function Properties Syntax ****** - | *n* = *f* . ``Domain`` () | *m* = *f* . ``Range`` () | *p* = *f* . ``Parameter`` ( *i* ) diff --git a/include/cppad/core/function_name.xrst b/include/cppad/core/function_name.xrst index 7e11101bb..0a32771a1 100644 --- a/include/cppad/core/function_name.xrst +++ b/include/cppad/core/function_name.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin function_name} @@ -9,7 +9,6 @@ Setting and Getting a Function's Name Syntax ****** - | *f* . ``function_name_set`` ( *function_name* ) | *function_name* = *f* . ``function_name_get`` () diff --git a/include/cppad/core/graph/cpp_graph.hpp b/include/cppad/core/graph/cpp_graph.hpp index 9fd14b90f..ec7229d90 100644 --- a/include/cppad/core/graph/cpp_graph.hpp +++ b/include/cppad/core/graph/cpp_graph.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_GRAPH_CPP_GRAPH_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include # include @@ -47,7 +47,6 @@ C++ AD Graph Constructor Syntax ****** - | ``cpp_graph`` *graph_obj* | *graph_obj* . ``initialize`` () diff --git a/include/cppad/core/graph/from_graph.hpp b/include/cppad/core/graph/from_graph.hpp index 0d983a208..d6647932f 100644 --- a/include/cppad/core/graph/from_graph.hpp +++ b/include/cppad/core/graph/from_graph.hpp @@ -18,7 +18,6 @@ ADFun Object Corresponding to a CppAD Graph Syntax ****** - | |tab| ``cpp_graph`` *graph_obj* | |tab| ``ADFun`` < *Base* > *fun* | |tab| *fun* . ``from_graph`` ( *graph_obj* ) diff --git a/include/cppad/core/graph/from_json.hpp b/include/cppad/core/graph/from_json.hpp index 0fa9539b7..15c7bae53 100644 --- a/include/cppad/core/graph/from_json.hpp +++ b/include/cppad/core/graph/from_json.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_GRAPH_FROM_JSON_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -17,7 +17,6 @@ ADFun Object Corresponding to a Json AD Graph Syntax ****** - | |tab| ``ADFun`` < *Base* > *fun* | |tab| *fun* . ``from_json`` ( *json* ) diff --git a/include/cppad/core/graph/to_graph.hpp b/include/cppad/core/graph/to_graph.hpp index 54f5e2d11..b90865107 100644 --- a/include/cppad/core/graph/to_graph.hpp +++ b/include/cppad/core/graph/to_graph.hpp @@ -19,7 +19,6 @@ Create a C++ AD Graph Corresponding to an ADFun Object Syntax ****** - | |tab| ``cpp_graph`` *graph_obj* | |tab| ``ADFun`` < *Base* > *fun* | |tab| *fun* . ``to_graph`` ( *graph_obj* ) diff --git a/include/cppad/core/graph/to_json.hpp b/include/cppad/core/graph/to_json.hpp index 051781f3a..cff2ce9d1 100644 --- a/include/cppad/core/graph/to_json.hpp +++ b/include/cppad/core/graph/to_json.hpp @@ -3,7 +3,7 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -21,8 +21,7 @@ Json AD Graph Corresponding to an ADFun Object Syntax ****** - - *json* = *fun* . ``to_json`` () +| *json* = *fun* . ``to_json`` () Prototype ********* diff --git a/include/cppad/core/hessian.hpp b/include/cppad/core/hessian.hpp index 89b3f9808..bbf8005c8 100644 --- a/include/cppad/core/hessian.hpp +++ b/include/cppad/core/hessian.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_HESSIAN_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,7 +13,6 @@ Hessian: Easy Driver Syntax ****** - | *hes* = *f* . ``Hessian`` ( *x* , *w* ) | *hes* = *f* . ``Hessian`` ( *x* , *l* ) diff --git a/include/cppad/core/independent/independent.hpp b/include/cppad/core/independent/independent.hpp index 1bb7465d4..4b92aa945 100644 --- a/include/cppad/core/independent/independent.hpp +++ b/include/cppad/core/independent/independent.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_INDEPENDENT_INDEPENDENT_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -20,7 +20,7 @@ This implements :ref:`Independent-name` with all the possible arguments present. Syntax ****** -``Independent`` ( *x* , *abort_op_index* , *record_compare* , *dynamic* ) +| ``Independent`` ( *x* , *abort_op_index* , *record_compare* , *dynamic* ) Prototype ********* diff --git a/include/cppad/core/independent/user.xrst b/include/cppad/core/independent/user.xrst index 0efea6e85..601c54b93 100644 --- a/include/cppad/core/independent/user.xrst +++ b/include/cppad/core/independent/user.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin Independent} @@ -9,7 +9,6 @@ Declare Independent Variables and Start Recording Syntax ****** - | ``Independent`` ( *x* ) | ``Independent`` ( *x* , *dynamic* ) | ``Independent`` ( *x* , *abort_op_index* ) diff --git a/include/cppad/core/integer.hpp b/include/cppad/core/integer.hpp index 963a21621..15f4d9a71 100644 --- a/include/cppad/core/integer.hpp +++ b/include/cppad/core/integer.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_INTEGER_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -14,7 +14,7 @@ Convert From AD to Integer Syntax ****** -*i* = ``Integer`` ( *x* ) +| *i* = ``Integer`` ( *x* ) Purpose ******* diff --git a/include/cppad/core/jacobian.hpp b/include/cppad/core/jacobian.hpp index cd7bae02f..4af512a4e 100644 --- a/include/cppad/core/jacobian.hpp +++ b/include/cppad/core/jacobian.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_JACOBIAN_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,7 +13,7 @@ Jacobian: Driver Routine Syntax ****** -*jac* = *f* . ``Jacobian`` ( *x* ) +| *jac* = *f* . ``Jacobian`` ( *x* ) Purpose ******* diff --git a/include/cppad/core/lu_ratio.hpp b/include/cppad/core/lu_ratio.hpp index cfd98686e..9d439aef2 100644 --- a/include/cppad/core/lu_ratio.hpp +++ b/include/cppad/core/lu_ratio.hpp @@ -18,9 +18,8 @@ LU Factorization of A Square Matrix and Stability Calculation Syntax ****** -``# include `` - -*sign* = ``LuRatio`` ( *ip* , *jp* , *LU* , *ratio* ) +| ``# include `` +| *sign* = ``LuRatio`` ( *ip* , *jp* , *LU* , *ratio* ) Description *********** diff --git a/include/cppad/core/near_equal_ext.hpp b/include/cppad/core/near_equal_ext.hpp index 47d5328b4..7db8f9ba1 100644 --- a/include/cppad/core/near_equal_ext.hpp +++ b/include/cppad/core/near_equal_ext.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_NEAR_EQUAL_EXT_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin near_equal_ext} @@ -12,7 +12,7 @@ Compare AD and Base Objects for Nearly Equal Syntax ****** -*b* = ``NearEqual`` ( *x* , *y* , *r* , *a* ) +| *b* = ``NearEqual`` ( *x* , *y* , *r* , *a* ) Purpose ******* diff --git a/include/cppad/core/new_dynamic.hpp b/include/cppad/core/new_dynamic.hpp index 990bc0636..8fe2aa271 100644 --- a/include/cppad/core/new_dynamic.hpp +++ b/include/cppad/core/new_dynamic.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_NEW_DYNAMIC_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,7 +13,7 @@ Change the Dynamic Parameters Syntax ****** -*f* . ``new_dynamic`` ( *dynamic* ) +| *f* . ``new_dynamic`` ( *dynamic* ) Purpose ******* diff --git a/include/cppad/core/num_skip.hpp b/include/cppad/core/num_skip.hpp index 89276b251..157331f67 100644 --- a/include/cppad/core/num_skip.hpp +++ b/include/cppad/core/num_skip.hpp @@ -13,7 +13,7 @@ Number of Variables that Can be Skipped Syntax ****** -*n* = *f* . ``number_skip`` () +| *n* = *f* . ``number_skip`` () See Also ======== diff --git a/include/cppad/core/numeric_limits.hpp b/include/cppad/core/numeric_limits.hpp index 72474142e..099ce0975 100644 --- a/include/cppad/core/numeric_limits.hpp +++ b/include/cppad/core/numeric_limits.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_NUMERIC_LIMITS_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -18,7 +18,6 @@ Numeric Limits For an AD and Base Types Syntax ****** - | *eps* = ``numeric_limits`` < *Float* >:: ``epsilon`` () | *min* = ``numeric_limits`` < *Float* >:: ``min`` () | *max* = ``numeric_limits`` < *Float* >:: ``max`` () diff --git a/include/cppad/core/omp_max_thread.hpp b/include/cppad/core/omp_max_thread.hpp index 19b20836f..cd4391fba 100644 --- a/include/cppad/core/omp_max_thread.hpp +++ b/include/cppad/core/omp_max_thread.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_OMP_MAX_THREAD_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin omp_max_thread app} @@ -20,8 +20,7 @@ to set the number of threads. Syntax ****** - - ``AD`` < *Base* >:: ``omp_max_thread`` ( *number* ) +| ``AD`` < *Base* >:: ``omp_max_thread`` ( *number* ) Purpose ******* diff --git a/include/cppad/core/opt_val_hes.hpp b/include/cppad/core/opt_val_hes.hpp index e5fb1f1b3..005a5f356 100644 --- a/include/cppad/core/opt_val_hes.hpp +++ b/include/cppad/core/opt_val_hes.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_OPT_VAL_HES_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin opt_val_hes app} @@ -19,7 +19,7 @@ Jacobian and Hessian of Optimal Values Syntax ****** -*signdet* = ``opt_val_hes`` ( *x* , *y* , *fun* , *jac* , *hes* ) +| *signdet* = ``opt_val_hes`` ( *x* , *y* , *fun* , *jac* , *hes* ) See Also ******** diff --git a/include/cppad/core/optimize.hpp b/include/cppad/core/optimize.hpp index ab96b0787..f3a999a89 100644 --- a/include/cppad/core/optimize.hpp +++ b/include/cppad/core/optimize.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_OPTIMIZE_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # define CPPAD_CORE_OPTIMIZE_PRINT_RESULT 0 @@ -19,7 +19,6 @@ Optimize an ADFun Object Tape Syntax ****** - | *f* . ``optimize`` () | *f* . ``optimize`` ( *options* ) | *flag* = *f* . ``exceed_collision_limit`` () diff --git a/include/cppad/core/parallel_ad.hpp b/include/cppad/core/parallel_ad.hpp index a7c35c23d..8f7bdc96b 100644 --- a/include/cppad/core/parallel_ad.hpp +++ b/include/cppad/core/parallel_ad.hpp @@ -16,7 +16,7 @@ Enable AD Calculations During Parallel Mode Syntax ****** -``parallel_ad`` < *Base* >() +| ``parallel_ad`` < *Base* >() Purpose ******* diff --git a/include/cppad/core/pow.hpp b/include/cppad/core/pow.hpp index 8ab1225ea..90625a881 100644 --- a/include/cppad/core/pow.hpp +++ b/include/cppad/core/pow.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_POW_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,7 +13,7 @@ The AD Power Function Syntax ****** -*z* = ``pow`` ( *x* , *y* ) +| *z* = ``pow`` ( *x* , *y* ) See Also ******** diff --git a/include/cppad/core/print_for.hpp b/include/cppad/core/print_for.hpp index 48fc93a30..c94b305a1 100644 --- a/include/cppad/core/print_for.hpp +++ b/include/cppad/core/print_for.hpp @@ -16,7 +16,6 @@ Printing AD Values During Forward Mode Syntax ****** - | *f* . ``Forward`` (0, *x* ) | *f* . ``Forward`` (0, *x* , *s* ) | ``PrintFor`` ( *before* , *value* ) diff --git a/include/cppad/core/rev_hes_sparsity.hpp b/include/cppad/core/rev_hes_sparsity.hpp index 42872d612..db1adfc9a 100644 --- a/include/cppad/core/rev_hes_sparsity.hpp +++ b/include/cppad/core/rev_hes_sparsity.hpp @@ -12,7 +12,6 @@ Reverse Mode Hessian Sparsity Patterns Syntax ****** - | *f* . ``rev_hes_sparsity`` ( | |tab| *select_range* , *transpose* , *internal_bool* , *pattern_out* | ) diff --git a/include/cppad/core/rev_jac_sparsity.hpp b/include/cppad/core/rev_jac_sparsity.hpp index 999d7b481..3824384cd 100644 --- a/include/cppad/core/rev_jac_sparsity.hpp +++ b/include/cppad/core/rev_jac_sparsity.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_REV_JAC_SPARSITY_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin rev_jac_sparsity} @@ -12,7 +12,6 @@ Reverse Mode Jacobian Sparsity Patterns Syntax ****** - | *f* . ``rev_jac_sparsity`` ( | |tab| *pattern_in* , *transpose* , *dependency* , *internal_bool* , *pattern_out* | ) diff --git a/include/cppad/core/rev_one.hpp b/include/cppad/core/rev_one.hpp index e0bf4c7b6..5aa4f83a0 100644 --- a/include/cppad/core/rev_one.hpp +++ b/include/cppad/core/rev_one.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_REV_ONE_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -16,7 +16,7 @@ First Order Derivative: Driver Routine Syntax ****** -*dw* = *f* . ``RevOne`` ( *x* , *i* ) +| *dw* = *f* . ``RevOne`` ( *x* , *i* ) Purpose ******* diff --git a/include/cppad/core/rev_sparse_hes.hpp b/include/cppad/core/rev_sparse_hes.hpp index ff2b05a8b..ade7222c6 100644 --- a/include/cppad/core/rev_sparse_hes.hpp +++ b/include/cppad/core/rev_sparse_hes.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_REV_SPARSE_HES_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,10 +13,8 @@ Hessian Sparsity Pattern: Reverse Mode Syntax ****** - - *h* = *f* . ``RevSparseHes`` ( *q* , *s* ) - -*h* = *f* . ``RevSparseHes`` ( *q* , *s* , *transpose* ) +| *h* = *f* . ``RevSparseHes`` ( *q* , *s* ) +| *h* = *f* . ``RevSparseHes`` ( *q* , *s* , *transpose* ) Purpose ******* diff --git a/include/cppad/core/rev_sparse_jac.hpp b/include/cppad/core/rev_sparse_jac.hpp index 2c4ebaba5..6380c6943 100644 --- a/include/cppad/core/rev_sparse_jac.hpp +++ b/include/cppad/core/rev_sparse_jac.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_REV_SPARSE_JAC_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,10 +13,8 @@ Jacobian Sparsity Pattern: Reverse Mode Syntax ****** - - *s* = *f* . ``RevSparseJac`` ( *q* , *r* ) - -*s* = *f* . ``RevSparseJac`` ( *q* , *r* , *transpose* , *dependency* ) +| *s* = *f* . ``RevSparseJac`` ( *q* , *r* ) +| *s* = *f* . ``RevSparseJac`` ( *q* , *r* , *transpose* , *dependency* ) Purpose ******* diff --git a/include/cppad/core/rev_two.hpp b/include/cppad/core/rev_two.hpp index 007ce0523..6c2fc1c50 100644 --- a/include/cppad/core/rev_two.hpp +++ b/include/cppad/core/rev_two.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_REV_TWO_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -16,7 +16,7 @@ Reverse Mode Second Partial Derivative Driver Syntax ****** -*ddw* = *f* . ``RevTwo`` ( *x* , *i* , *j* ) +| *ddw* = *f* . ``RevTwo`` ( *x* , *i* , *j* ) Purpose ******* diff --git a/include/cppad/core/sign.hpp b/include/cppad/core/sign.hpp index 8ead4505f..0a55b81aa 100644 --- a/include/cppad/core/sign.hpp +++ b/include/cppad/core/sign.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_SIGN_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -16,7 +16,7 @@ The Sign: sign Syntax ****** -*y* = ``sign`` ( *x* ) +| *y* = ``sign`` ( *x* ) Description *********** diff --git a/include/cppad/core/sparse_hes.hpp b/include/cppad/core/sparse_hes.hpp index eb613b73a..3dbc3e379 100644 --- a/include/cppad/core/sparse_hes.hpp +++ b/include/cppad/core/sparse_hes.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_SPARSE_HES_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -16,7 +16,6 @@ Computing Sparse Hessians Syntax ****** - | *n_sweep* = *f* . ``sparse_hes`` ( | |tab| *x* , *w* , *subset* , *pattern* , *coloring* , *work* | ) diff --git a/include/cppad/core/sparse_hessian.hpp b/include/cppad/core/sparse_hessian.hpp index 95b047070..0e4a1af71 100644 --- a/include/cppad/core/sparse_hessian.hpp +++ b/include/cppad/core/sparse_hessian.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_SPARSE_HESSIAN_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -16,7 +16,6 @@ Sparse Hessian Syntax ****** - | *hes* = *f* . ``SparseHessian`` ( *x* , *w* ) | *hes* = *f* . ``SparseHessian`` ( *x* , *w* , *p* ) | *n_sweep* = *f* . ``SparseHessian`` ( *x* , *w* , *p* , *row* , *col* , *hes* , *work* ) diff --git a/include/cppad/core/sparse_jac.hpp b/include/cppad/core/sparse_jac.hpp index b3210b1ef..f1ab8ca82 100644 --- a/include/cppad/core/sparse_jac.hpp +++ b/include/cppad/core/sparse_jac.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_SPARSE_JAC_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -16,7 +16,6 @@ Computing Sparse Jacobians Syntax ****** - | *n_color* = *f* . ``sparse_jac_for`` ( | |tab| *group_max* , *x* , *subset* , *pattern* , *coloring* , *work* | ) diff --git a/include/cppad/core/sparse_jacobian.hpp b/include/cppad/core/sparse_jacobian.hpp index d2347b5a9..bec0d4844 100644 --- a/include/cppad/core/sparse_jacobian.hpp +++ b/include/cppad/core/sparse_jacobian.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_SPARSE_JACOBIAN_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- // maximum number of sparse directions to compute at the same time @@ -21,7 +21,6 @@ Sparse Jacobian Syntax ****** - | *jac* = *f* . ``SparseJacobian`` ( *x* ) | *jac* = *f* . ``SparseJacobian`` ( *x* , *p* ) | *n_sweep* = *f* . ``SparseJacobianForward`` ( *x* , *p* , *row* , *col* , *jac* , *work* ) diff --git a/include/cppad/core/standard_math.hpp b/include/cppad/core/standard_math.hpp index 8bbfb01af..d1118d8c7 100644 --- a/include/cppad/core/standard_math.hpp +++ b/include/cppad/core/standard_math.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_STANDARD_MATH_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -16,7 +16,7 @@ The Unary Standard Math Functions Syntax ****** -*y* = *fun* ( *x* ) +| *y* = *fun* ( *x* ) Purpose ******* diff --git a/include/cppad/core/std_math_11.hpp b/include/cppad/core/std_math_11.hpp index effa49395..258e2581e 100644 --- a/include/cppad/core/std_math_11.hpp +++ b/include/cppad/core/std_math_11.hpp @@ -13,7 +13,7 @@ Inverse Cosine Function: acos Syntax ****** -*y* = ``acos`` ( *x* ) +| *y* = ``acos`` ( *x* ) x, y **** diff --git a/include/cppad/core/subgraph_jac_rev.hpp b/include/cppad/core/subgraph_jac_rev.hpp index e15064abd..712d51cae 100644 --- a/include/cppad/core/subgraph_jac_rev.hpp +++ b/include/cppad/core/subgraph_jac_rev.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_SUBGRAPH_JAC_REV_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin subgraph_jac_rev} @@ -17,7 +17,6 @@ Compute Sparse Jacobians Using Subgraphs Syntax ****** - | *f* . ``subgraph_jac_rev`` ( *x* , *subset* ) | *f* . ``subgraph_jac_rev`` ( | |tab| *select_domain* , *select_range* , *x* , *matrix_out* diff --git a/include/cppad/core/subgraph_reverse.hpp b/include/cppad/core/subgraph_reverse.hpp index 5a7bd53f1..25bd14bf3 100644 --- a/include/cppad/core/subgraph_reverse.hpp +++ b/include/cppad/core/subgraph_reverse.hpp @@ -16,7 +16,6 @@ Reverse Mode Using Subgraphs Syntax ****** - | *f* . ``subgraph_reverse`` ( *select_domain* ) | *f* . ``subgraph_reverse`` ( *q* , *ell* , *col* , *dw* ) | *f* . ``clear_subgraph`` () diff --git a/include/cppad/core/subgraph_sparsity.hpp b/include/cppad/core/subgraph_sparsity.hpp index 370846ff0..ce0a12309 100644 --- a/include/cppad/core/subgraph_sparsity.hpp +++ b/include/cppad/core/subgraph_sparsity.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_SUBGRAPH_SPARSITY_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin subgraph_sparsity} @@ -15,7 +15,6 @@ Subgraph Dependency Sparsity Patterns Syntax ****** - | *f* . ``subgraph_sparsity`` ( | |tab| *select_domain* , *select_range* , *transpose* , *pattern_out* | ) diff --git a/include/cppad/core/testvector.hpp b/include/cppad/core/testvector.hpp index a3f69da23..fd392e783 100644 --- a/include/cppad/core/testvector.hpp +++ b/include/cppad/core/testvector.hpp @@ -16,8 +16,7 @@ Using The CppAD Test Vector Template Class Syntax ****** - - ``CPPAD_TESTVECTOR`` ( *Scalar* ) +| ``CPPAD_TESTVECTOR`` ( *Scalar* ) Choice ****** diff --git a/include/cppad/core/to_csrc.hpp b/include/cppad/core/to_csrc.hpp index 6db4ad196..01ffc0aec 100644 --- a/include/cppad/core/to_csrc.hpp +++ b/include/cppad/core/to_csrc.hpp @@ -28,8 +28,7 @@ C Source Code Corresponding to an ADFun Object Syntax ****** - - *fun* . ``to_csrc`` ( *os* , *c_type* ) +| *fun* . ``to_csrc`` ( *os* , *c_type* ) Prototype ********* diff --git a/include/cppad/core/unary_minus.hpp b/include/cppad/core/unary_minus.hpp index 6c997af14..2491bc120 100644 --- a/include/cppad/core/unary_minus.hpp +++ b/include/cppad/core/unary_minus.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_UNARY_MINUS_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,8 +13,7 @@ AD Unary Minus Operator Syntax ****** - -*y* = ``-`` *x* +| *y* = ``-`` *x* Purpose ******* diff --git a/include/cppad/core/unary_plus.hpp b/include/cppad/core/unary_plus.hpp index 8d20758e8..ef7924cd9 100644 --- a/include/cppad/core/unary_plus.hpp +++ b/include/cppad/core/unary_plus.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_UNARY_PLUS_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,8 +13,7 @@ AD Unary Plus Operator Syntax ****** - -*y* = + *x* +| *y* = + *x* Purpose ******* diff --git a/include/cppad/core/value.hpp b/include/cppad/core/value.hpp index f62d259e0..2c91e1b31 100644 --- a/include/cppad/core/value.hpp +++ b/include/cppad/core/value.hpp @@ -13,7 +13,7 @@ Convert From an AD Type to its Base Type Syntax ****** -*b* = ``Value`` ( *x* ) +| *b* = ``Value`` ( *x* ) See Also ******** diff --git a/include/cppad/core/var2par.hpp b/include/cppad/core/var2par.hpp index ab917c5ef..86a9795b0 100644 --- a/include/cppad/core/var2par.hpp +++ b/include/cppad/core/var2par.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_VAR2PAR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -15,7 +15,7 @@ Convert an AD Variable or Dynamic Parameter to a Constant Syntax ****** -*y* = ``Var2Par`` ( *x* ) +| *y* = ``Var2Par`` ( *x* ) See Also ******** diff --git a/include/cppad/core/vec_ad/user.xrst b/include/cppad/core/vec_ad/user.xrst index 248812dd0..cbed20145 100644 --- a/include/cppad/core/vec_ad/user.xrst +++ b/include/cppad/core/vec_ad/user.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- /* {xrst_begin VecAD} @@ -19,12 +19,9 @@ AD Vectors that Record Index Operations Syntax ****** -``VecAD`` < *Base* > *vec* ( *n* ) - -*vec* . ``size`` () - -*base* = *vec* [ *i* ] - +| ``VecAD`` < *Base* > *vec* ( *n* ) +| *vec* . ``size`` () +| *base* = *vec* [ *i* ] | *abase* = *vec* [ *ind* ] | *vec* [ *ind* ] = *right* | *left* = *vec* [ *ind* ] diff --git a/include/cppad/core/vec_ad/vec_ad.hpp b/include/cppad/core/vec_ad/vec_ad.hpp index 3ae488b94..7cd027516 100644 --- a/include/cppad/core/vec_ad/vec_ad.hpp +++ b/include/cppad/core/vec_ad/vec_ad.hpp @@ -2,7 +2,7 @@ # define CPPAD_CORE_VEC_AD_VEC_AD_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include namespace CppAD { // BEGIN_CPPAD_NAMESPACE @@ -14,7 +14,6 @@ VecAD: Prints Error Message If A Compound Assignment Is Used Syntax ****** - | ``CPPAD_VEC_AD_COMP_ASSIGN`` ( *cop* ) | ``ref cop right`` diff --git a/include/cppad/example/atomic_four/lin_ode/base_solver.hpp b/include/cppad/example/atomic_four/lin_ode/base_solver.hpp index 51a531c62..f30c77618 100644 --- a/include/cppad/example/atomic_four/lin_ode/base_solver.hpp +++ b/include/cppad/example/atomic_four/lin_ode/base_solver.hpp @@ -12,7 +12,6 @@ Atomic Linear ODE: Example Implementation Syntax ****** - | *lin_ode* . ``base_solver`` ( | |tab| *r* , *step* , *pattern* , *transpose* , *x* , *y* | ) diff --git a/include/cppad/example/atomic_four/lin_ode/get.hpp b/include/cppad/example/atomic_four/lin_ode/get.hpp index 2357b06f9..0a028bef7 100644 --- a/include/cppad/example/atomic_four/lin_ode/get.hpp +++ b/include/cppad/example/atomic_four/lin_ode/get.hpp @@ -2,7 +2,7 @@ # define CPPAD_EXAMPLE_ATOMIC_FOUR_LIN_ODE_GET_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_four_lin_ode_get.hpp} @@ -15,7 +15,7 @@ atomic_lin_ode Get Routine: Example Implementation Syntax ****** -*lin_ode* . ``get`` ( *call_id* , *r* , *step* , *pattern* , *transpose* ) +| *lin_ode* . ``get`` ( *call_id* , *r* , *step* , *pattern* , *transpose* ) Prototype ********* diff --git a/include/cppad/example/atomic_four/lin_ode/lin_ode.xrst b/include/cppad/example/atomic_four/lin_ode/lin_ode.xrst index d1cc63d9d..cbe47df7f 100644 --- a/include/cppad/example/atomic_four/lin_ode/lin_ode.xrst +++ b/include/cppad/example/atomic_four/lin_ode/lin_ode.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin atomic_four_lin_ode} {xrst_spell @@ -15,7 +15,6 @@ Atomic First Order Linear ODE Method: Example Implementation Syntax ****** - | ``atomic_lin_ode`` *ode* ( *name* ) | *call_id* = *lin_ode* . ``set`` ( *r* , *step* , *pattern* , *transpose* ) | *lin_ode* . ``get`` ( *call_id* , *r* , *step* , *pattern* , *transpose* ) diff --git a/include/cppad/example/atomic_four/lin_ode/set.hpp b/include/cppad/example/atomic_four/lin_ode/set.hpp index ee01a7b38..94eaa1d47 100644 --- a/include/cppad/example/atomic_four/lin_ode/set.hpp +++ b/include/cppad/example/atomic_four/lin_ode/set.hpp @@ -2,7 +2,7 @@ # define CPPAD_EXAMPLE_ATOMIC_FOUR_LIN_ODE_SET_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_four_lin_ode_set.hpp} @@ -15,7 +15,7 @@ atomic_lin_ode Set Routine: Example Implementation Syntax ****** -*call_id* = *lin_ode* . ``set`` ( *r* , *step* , *pattern* , *transpose* ) +| *call_id* = *lin_ode* . ``set`` ( *r* , *step* , *pattern* , *transpose* ) Prototype ********* diff --git a/include/cppad/example/atomic_four/mat_mul/get.hpp b/include/cppad/example/atomic_four/mat_mul/get.hpp index 7f153d7cc..f14b407f1 100644 --- a/include/cppad/example/atomic_four/mat_mul/get.hpp +++ b/include/cppad/example/atomic_four/mat_mul/get.hpp @@ -2,7 +2,7 @@ # define CPPAD_EXAMPLE_ATOMIC_FOUR_MAT_MUL_GET_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_four_mat_mul_get.hpp} @@ -12,7 +12,7 @@ atomic_mat_mul Get Routine: Example Implementation Syntax ****** -``mat_mul`` . *get* ( ``call_id`` , ``n_left`` , ``n_middle`` , ``n_right`` ) +| ``mat_mul`` . *get* ( ``call_id`` , ``n_left`` , ``n_middle`` , ``n_right`` ) Prototype ********* diff --git a/include/cppad/example/atomic_four/mat_mul/mat_mul.xrst b/include/cppad/example/atomic_four/mat_mul/mat_mul.xrst index 71c3bf0bc..f14e0238a 100644 --- a/include/cppad/example/atomic_four/mat_mul/mat_mul.xrst +++ b/include/cppad/example/atomic_four/mat_mul/mat_mul.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-22 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin atomic_four_mat_mul} {xrst_spell @@ -12,7 +12,6 @@ Atomic Matrix Multiply Class: Example Implementation Syntax ****** - | ``atomic_mat_mul`` *mat_mul* ( *name* ) | *call_id* = *mat_mul* . ``set`` ( *n_left* , *n_middle* , *n_right* ) | *mat_mul* . ``get`` ( *call_id* , *n_left* , *n_middle* , *n_right* ) diff --git a/include/cppad/example/atomic_four/mat_mul/set.hpp b/include/cppad/example/atomic_four/mat_mul/set.hpp index a39322209..6fa18739a 100644 --- a/include/cppad/example/atomic_four/mat_mul/set.hpp +++ b/include/cppad/example/atomic_four/mat_mul/set.hpp @@ -2,7 +2,7 @@ # define CPPAD_EXAMPLE_ATOMIC_FOUR_MAT_MUL_SET_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin atomic_four_mat_mul_set.hpp} @@ -12,7 +12,7 @@ atomic_mat_mul Set Routine: Example Implementation Syntax ****** -*call_id* = *mat_mul* . ``set`` ( *n_left* , *n_middle* , *n_right* ) +| *call_id* = *mat_mul* . ``set`` ( *n_left* , *n_middle* , *n_right* ) Prototype ********* diff --git a/include/cppad/example/atomic_four/vector/vector.xrst b/include/cppad/example/atomic_four/vector/vector.xrst index 8cad49e99..c306518bf 100644 --- a/include/cppad/example/atomic_four/vector/vector.xrst +++ b/include/cppad/example/atomic_four/vector/vector.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin atomic_four_vector} @@ -9,7 +9,6 @@ Atomic Vector Element-wise Operators: Example and Test Syntax ****** - | ``atomic_vector_op`` *vec_op* ( *name* ) | *vec_op* ( *op* , *x* , *y* ) diff --git a/include/cppad/example/base_adolc.hpp b/include/cppad/example/base_adolc.hpp index cced40b35..523b15fd0 100644 --- a/include/cppad/example/base_adolc.hpp +++ b/include/cppad/example/base_adolc.hpp @@ -2,7 +2,7 @@ # define CPPAD_EXAMPLE_BASE_ADOLC_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin base_adolc.hpp} @@ -21,9 +21,7 @@ Enable use of AD where Base is Adolc's adouble Type Syntax ****** - - # ``include `` - +| # ``include `` {xrst_toc_hidden example/general/mul_level_adolc.cpp } diff --git a/include/cppad/example/cppad_eigen.hpp b/include/cppad/example/cppad_eigen.hpp index e3d951984..0abad2f2e 100644 --- a/include/cppad/example/cppad_eigen.hpp +++ b/include/cppad/example/cppad_eigen.hpp @@ -12,9 +12,7 @@ Enable Use of Eigen Linear Algebra Package with CppAD Syntax ****** - - # ``include `` - +| # ``include `` {xrst_toc_hidden include/cppad/example/eigen_plugin.hpp example/general/eigen_array.cpp diff --git a/include/cppad/ipopt/solve.hpp b/include/cppad/ipopt/solve.hpp index 9090e9dc5..312a96b73 100644 --- a/include/cppad/ipopt/solve.hpp +++ b/include/cppad/ipopt/solve.hpp @@ -28,7 +28,6 @@ Use Ipopt to Solve a Nonlinear Programming Problem Syntax ****** - | # ``include `` | ``ipopt::solve`` ( | |tab| *options* , *xi* , *xl* , *xu* , *gl* , *gu* , *fg_eval* , *solution* diff --git a/include/cppad/local/atomic_index.hpp b/include/cppad/local/atomic_index.hpp index 5c79b12fa..d9f6fb57b 100644 --- a/include/cppad/local/atomic_index.hpp +++ b/include/cppad/local/atomic_index.hpp @@ -2,7 +2,7 @@ # define CPPAD_LOCAL_ATOMIC_INDEX_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /*! {xrst_begin atomic_index dev} @@ -12,7 +12,6 @@ Store and Retrieve Atomic Function Information by Index Syntax ****** - | *index_out* = ``local::atomic_index<`` *Base* >( | |tab| *set_null* , *index_in* , *type* , *name* , *ptr* | ) diff --git a/include/cppad/local/graph/cpp_graph_itr.hpp b/include/cppad/local/graph/cpp_graph_itr.hpp index 2c5dea678..05fcf2538 100644 --- a/include/cppad/local/graph/cpp_graph_itr.hpp +++ b/include/cppad/local/graph/cpp_graph_itr.hpp @@ -2,7 +2,7 @@ # define CPPAD_LOCAL_GRAPH_CPP_GRAPH_ITR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include # include @@ -49,7 +49,7 @@ C++ AD Graph Iterator set_value() Syntax ****** -*itr* . ``set_value`` () +| *itr* . ``set_value`` () op_index\_ ********** diff --git a/include/cppad/local/graph/csrc_writer.hpp b/include/cppad/local/graph/csrc_writer.hpp index 76e5cb510..8c5ee5523 100644 --- a/include/cppad/local/graph/csrc_writer.hpp +++ b/include/cppad/local/graph/csrc_writer.hpp @@ -3,7 +3,7 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -17,7 +17,7 @@ Prototype for csrc_writer Syntax ****** -``csrc_writer`` ( *csrc* , *graph_obj* , *type* ) +| ``csrc_writer`` ( *csrc* , *graph_obj* , *type* ) Prototype ********* diff --git a/include/cppad/local/graph/json_lexer.hpp b/include/cppad/local/graph/json_lexer.hpp index e6070f2c8..a84242c7c 100644 --- a/include/cppad/local/graph/json_lexer.hpp +++ b/include/cppad/local/graph/json_lexer.hpp @@ -2,7 +2,7 @@ # define CPPAD_LOCAL_GRAPH_JSON_LEXER_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -100,8 +100,7 @@ json lexer: Report an Error Syntax ****** - - *json_lexer* . ``report_error`` ( *expected* , *found* ) +| *json_lexer* . ``report_error`` ( *expected* , *found* ) json_lexer ********** diff --git a/include/cppad/local/graph/json_parser.hpp b/include/cppad/local/graph/json_parser.hpp index 4a0bf13bf..2f75eeed5 100644 --- a/include/cppad/local/graph/json_parser.hpp +++ b/include/cppad/local/graph/json_parser.hpp @@ -3,7 +3,7 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -19,7 +19,7 @@ Json AD Graph Parser Syntax ****** -``json_parser`` ( *json* , *graph_obj* ) +| ``json_parser`` ( *json* , *graph_obj* ) json **** diff --git a/include/cppad/local/graph/json_writer.hpp b/include/cppad/local/graph/json_writer.hpp index 2d70e77a7..e67ed10f4 100644 --- a/include/cppad/local/graph/json_writer.hpp +++ b/include/cppad/local/graph/json_writer.hpp @@ -3,7 +3,7 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -17,7 +17,7 @@ Json AD Graph Writer Syntax ****** -``json_writer`` ( *json* , *graph_obj* ) +| ``json_writer`` ( *json* , *graph_obj* ) json **** diff --git a/include/cppad/local/op_code_dyn.hpp b/include/cppad/local/op_code_dyn.hpp index 47972b15f..556ccf1fb 100644 --- a/include/cppad/local/op_code_dyn.hpp +++ b/include/cppad/local/op_code_dyn.hpp @@ -2,7 +2,7 @@ # define CPPAD_LOCAL_OP_CODE_DYN_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- namespace CppAD { namespace local { // BEGIN_CPPAD_LOCAL_NAMESPACE @@ -217,8 +217,7 @@ Number of Arguments to a Dynamic Parameter Operator Syntax ****** - - *n_arg* = ``local::num_arg_dyn`` ( *op* ) +| *n_arg* = ``local::num_arg_dyn`` ( *op* ) Prototype ********* diff --git a/include/cppad/local/optimize/get_cexp_info.hpp b/include/cppad/local/optimize/get_cexp_info.hpp index 4894258aa..1db4f966d 100644 --- a/include/cppad/local/optimize/get_cexp_info.hpp +++ b/include/cppad/local/optimize/get_cexp_info.hpp @@ -27,7 +27,6 @@ Information for Each Conditional Expression Syntax ****** - | ``get_cexp_info`` ( | |tab| *play* , | |tab| *random_itr* , diff --git a/include/cppad/local/optimize/get_op_previous.hpp b/include/cppad/local/optimize/get_op_previous.hpp index eeb9d0355..95e5f7d72 100644 --- a/include/cppad/local/optimize/get_op_previous.hpp +++ b/include/cppad/local/optimize/get_op_previous.hpp @@ -2,7 +2,7 @@ # define CPPAD_LOCAL_OPTIMIZE_GET_OP_PREVIOUS_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include # include @@ -20,7 +20,6 @@ Get Mapping From Op to Previous Op That is Equivalent Syntax ****** - | *exceed_collision_limit* = ``get_op_previous`` ( | |tab| *collision_limit* , | |tab| *play* , diff --git a/include/cppad/local/optimize/match_op.hpp b/include/cppad/local/optimize/match_op.hpp index 0e6bcfc3d..dffb577c0 100644 --- a/include/cppad/local/optimize/match_op.hpp +++ b/include/cppad/local/optimize/match_op.hpp @@ -18,7 +18,6 @@ Search for a Previous Operator that Matches Current Operator Syntax ****** - | *exceed_collision_limit* = ``match_op`` ( | |tab| ``collision_limit`` , | |tab| ``random_itr`` , diff --git a/include/cppad/local/optimize/optimize_run.hpp b/include/cppad/local/optimize/optimize_run.hpp index 46eef8271..2e651a0ba 100644 --- a/include/cppad/local/optimize/optimize_run.hpp +++ b/include/cppad/local/optimize/optimize_run.hpp @@ -38,7 +38,6 @@ Convert a player object to an optimized recorder object Syntax ****** - | *exceed_collision_limit* = ``local::optimize::optimize_run`` ( | |tab| ``options`` , ``n`` , ``dep_taddr`` , ``play`` , ``rec`` | ) diff --git a/include/cppad/local/record/comp_op.hpp b/include/cppad/local/record/comp_op.hpp index 9e97481ac..da3402ea0 100644 --- a/include/cppad/local/record/comp_op.hpp +++ b/include/cppad/local/record/comp_op.hpp @@ -2,7 +2,7 @@ # define CPPAD_LOCAL_RECORD_COMP_OP_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -19,8 +19,7 @@ Put Compare Operators in Recording Syntax ****** - - *rec* . ``put_comp_`` *rel* ( *aleft* , *aright* , *result* ) +| *rec* . ``put_comp_`` *rel* ( *aleft* , *aright* , *result* ) rel === diff --git a/include/cppad/local/record/cond_exp.hpp b/include/cppad/local/record/cond_exp.hpp index a7b49c7fb..59b58927e 100644 --- a/include/cppad/local/record/cond_exp.hpp +++ b/include/cppad/local/record/cond_exp.hpp @@ -2,7 +2,7 @@ # define CPPAD_LOCAL_RECORD_COND_EXP_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -15,7 +15,6 @@ Record a Variable or Dynamic Parameter Conditional Expression Syntax ****** - | *rec* . ``cond_exp`` ( | |tab| *tape_id* , *cop* , *result* , *left* , *right* , *if_true* , *if_false* | ) diff --git a/include/cppad/local/record/put_dyn_atomic.hpp b/include/cppad/local/record/put_dyn_atomic.hpp index 6e56f5f55..0d26ce862 100644 --- a/include/cppad/local/record/put_dyn_atomic.hpp +++ b/include/cppad/local/record/put_dyn_atomic.hpp @@ -18,7 +18,6 @@ Put a Dynamic Parameter Atomic Call Operator in Recording Syntax ****** - | *rec* . ``put_dyn_atomic`` ( | |tab| *tape_id* , *atomic_index* , *call_id* , *type_x* , *type_y* , *ax* , *ay* | ) diff --git a/include/cppad/local/record/put_var_atomic.hpp b/include/cppad/local/record/put_var_atomic.hpp index 166114e79..bdffc6165 100644 --- a/include/cppad/local/record/put_var_atomic.hpp +++ b/include/cppad/local/record/put_var_atomic.hpp @@ -2,7 +2,7 @@ # define CPPAD_LOCAL_RECORD_PUT_VAR_ATOMIC_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -18,7 +18,6 @@ Put a Variable Atomic Call Operator in Recording Syntax ****** - | *rec* . ``put_var_atomic`` ( | |tab| *tape_id* , *atomic_index* , *call_id* , *type_x* , *type_y* , *ax* , *ay* | ) diff --git a/include/cppad/local/record/put_var_vecad.hpp b/include/cppad/local/record/put_var_vecad.hpp index 04cca1e85..eb7f41b0b 100644 --- a/include/cppad/local/record/put_var_vecad.hpp +++ b/include/cppad/local/record/put_var_vecad.hpp @@ -2,7 +2,7 @@ # define CPPAD_LOCAL_RECORD_PUT_VAR_VECAD_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -16,7 +16,7 @@ Add One Index to End of Combined Variable VecAD Vector Syntax ****** -*offset* = *rec* . ``put_var_vecad_ind`` ( *vec_ind* ) +| *offset* = *rec* . ``put_var_vecad_ind`` ( *vec_ind* ) Prototype ********* diff --git a/include/cppad/local/sparse/size_setvec.hpp b/include/cppad/local/sparse/size_setvec.hpp index e37226dd5..a37bdc9f5 100644 --- a/include/cppad/local/sparse/size_setvec.hpp +++ b/include/cppad/local/sparse/size_setvec.hpp @@ -167,7 +167,7 @@ class size_setvec private: Number of References to a Set Syntax ****** -*count* = *vec* . ``reference_count`` ( *i* ) +| *count* = *vec* . ``reference_count`` ( *i* ) vec *** diff --git a/include/cppad/local/sparse/unary_op.hpp b/include/cppad/local/sparse/unary_op.hpp index d7e11f0b0..91f33ebc7 100644 --- a/include/cppad/local/sparse/unary_op.hpp +++ b/include/cppad/local/sparse/unary_op.hpp @@ -2,7 +2,7 @@ # define CPPAD_LOCAL_SPARSE_UNARY_OP_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- // BEGIN_CPPAD_LOCAL_SPARSE_NAMESPACE @@ -217,7 +217,6 @@ Forward Hessian Sparsity for Non-linear Unary Operators Syntax ****** - | ``local::for_hes_nl_unary_op`` ( | |tab| *np1* , *numvar* , *i_v* , *for_sparsity* | ) diff --git a/include/cppad/local/sweep/for_hes.hpp b/include/cppad/local/sweep/for_hes.hpp index 4e770ec18..853fcaa39 100644 --- a/include/cppad/local/sweep/for_hes.hpp +++ b/include/cppad/local/sweep/for_hes.hpp @@ -19,7 +19,6 @@ Forward Mode Hessian Sparsity Patterns Syntax ****** - | ``local::sweep::for_hes`` ( | |tab| *play* , | |tab| *n* , diff --git a/include/cppad/local/sweep/forward0.hpp b/include/cppad/local/sweep/forward0.hpp index 3da712587..44ddf447b 100644 --- a/include/cppad/local/sweep/forward0.hpp +++ b/include/cppad/local/sweep/forward0.hpp @@ -29,7 +29,6 @@ Compute Zero Order Forward Mode Taylor Coefficients Syntax ****** - | ``forward0`` ( | |tab| *play* , | |tab| *s_out* , diff --git a/include/cppad/local/sweep/rev_jac.hpp b/include/cppad/local/sweep/rev_jac.hpp index 1f7c8e096..a5e6760fc 100644 --- a/include/cppad/local/sweep/rev_jac.hpp +++ b/include/cppad/local/sweep/rev_jac.hpp @@ -23,7 +23,6 @@ Reverse Mode Jacobian Sparsity Patterns Syntax ****** - | ``local::sweep::rev_jac`` ( | |tab| *play* , | |tab| *dependency* , diff --git a/include/cppad/local/utility/cppad_vector_itr.hpp b/include/cppad/local/utility/cppad_vector_itr.hpp index fdd2fb92c..4d227cecf 100644 --- a/include/cppad/local/utility/cppad_vector_itr.hpp +++ b/include/cppad/local/utility/cppad_vector_itr.hpp @@ -19,13 +19,13 @@ Vector Class Iterator Preprocessor Definitions Syntax ****** -:: - - # define CPPAD_CONST 0 - # include - # undef CPPAD_LOCAL_UTILITY_CPPAD_VECTOR_ITR_HPP - # define CPPAD_CONST 1 - # include +{xrst_code cpp} +# define CPPAD_CONST 0 +# include +# undef CPPAD_LOCAL_UTILITY_CPPAD_VECTOR_ITR_HPP +# define CPPAD_CONST 1 +# include +{xrst_code} Beginning of cppad_vector_itr.hpp ********************************* diff --git a/include/cppad/local/utility/vector_bool.hpp b/include/cppad/local/utility/vector_bool.hpp index 5032f2c8e..e3e468086 100644 --- a/include/cppad/local/utility/vector_bool.hpp +++ b/include/cppad/local/utility/vector_bool.hpp @@ -2,7 +2,7 @@ # define CPPAD_LOCAL_UTILITY_VECTOR_BOOL_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -17,7 +17,6 @@ vectorBoolElement Class Syntax ****** - | ``local::utility::vectorBoolElement`` *element* ( *unit* , *mask* ) | ``local::utility::vectorBoolElement`` *element* ( *other* ) | *value* = *element* diff --git a/include/cppad/local/val_graph/fun2val.hpp b/include/cppad/local/val_graph/fun2val.hpp index bfcb99a37..1f95090d1 100644 --- a/include/cppad/local/val_graph/fun2val.hpp +++ b/include/cppad/local/val_graph/fun2val.hpp @@ -13,7 +13,6 @@ Create a Value Graph Corresponding to an ADFun Object Syntax ****** - | |tab| ``ADFun`` < *Base* > *fun* | |tab| *fun* . ``fun2val`` ( *val_tape* ) diff --git a/include/cppad/local/val_graph/op_iterator.hpp b/include/cppad/local/val_graph/op_iterator.hpp index 435656a5a..961fc16bd 100644 --- a/include/cppad/local/val_graph/op_iterator.hpp +++ b/include/cppad/local/val_graph/op_iterator.hpp @@ -2,7 +2,7 @@ # define CPPAD_LOCAL_VAL_GRAPH_OP_ITERATOR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // -------------------------------------------------------------------------- /* ------------------------------------------------------------------------------ @@ -13,7 +13,6 @@ Class For Iterating Over Operators in a Value Tape Syntax ****** - | |tab| ``op_iterator`` < *Value* > *op_itr* ( *tape* , *op_index* ) | |tab| *op_itr* . ``op_ptr`` () | |tab| *op_itr* . ``arg_index`` () diff --git a/include/cppad/local/val_graph/val2fun.hpp b/include/cppad/local/val_graph/val2fun.hpp index 3cce89213..ed35ae762 100644 --- a/include/cppad/local/val_graph/val2fun.hpp +++ b/include/cppad/local/val_graph/val2fun.hpp @@ -12,7 +12,6 @@ Create an ADFun Object Corresponding to a Value Graph Syntax ****** - | |tab| ``ADFun`` < *Base* > *fun* | |tab| *fun* . ``val2fun`` ( *val_tape* , *dyn_ind* , *var_ind* ) | |tab| *fun* . ``val2fun`` ( *val_tape* , *dyn_ind* , *var_ind* , *use_val* ) diff --git a/include/cppad/local/var_op/binary_op.xrst b/include/cppad/local/var_op/binary_op.xrst index 5b92f1024..602ceed72 100644 --- a/include/cppad/local/var_op/binary_op.xrst +++ b/include/cppad/local/var_op/binary_op.xrst @@ -13,7 +13,6 @@ Variable Forward Binary Operators Syntax ****** - | ``forward_`` *name* _ ``op`` ( | |tab| *p* , *q* , *i_z* , *arg* , *parameter* *cap_order* , *taylor* | ) diff --git a/include/cppad/local/var_op/discrete_op.hpp b/include/cppad/local/var_op/discrete_op.hpp index 0d44ea1c9..13a8da6de 100644 --- a/include/cppad/local/var_op/discrete_op.hpp +++ b/include/cppad/local/var_op/discrete_op.hpp @@ -17,7 +17,6 @@ Forward Mode Result for Discrete Functions Syntax ****** - | ``forward_dis_op`` ( | |tab| *p* , *q* , *r* , *i_z* , *arg* , *cap_order* , *taylor* | ) ``forward_dis_op`` ( diff --git a/include/cppad/local/var_op/unary_op.xrst b/include/cppad/local/var_op/unary_op.xrst index 630c8fb81..da3e606cc 100644 --- a/include/cppad/local/var_op/unary_op.xrst +++ b/include/cppad/local/var_op/unary_op.xrst @@ -13,7 +13,7 @@ Variable Forward Unary Operators Syntax ****** -``forward_`` *name* _ ``op`` ( *p* , *q* , *i_z* , *i_x* , *cap_order* , *taylor* ) +| ``forward_`` *name* _ ``op`` ( *p* , *q* , *i_z* , *i_x* , *cap_order* , *taylor* ) Assumption ********** diff --git a/include/cppad/speed/det_33.hpp b/include/cppad/speed/det_33.hpp index d7ccdb46c..92a5d7ff3 100644 --- a/include/cppad/speed/det_33.hpp +++ b/include/cppad/speed/det_33.hpp @@ -2,7 +2,7 @@ # define CPPAD_SPEED_DET_33_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin det_33} @@ -12,10 +12,8 @@ Check Determinant of 3 by 3 matrix Syntax ****** - - # ``include `` - -*ok* = ``det_33`` ( *x* , *d* ) +| # ``include `` +| *ok* = ``det_33`` ( *x* , *d* ) Purpose ******* diff --git a/include/cppad/speed/det_by_lu.hpp b/include/cppad/speed/det_by_lu.hpp index 4e0659451..515fb42ce 100644 --- a/include/cppad/speed/det_by_lu.hpp +++ b/include/cppad/speed/det_by_lu.hpp @@ -2,7 +2,7 @@ # define CPPAD_SPEED_DET_BY_LU_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin det_by_lu} @@ -12,7 +12,6 @@ Determinant Using Expansion by Lu Factorization Syntax ****** - | # ``include `` | ``det_by_lu`` < *Scalar* > *det* ( *n* ) | *d* = *det* ( *a* ) diff --git a/include/cppad/speed/det_by_minor.hpp b/include/cppad/speed/det_by_minor.hpp index 145592800..a9f809a21 100644 --- a/include/cppad/speed/det_by_minor.hpp +++ b/include/cppad/speed/det_by_minor.hpp @@ -2,7 +2,7 @@ # define CPPAD_SPEED_DET_BY_MINOR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin det_by_minor} @@ -12,7 +12,6 @@ Determinant Using Expansion by Minors Syntax ****** - | ``# include `` | ``det_by_minor`` < *Scalar* > *det* ( *n* ) | *d* = *det* ( *a* ) diff --git a/include/cppad/speed/det_grad_33.hpp b/include/cppad/speed/det_grad_33.hpp index 6d752be13..f88f9111b 100644 --- a/include/cppad/speed/det_grad_33.hpp +++ b/include/cppad/speed/det_grad_33.hpp @@ -2,7 +2,7 @@ # define CPPAD_SPEED_DET_GRAD_33_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin det_grad_33} @@ -12,10 +12,8 @@ Check Gradient of Determinant of 3 by 3 matrix Syntax ****** - - # ``include `` - -*ok* = ``det_grad_33`` ( *x* , *g* ) +| # ``include `` +| *ok* = ``det_grad_33`` ( *x* , *g* ) Purpose ******* diff --git a/include/cppad/speed/det_of_minor.hpp b/include/cppad/speed/det_of_minor.hpp index 457a7a3f4..76064f96b 100644 --- a/include/cppad/speed/det_of_minor.hpp +++ b/include/cppad/speed/det_of_minor.hpp @@ -2,7 +2,7 @@ # define CPPAD_SPEED_DET_OF_MINOR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin det_of_minor} @@ -12,7 +12,6 @@ Determinant of a Minor Syntax ****** - | ``# include `` | *d* = ``det_of_minor`` ( *a* , *m* , *n* , *r* , *c* ) diff --git a/include/cppad/speed/mat_sum_sq.hpp b/include/cppad/speed/mat_sum_sq.hpp index cddff70aa..32f0bc045 100644 --- a/include/cppad/speed/mat_sum_sq.hpp +++ b/include/cppad/speed/mat_sum_sq.hpp @@ -2,7 +2,7 @@ # define CPPAD_SPEED_MAT_SUM_SQ_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin mat_sum_sq} @@ -12,10 +12,8 @@ Sum Elements of a Matrix Times Itself Syntax ****** - - # ``include `` - -*mat_sum_sq* ( ``n`` , ``x`` , ``y`` , ``z`` ) +| # ``include `` +| *mat_sum_sq* ( ``n`` , ``x`` , ``y`` , ``z`` ) Purpose ******* diff --git a/include/cppad/speed/ode_evaluate.hpp b/include/cppad/speed/ode_evaluate.hpp index 582c81de0..faa4772b0 100644 --- a/include/cppad/speed/ode_evaluate.hpp +++ b/include/cppad/speed/ode_evaluate.hpp @@ -17,10 +17,8 @@ Evaluate a Function Defined in Terms of an ODE Syntax ****** - - # ``include `` - -``ode_evaluate`` ( *x* , *p* , *fp* ) +| # ``include `` +| ``ode_evaluate`` ( *x* , *p* , *fp* ) Purpose ******* diff --git a/include/cppad/speed/sparse_hes_fun.hpp b/include/cppad/speed/sparse_hes_fun.hpp index 9edb4e47f..e962c5ec2 100644 --- a/include/cppad/speed/sparse_hes_fun.hpp +++ b/include/cppad/speed/sparse_hes_fun.hpp @@ -2,7 +2,7 @@ # define CPPAD_SPEED_SPARSE_HES_FUN_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin sparse_hes_fun} @@ -15,10 +15,8 @@ Evaluate a Function That Has a Sparse Hessian Syntax ****** - - # ``include `` - -``sparse_hes_fun`` ( *n* , *x* , *row* , *col* , *p* , *fp* ) +| # ``include `` +| ``sparse_hes_fun`` ( *n* , *x* , *row* , *col* , *p* , *fp* ) Purpose ******* diff --git a/include/cppad/speed/sparse_jac_fun.hpp b/include/cppad/speed/sparse_jac_fun.hpp index 4f2e3cfaf..ffe22f944 100644 --- a/include/cppad/speed/sparse_jac_fun.hpp +++ b/include/cppad/speed/sparse_jac_fun.hpp @@ -2,7 +2,7 @@ # define CPPAD_SPEED_SPARSE_JAC_FUN_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin sparse_jac_fun} @@ -15,10 +15,8 @@ Evaluate a Function That Has a Sparse Jacobian Syntax ****** - - # ``include `` - -``sparse_jac_fun`` ( *m* , *n* , *x* , *row* , *col* , *p* , *fp* ) +| # ``include `` +| ``sparse_jac_fun`` ( *m* , *n* , *x* , *row* , *col* , *p* , *fp* ) Purpose ******* diff --git a/include/cppad/speed/uniform_01.hpp b/include/cppad/speed/uniform_01.hpp index 25240c34c..fa6c4deaf 100644 --- a/include/cppad/speed/uniform_01.hpp +++ b/include/cppad/speed/uniform_01.hpp @@ -2,7 +2,7 @@ # define CPPAD_SPEED_UNIFORM_01_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin uniform_01} @@ -12,11 +12,9 @@ Simulate a [0,1] Uniform Random Variate Syntax ****** - | # ``include `` | ``uniform_01`` ( *seed* ) - -``uniform_01`` ( *n* , *x* ) +| ``uniform_01`` ( *n* , *x* ) Purpose ******* diff --git a/include/cppad/utility/check_numeric_type.hpp b/include/cppad/utility/check_numeric_type.hpp index 073879f51..a5d5790f4 100644 --- a/include/cppad/utility/check_numeric_type.hpp +++ b/include/cppad/utility/check_numeric_type.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_CHECK_NUMERIC_TYPE_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin CheckNumericType} @@ -12,10 +12,8 @@ Check NumericType Class Concept Syntax ****** - - # ``include `` - -``CheckNumericType`` < *NumericType* >() +| # ``include `` +| ``CheckNumericType`` < *NumericType* >() Purpose ******* diff --git a/include/cppad/utility/create_dll_lib.hpp b/include/cppad/utility/create_dll_lib.hpp index 0f469cb14..84c73941c 100644 --- a/include/cppad/utility/create_dll_lib.hpp +++ b/include/cppad/utility/create_dll_lib.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_CREATE_DLL_LIB_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin create_dll_lib} @@ -20,7 +20,6 @@ Create a Dynamic Link Library Syntax ****** - | # ``include `` | *err_msg* = ``create_dll_lib`` ( *dll_file* , *csrc_files* , *options* ) diff --git a/include/cppad/utility/elapsed_seconds.hpp b/include/cppad/utility/elapsed_seconds.hpp index 83a76788f..7290ad7ab 100644 --- a/include/cppad/utility/elapsed_seconds.hpp +++ b/include/cppad/utility/elapsed_seconds.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_ELAPSED_SECONDS_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -16,10 +16,8 @@ Returns Elapsed Number of Seconds Syntax ****** - - # ``include `` - -*s* = ``elapsed_seconds`` () +| # ``include `` +| *s* = ``elapsed_seconds`` () Accuracy ******** diff --git a/include/cppad/utility/error_handler.hpp b/include/cppad/utility/error_handler.hpp index 8df705a47..2b4f21330 100644 --- a/include/cppad/utility/error_handler.hpp +++ b/include/cppad/utility/error_handler.hpp @@ -17,7 +17,6 @@ Replacing the CppAD Error Handler Syntax ****** - | # ``include `` | ``ErrorHandler`` *info* ( *handler* ) | ``ErrorHandler::Call`` ( *known* , *line* , *file* , *exp* , *msg* ) diff --git a/include/cppad/utility/index_sort.hpp b/include/cppad/utility/index_sort.hpp index 871758d81..86ccbd8c9 100644 --- a/include/cppad/utility/index_sort.hpp +++ b/include/cppad/utility/index_sort.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_INDEX_SORT_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,10 +13,8 @@ Returns Indices that Sort a Vector Syntax ****** - - # ``include `` - -``index_sort`` ( *keys* , *ind* ) +| # ``include `` +| ``index_sort`` ( *keys* , *ind* ) keys **** diff --git a/include/cppad/utility/link_dll_lib.hpp b/include/cppad/utility/link_dll_lib.hpp index f2a4757af..8697ba308 100644 --- a/include/cppad/utility/link_dll_lib.hpp +++ b/include/cppad/utility/link_dll_lib.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_LINK_DLL_LIB_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin link_dll_lib} @@ -15,13 +15,11 @@ Link a Dynamic Link Library Syntax ****** - | # ``include `` | ``link_dll_lib`` *dll_linker* ( *dll_file* , *err_msg* ) | *fun_ptr* = *dll_linker* ( *function_name* , *err_msg* ) | - Prototype ********* {xrst_literal diff --git a/include/cppad/utility/lu_factor.hpp b/include/cppad/utility/lu_factor.hpp index 81ee5c198..1cbd95d73 100644 --- a/include/cppad/utility/lu_factor.hpp +++ b/include/cppad/utility/lu_factor.hpp @@ -18,10 +18,8 @@ LU Factorization of A Square Matrix Syntax ****** - - # ``include `` - -*sign* = ``LuFactor`` ( *ip* , *jp* , *LU* ) +| # ``include `` +| *sign* = ``LuFactor`` ( *ip* , *jp* , *LU* ) Description *********** diff --git a/include/cppad/utility/lu_invert.hpp b/include/cppad/utility/lu_invert.hpp index d94064595..1eaa8e8fd 100644 --- a/include/cppad/utility/lu_invert.hpp +++ b/include/cppad/utility/lu_invert.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_LU_INVERT_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -17,10 +17,8 @@ Invert an LU Factored Equation Syntax ****** - - # ``include `` - -``LuInvert`` ( *ip* , *jp* , *LU* , *X* ) +| # ``include `` +| ``LuInvert`` ( *ip* , *jp* , *LU* , *X* ) Description *********** diff --git a/include/cppad/utility/lu_solve.hpp b/include/cppad/utility/lu_solve.hpp index 196baac14..74f040744 100644 --- a/include/cppad/utility/lu_solve.hpp +++ b/include/cppad/utility/lu_solve.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_LU_SOLVE_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -19,10 +19,8 @@ Compute Determinant and Solve Linear Equations Syntax ****** - - # ``include `` - -*signdet* = ``LuSolve`` ( *n* , *m* , *A* , *B* , *X* , *logdet* ) +| # ``include `` +| *signdet* = ``LuSolve`` ( *n* , *m* , *A* , *B* , *X* , *logdet* ) Description *********** diff --git a/include/cppad/utility/memory_leak.hpp b/include/cppad/utility/memory_leak.hpp index 16afec3d1..a1994be9a 100644 --- a/include/cppad/utility/memory_leak.hpp +++ b/include/cppad/utility/memory_leak.hpp @@ -17,11 +17,9 @@ You should instead use the routine :ref:`ta_free_all-name` . Syntax ****** - | # ``include `` | ``flag`` = ``memory_leak`` () - -*flag* = *memory_leak* ( *add_static* ) +| *flag* = *memory_leak* ( *add_static* ) Purpose ******* diff --git a/include/cppad/utility/nan.hpp b/include/cppad/utility/nan.hpp index 8106fd99e..2cec1409f 100644 --- a/include/cppad/utility/nan.hpp +++ b/include/cppad/utility/nan.hpp @@ -16,11 +16,9 @@ Obtain Nan or Determine if a Value is Nan Syntax ****** - | # ``include `` | *b* = ``CppAD::isnan`` ( *s* ) - -*b* = ``hasnan`` ( *v* ) +| *b* = ``hasnan`` ( *v* ) Purpose ******* diff --git a/include/cppad/utility/near_equal.hpp b/include/cppad/utility/near_equal.hpp index 1c7891639..1d8aa905c 100644 --- a/include/cppad/utility/near_equal.hpp +++ b/include/cppad/utility/near_equal.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_NEAR_EQUAL_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -17,10 +17,8 @@ Determine if Two Values Are Nearly Equal Syntax ****** - - # ``include `` - -*b* = ``NearEqual`` ( *x* , *y* , *r* , *a* ) +| # ``include `` +| *b* = ``NearEqual`` ( *x* , *y* , *r* , *a* ) Purpose ******* diff --git a/include/cppad/utility/ode_err_control.hpp b/include/cppad/utility/ode_err_control.hpp index 7fedec709..d3461f747 100644 --- a/include/cppad/utility/ode_err_control.hpp +++ b/include/cppad/utility/ode_err_control.hpp @@ -28,7 +28,6 @@ An Error Controller for ODE Solvers Syntax ****** - | # ``include `` | *xf* = ``OdeErrControl`` ( *method* , *ti* , *tf* , *xi* , | |tab| ``smin`` , ``smax`` , ``scur`` , ``eabs`` , ``erel`` , ``ef`` , ``maxabs`` , ``nstep`` ) diff --git a/include/cppad/utility/ode_gear.hpp b/include/cppad/utility/ode_gear.hpp index 0ffedfc0e..9dcefe026 100644 --- a/include/cppad/utility/ode_gear.hpp +++ b/include/cppad/utility/ode_gear.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_ODE_GEAR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -20,10 +20,8 @@ An Arbitrary Order Gear Method Syntax ****** - - # ``include `` - -``OdeGear`` ( *F* , *m* , *n* , *T* , *X* , *e* ) +| # ``include `` +| ``OdeGear`` ( *F* , *m* , *n* , *T* , *X* , *e* ) Purpose ******* diff --git a/include/cppad/utility/ode_gear_control.hpp b/include/cppad/utility/ode_gear_control.hpp index 0899e36a5..1779f42d1 100644 --- a/include/cppad/utility/ode_gear_control.hpp +++ b/include/cppad/utility/ode_gear_control.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_ODE_GEAR_CONTROL_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -28,7 +28,6 @@ An Error Controller for Gear's Ode Solvers Syntax ****** - | # ``include `` | *xf* = ``OdeGearControl`` ( *F* , *M* , *ti* , *tf* , *xi* , | |tab| ``smin`` , ``smax`` , ``sini`` , ``eabs`` , ``erel`` , ``ef`` , ``maxabs`` , ``nstep`` ) diff --git a/include/cppad/utility/omp_alloc.hpp b/include/cppad/utility/omp_alloc.hpp index 23577bd2f..a3e96f3b5 100644 --- a/include/cppad/utility/omp_alloc.hpp +++ b/include/cppad/utility/omp_alloc.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_OMP_ALLOC_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include # ifdef _OPENMP @@ -25,7 +25,6 @@ and :ref:`thread_alloc:num_threads` instead. Syntax ****** - | # ``include `` | ``omp_alloc::set_max_num_threads`` ( *number* ) | *number* = ``omp_alloc::get_max_num_threads`` () diff --git a/include/cppad/utility/poly.hpp b/include/cppad/utility/poly.hpp index 4cdd0a476..7acf25d76 100644 --- a/include/cppad/utility/poly.hpp +++ b/include/cppad/utility/poly.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_POLY_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin Poly} @@ -12,10 +12,8 @@ Evaluate a Polynomial or its Derivative Syntax ****** - - # ``include `` - -*p* = ``Poly`` ( *k* , *a* , *z* ) +| # ``include `` +| *p* = ``Poly`` ( *k* , *a* , *z* ) Description *********** diff --git a/include/cppad/utility/pow_int.hpp b/include/cppad/utility/pow_int.hpp index ee3d84b22..35fe0477e 100644 --- a/include/cppad/utility/pow_int.hpp +++ b/include/cppad/utility/pow_int.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_POW_INT_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -14,10 +14,8 @@ The Integer Power Function Syntax ****** - - # ``include `` - -*z* = ``pow`` ( *x* , *y* ) +| # ``include `` +| *z* = ``pow`` ( *x* , *y* ) See Also ******** diff --git a/include/cppad/utility/romberg_mul.hpp b/include/cppad/utility/romberg_mul.hpp index bf66c1639..6ede563f2 100644 --- a/include/cppad/utility/romberg_mul.hpp +++ b/include/cppad/utility/romberg_mul.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_ROMBERG_MUL_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin RombergMul} @@ -15,12 +15,9 @@ Multi-dimensional Romberg Integration Syntax ****** - - # ``include `` - -``RombergMul`` < *Fun* , *SizeVector* , *FloatVector* , *m* > *R* - -*r* = *R* ( *F* , *a* , *b* , *n* , *p* , *e* ) +| # ``include `` +| ``RombergMul`` < *Fun* , *SizeVector* , *FloatVector* , *m* > *R* +| *r* = *R* ( *F* , *a* , *b* , *n* , *p* , *e* ) Description *********** diff --git a/include/cppad/utility/romberg_one.hpp b/include/cppad/utility/romberg_one.hpp index 2ac1ecbd3..3386af4c1 100644 --- a/include/cppad/utility/romberg_one.hpp +++ b/include/cppad/utility/romberg_one.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_ROMBERG_ONE_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin RombergOne} @@ -15,10 +15,8 @@ One DimensionalRomberg Integration Syntax ****** - - # ``include `` - -*r* = ``RombergOne`` ( *F* , *a* , *b* , *n* , *e* ) +| # ``include `` +| *r* = ``RombergOne`` ( *F* , *a* , *b* , *n* , *e* ) Description *********** diff --git a/include/cppad/utility/rosen_34.hpp b/include/cppad/utility/rosen_34.hpp index e5a988a0b..59a69b7c9 100644 --- a/include/cppad/utility/rosen_34.hpp +++ b/include/cppad/utility/rosen_34.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_ROSEN_34_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -21,7 +21,6 @@ A 3rd and 4th Order Rosenbrock ODE Solver Syntax ****** - | # ``include `` | *xf* = ``Rosen34`` ( *F* , *M* , *ti* , *tf* , *xi* ) | *xf* = ``Rosen34`` ( *F* , *M* , *ti* , *tf* , *xi* , *e* ) diff --git a/include/cppad/utility/runge_45.hpp b/include/cppad/utility/runge_45.hpp index f752a4be1..d62f801b8 100644 --- a/include/cppad/utility/runge_45.hpp +++ b/include/cppad/utility/runge_45.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_RUNGE_45_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -19,7 +19,6 @@ An Embedded 4th and 5th Order Runge-Kutta ODE Solver Syntax ****** - | # ``include `` | *xf* = ``Runge45`` ( *F* , *M* , *ti* , *tf* , *xi* ) | *xf* = ``Runge45`` ( *F* , *M* , *ti* , *tf* , *xi* , *e* ) diff --git a/include/cppad/utility/set_union.hpp b/include/cppad/utility/set_union.hpp index df258cf62..190e1220a 100644 --- a/include/cppad/utility/set_union.hpp +++ b/include/cppad/utility/set_union.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_SET_UNION_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,10 +13,8 @@ Union of Standard Sets Syntax ****** - - # ``include `` - -*result* = ``set_union`` ( *left* , *right* ) +| # ``include `` +| *result* = ``set_union`` ( *left* , *right* ) Purpose ******* diff --git a/include/cppad/utility/sparse2eigen.hpp b/include/cppad/utility/sparse2eigen.hpp index 28a6a22e3..e44ba7c21 100644 --- a/include/cppad/utility/sparse2eigen.hpp +++ b/include/cppad/utility/sparse2eigen.hpp @@ -16,10 +16,8 @@ Convert A CppAD Sparse Matrix to an Eigen Sparse Matrix Syntax ****** - - # ``include `` - -``sparse2eigen`` ( *source* , *destination* ) +| # ``include `` +| ``sparse2eigen`` ( *source* , *destination* ) Prototype ********* diff --git a/include/cppad/utility/sparse_rcv.hpp b/include/cppad/utility/sparse_rcv.hpp index fbe1d15f0..c84e8ed66 100644 --- a/include/cppad/utility/sparse_rcv.hpp +++ b/include/cppad/utility/sparse_rcv.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_SPARSE_RCV_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -17,7 +17,6 @@ Sparse Matrix Row, Column, Value Representation Syntax ****** - | # ``include `` | ``sparse_rcv`` < *SizeVector* , *ValueVector* > *empty* | ``sparse_rcv`` < *SizeVector* , *ValueVector* > *matrix* ( *pattern* ) diff --git a/include/cppad/utility/speed_test.hpp b/include/cppad/utility/speed_test.hpp index ccee7f22b..d758b6071 100644 --- a/include/cppad/utility/speed_test.hpp +++ b/include/cppad/utility/speed_test.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_SPEED_TEST_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -17,10 +17,8 @@ Run One Speed Test and Return Results Syntax ****** - - # ``include `` - -*rate_vec* = ``speed_test`` ( *test* , *size_vec* , *time_min* ) +| # ``include `` +| *rate_vec* = ``speed_test`` ( *test* , *size_vec* , *time_min* ) See Also ******** diff --git a/include/cppad/utility/test_boolofvoid.hpp b/include/cppad/utility/test_boolofvoid.hpp index d1909cfa5..bee5b094f 100644 --- a/include/cppad/utility/test_boolofvoid.hpp +++ b/include/cppad/utility/test_boolofvoid.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_TEST_BOOLOFVOID_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin test_boolofvoid} @@ -12,12 +12,10 @@ Object that Runs a Group of Tests Syntax ****** - | # ``include `` | ``test_boolofvoid`` *Run* ( *group* , *width* ) | *Run* ( *test* , *name* ) - -*ok* = *Run* . ``summary`` ( *memory_ok* ) +| *ok* = *Run* . ``summary`` ( *memory_ok* ) Purpose ******* diff --git a/include/cppad/utility/thread_alloc.hpp b/include/cppad/utility/thread_alloc.hpp index 802a9ea4c..8b8be76e9 100644 --- a/include/cppad/utility/thread_alloc.hpp +++ b/include/cppad/utility/thread_alloc.hpp @@ -410,8 +410,7 @@ Setup thread_alloc For Use in Multi-Threading Environment Syntax ****** - - ``thread_alloc::parallel_setup`` ( *num_threads* , *in_parallel* , *thread_num* ) +| ``thread_alloc::parallel_setup`` ( *num_threads* , *in_parallel* , *thread_num* ) Purpose ******* diff --git a/include/cppad/utility/time_test.hpp b/include/cppad/utility/time_test.hpp index ac426efc4..e8b54ca7e 100644 --- a/include/cppad/utility/time_test.hpp +++ b/include/cppad/utility/time_test.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_TIME_TEST_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,7 +13,6 @@ Determine Amount of Time to Execute a Test Syntax ****** - | # ``include `` | *time* = ``time_test`` ( *test_fun* , *time_min* ) | *time* = ``time_test`` ( *test_fun* , *time_min* , *test_size* ) diff --git a/include/cppad/utility/to_string.hpp b/include/cppad/utility/to_string.hpp index 5cb74e9e4..9a565c04e 100644 --- a/include/cppad/utility/to_string.hpp +++ b/include/cppad/utility/to_string.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_TO_STRING_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -17,10 +17,8 @@ Convert Certain Types to a String Syntax ****** - - # ``include `` - -*s* = ``to_string`` ( *value* ) . +| # ``include `` +| *s* = ``to_string`` ( *value* ) . See Also ******** diff --git a/include/cppad/utility/track_new_del.hpp b/include/cppad/utility/track_new_del.hpp index 6a34165f1..7d329b08d 100644 --- a/include/cppad/utility/track_new_del.hpp +++ b/include/cppad/utility/track_new_del.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_TRACK_NEW_DEL_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin track_new_del app} @@ -25,13 +25,11 @@ properly in multi-threading environment). Syntax ****** - | # ``include `` | *newptr* = ``TrackNewVec`` ( *file* , *line* , *newlen* , *oldptr* ) | ``TrackDelVec`` ( *file* , *line* , *oldptr* ) | *newptr* = ``TrackExtend`` ( *file* , *line* , *newlen* , *ncopy* , *oldptr* ) - -*count* = ``TrackCount`` ( *file* , *line* ) +| *count* = ``TrackCount`` ( *file* , *line* ) Purpose ******* diff --git a/include/cppad/utility/vector.hpp b/include/cppad/utility/vector.hpp index e70b0ec07..783638a4e 100644 --- a/include/cppad/utility/vector.hpp +++ b/include/cppad/utility/vector.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_VECTOR_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- @@ -32,7 +32,6 @@ Vector Class: Member Data Syntax ****** - | *vec* . ``capacity`` () | *vec* . ``size`` () | *vec* . ``data`` () diff --git a/include/cppad/utility/vector_bool.hpp b/include/cppad/utility/vector_bool.hpp index abf770159..acf9bc937 100644 --- a/include/cppad/utility/vector_bool.hpp +++ b/include/cppad/utility/vector_bool.hpp @@ -2,7 +2,7 @@ # define CPPAD_UTILITY_VECTOR_BOOL_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- @@ -27,7 +27,6 @@ vectorBool: Member Data Syntax ****** - | *vec* . ``unit_min`` () | *vec* . ``bit_per_unit`` () diff --git a/include/cppad/utility/xrst/cppad_vector.xrst b/include/cppad/utility/xrst/cppad_vector.xrst index bad635d0e..392aad146 100644 --- a/include/cppad/utility/xrst/cppad_vector.xrst +++ b/include/cppad/utility/xrst/cppad_vector.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin CppAD_vector} @@ -20,7 +20,6 @@ The CppAD::vector Template Class Syntax ****** - | # ``include `` | # ``include `` | ``CppAD::vector<`` *Scalar* > *vec* , *other* diff --git a/include/cppad/wno_conversion.hpp b/include/cppad/wno_conversion.hpp index 33b9ce03d..7e83f0eb9 100644 --- a/include/cppad/wno_conversion.hpp +++ b/include/cppad/wno_conversion.hpp @@ -2,7 +2,7 @@ # define CPPAD_WNO_CONVERSION_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* @@ -13,7 +13,7 @@ Suppress Suspect Implicit Conversion Warnings Syntax ****** -# ``include `` +| # ``include `` Purpose ******* diff --git a/introduction/exp_2.hpp b/introduction/exp_2.hpp index fd11d26b3..f61f99b14 100644 --- a/introduction/exp_2.hpp +++ b/introduction/exp_2.hpp @@ -2,7 +2,7 @@ # define CPPAD_INTRODUCTION_EXP_2_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin exp_2} @@ -16,9 +16,8 @@ Second Order Exponential Approximation Syntax ****** -# ``include`` ``"exp_2.hpp"`` - -*y* = ``exp_2`` ( *x* ) +| # ``include`` ``"exp_2.hpp"`` +| *y* = ``exp_2`` ( *x* ) Purpose ******* diff --git a/introduction/exp_eps.hpp b/introduction/exp_eps.hpp index 1cbbc226c..23af25f32 100644 --- a/introduction/exp_eps.hpp +++ b/introduction/exp_eps.hpp @@ -2,7 +2,7 @@ # define CPPAD_INTRODUCTION_EXP_EPS_HPP // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- /* {xrst_begin exp_eps} @@ -16,9 +16,8 @@ An Epsilon Accurate Exponential Approximation Syntax ****** -# ``include`` ``"exp_eps.hpp"`` - -*y* = ``exp_eps`` ( *x* , *epsilon* ) +| # ``include`` ``"exp_eps.hpp"`` +| *y* = ``exp_eps`` ( *x* , *epsilon* ) Purpose ******* diff --git a/speed/adolc/alloc_mat.cpp b/speed/adolc/alloc_mat.cpp index 5f557e4ca..5df678a1b 100644 --- a/speed/adolc/alloc_mat.cpp +++ b/speed/adolc/alloc_mat.cpp @@ -10,7 +10,6 @@ Adolc Test Utility: Allocate and Free Memory For a Matrix Syntax ****** - | *mat* = ``adolc_alloc_mat`` ( *m* , *n* ) | *adolc_free_mat* ( ``mat`` ) diff --git a/speed/main.cpp b/speed/main.cpp index 299a199f6..f294d6b0d 100644 --- a/speed/main.cpp +++ b/speed/main.cpp @@ -1,6 +1,6 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-23 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -64,7 +64,7 @@ Running the Speed Test Program Syntax ****** -``speed/`` *package* / ``speed_`` *package* *test* *seed* *option_list* +| ``speed/`` *package* / ``speed_`` *package* *test* *seed* *option_list* Purpose ******* diff --git a/speed/src/dev_link.xrst b/speed/src/dev_link.xrst index 5f0d96ff4..bdb1bf3a0 100644 --- a/speed/src/dev_link.xrst +++ b/speed/src/dev_link.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-22 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin speed_available dev} {xrst_spell @@ -12,8 +12,7 @@ Is A Speed Test Available Syntax ****** - - *available* = ``available_`` *name* () +| *available* = ``available_`` *name* () name **** diff --git a/speed/src/link.xrst b/speed/src/link.xrst index b3814f78f..2650a5b5d 100644 --- a/speed/src/link.xrst +++ b/speed/src/link.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-22 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin link_routines} {xrst_spell @@ -12,8 +12,7 @@ Package Specific Speed Test Linking Routines Syntax ****** - - *available* = *link_name* ( *job* , *size* , *repeat* , *other_arguments* ) +| *available* = *link_name* ( *job* , *size* , *repeat* , *other_arguments* ) Purpose ******* diff --git a/speed/src/link_sparse_hessian.cpp b/speed/src/link_sparse_hessian.cpp index aceb886bd..8aab04b98 100644 --- a/speed/src/link_sparse_hessian.cpp +++ b/speed/src/link_sparse_hessian.cpp @@ -1,6 +1,6 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include # include @@ -124,7 +124,7 @@ This function is in the global namespace, not the CppAD namespace. Syntax ****** -``info_spares_hessian`` ( *size* , *n_color* ) +| ``info_spares_hessian`` ( *size* , *n_color* ) size **** diff --git a/speed/src/link_sparse_hessian.hpp b/speed/src/link_sparse_hessian.hpp index 0fbb257b2..daff19bd2 100644 --- a/speed/src/link_sparse_hessian.hpp +++ b/speed/src/link_sparse_hessian.hpp @@ -3,7 +3,7 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include // BEGIN PROTOTYPE @@ -26,7 +26,6 @@ Link to Speed Test Sparse Hessian Syntax ****** - | *ok* = ``link_sparse_hessian`` ( | |tab| |tab| *size* , *repeat* , *row* , *col* , *x* , *hessian* , *n_color* | ) diff --git a/test_more/compare_c/det_by_minor.c b/test_more/compare_c/det_by_minor.c index 6bbd8f1ad..8ff81c353 100644 --- a/test_more/compare_c/det_by_minor.c +++ b/test_more/compare_c/det_by_minor.c @@ -2,7 +2,7 @@ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later // SPDX-FileCopyrightText: Bradley M. Bell -// SPDX-FileContributor: 2003-22 Bradley M. Bell +// SPDX-FileContributor: 2003-24 Bradley M. Bell // ---------------------------------------------------------------------------- # include @@ -28,7 +28,7 @@ Determinant of a Minor Syntax ****** -*d* = ``det_of_minor`` ( *a* , *m* , *n* , *r* , *c* ) +| *d* = ``det_of_minor`` ( *a* , *m* , *n* , *r* , *c* ) Purpose ******* diff --git a/xrst/install/testvector.xrst b/xrst/install/testvector.xrst index 77f4ab19f..cf9b68513 100644 --- a/xrst/install/testvector.xrst +++ b/xrst/install/testvector.xrst @@ -12,7 +12,7 @@ Choosing the CppAD Test Vector Template Class Syntax ****** -``CPPAD_TESTVECTOR`` ( *Scalar* ) *vec* +| ``CPPAD_TESTVECTOR`` ( *Scalar* ) *vec* Example Simple Vector ********************* diff --git a/xrst/reverse/reverse_any.xrst b/xrst/reverse/reverse_any.xrst index b5d4affd1..8152a3dd8 100644 --- a/xrst/reverse/reverse_any.xrst +++ b/xrst/reverse/reverse_any.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin reverse_any} {xrst_spell @@ -12,7 +12,7 @@ Any Order Reverse Mode Syntax ****** -*dw* = *f* . ``Reverse`` ( *q* , *w* ) +| *dw* = *f* . ``Reverse`` ( *q* , *w* ) Purpose ******* diff --git a/xrst/reverse/reverse_one.xrst b/xrst/reverse/reverse_one.xrst index 8ad5a6e40..f9d38b829 100644 --- a/xrst/reverse/reverse_one.xrst +++ b/xrst/reverse/reverse_one.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin reverse_one} {xrst_spell @@ -12,7 +12,7 @@ First Order Reverse Mode Syntax ****** -*dw* = *f* . ``Reverse`` (1, *w* ) +| *dw* = *f* . ``Reverse`` (1, *w* ) Purpose ******* diff --git a/xrst/reverse/reverse_two.xrst b/xrst/reverse/reverse_two.xrst index 3e51c9a07..b8dd8dc71 100644 --- a/xrst/reverse/reverse_two.xrst +++ b/xrst/reverse/reverse_two.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-23 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin reverse_two} {xrst_spell @@ -12,7 +12,7 @@ Second Order Reverse Mode Syntax ****** -*dw* = *f* . ``Reverse`` (2, *w* ) +| *dw* = *f* . ``Reverse`` (2, *w* ) Purpose ******* diff --git a/xrst/thread_alloc.xrst b/xrst/thread_alloc.xrst index 4d330ba54..250c5def7 100644 --- a/xrst/thread_alloc.xrst +++ b/xrst/thread_alloc.xrst @@ -1,6 +1,6 @@ # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later # SPDX-FileCopyrightText: Bradley M. Bell -# SPDX-FileContributor: 2003-22 Bradley M. Bell +# SPDX-FileContributor: 2003-24 Bradley M. Bell # ---------------------------------------------------------------------------- {xrst_begin thread_alloc} @@ -9,7 +9,7 @@ A Fast Multi-Threading Memory Allocator Syntax ****** -``# include `` +| ``# include `` Purpose *******