Prev

Next

Index-> contents reference index search external

Up-> cppad_swig library xam.m4

cppad_swig-> testing swig_xam.i library whats_new_2018

library-> module a_double vector a_fun sparse error xam.m4

xam.m4-> lang_m4 xam_file_name.m4 header.m4 lang_name.m4 omhelp.m4

Headings-> Syntax m4 Command directory language xam_file_name Includes Output

@(@\newcommand{\B}[1]{ {\bf #1} } \newcommand{\R}[1]{ {\rm #1} }@)@Generating Language Specific Example Files Using M4 Macros
Syntax
include(xam.m4)dnl

m4 Command
For this documentation, it is assumed that the m4 command is a follows:
     m4 -I directory -D Language_=language xam_file_name

directory
is the directory where the xam.m4 file is located; i.e., lib/xam relative to the Cppad Swig source directory.

language
is one of the available languages; i.e., cplusplus, octave, perl, or python.

xam_file_name
is the name of one of the *.xam files relative to the lib/xam directory; e.g., vector/ad_xam.xam. This, combined with the language, determines the example / test that is being created.

Includes
Including xam.m4 includes the following macros:

1. lang_m4
2. lang_name.m4
3. xam_file_name.m4
4. header.m4
5. omhelp.m4

Output
There is no output during the include of xam.m4. To be specific, the output is diverted to -1 during the include of xam.m4 and restored to 0 after it. The dnl in the syntax above suppresses the output of the newline at the end of the include of xam.m4.

---

Input File: lib/xam/xam.m4