File: example.xrst

package info (click to toggle)
cppad 2026.00.00.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 11,588 kB
  • sloc: cpp: 112,960; sh: 6,146; ansic: 179; python: 71; sed: 12; makefile: 10
file content (48 lines) | stat: -rw-r--r-- 1,389 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
# SPDX-FileCopyrightText: Bradley M. Bell <bradbell@seanet.com>
# SPDX-FileContributor: 2003-22 Bradley M. Bell
# ----------------------------------------------------------------------------

{xrst_begin Example}

Examples
########

Introduction
************
This section organizes the information related to the CppAD examples.
Each CppAD operation has its own specific example,
for example :ref:`add.cpp-name` is an example for
:ref:`addition<ad_binary-name>` .
Some of the examples are of a more general nature
(not connected of a specific feature of CppAD).
In addition, there are some utility functions that are used
by the examples.

get_started
***********
The :ref:`get_started.cpp-name` example is a good place to start using CppAD.

Running Examples
****************
The
:ref:`installation instructions<Install-name>`
show how the examples can be run on your system.

The CppAD Test Vector Template Class
************************************
Many of the examples use the ``CPPAD_TESTVECTOR`` preprocessor symbol
( see :ref:`testvector-name` )
to determine which :ref:`SimpleVector-name` template class is used with
the examples.

Contents
********
{xrst_toc_table
   example/get_started/get_started.cpp
   xrst/example_list.xrst
   include/cppad/core/testvector.hpp
   include/cppad/wno_conversion.hpp
}

{xrst_end Example}