directory

View page source

Directory Structure

A brief description of each of the CppAD directories is provided below:

Distribution Directory

The following table lists the sub-directories of the Distribution Directory :

bin

Scripts used for CppAD development.

bug

Used to create a simple CppAD bug report or test.

build

Used to build the libraries, examples, and tests.

cmake

cmake macro files.

cppad_ipopt

Example and tests for the deprecated cppad_ipopt library.

cppad_lib

Source code corresponding to the CppAD library.

example

Source code for the CppAD examples.

external

Used to build optional packages; see get_optional.sh

include

The CppAD include directory.

introduction

Source code for the CppAD introduction.

omh

Contains files that are only used for documentation.

pkgconfig

Contains the CppAD pkg-config information.

speed

The CppAD speed tests.

test_more

Tests that are not part of the documentation.

Example Directory

The following table lists the sub-directories of the example directory.

abs_normal

examples using abs_normal representation of non-smooth functions.

atomic_four

Atomic AD Functions: Fourth Generation function examples.

atomic_three

Atomic AD Functions: Third Generation function examples.

atomic_two

Defining Atomic Functions: Second Generation examples not yet converted to use atomic_four .

chkpoint_two

Checkpoint Functions: Second Generation examples

code_gen_fun

Generate Source Code and Compile an AD Function examples

general

general purpose examples.

get_started

a good place to get started using CppAD.

ipopt_solve

Use Ipopt to Solve a Nonlinear Programming Problem examples.

jit

JIT Creation, Compilation, and Linking of C Source Code

json

Json Representation of an AD Graph examples

multi_thread

CppAD multi_threading examples.

optimize

examples using the optimize operation.

print_for

examples that used the PrintFor operation.

sparse

examples using sparsity_patterns and sparse_derivatives .

utility

example using the CppAD utilities .