From 88dfafa579d0189f5c3d2cc9668d4cb1efd062f5 Mon Sep 17 00:00:00 2001
From: Susan Hert <hert@mpi-sb.mpg.de>
Date: Wed, 31 Oct 2001 18:46:58 +0000
Subject: [PATCH] added section on inlining macros

---
 .../basic/Introduction_ref/inlining.tex       | 29 +++++++++++++++++++
 .../basic/Introduction_ref/main.tex           |  1 +
 2 files changed, 30 insertions(+)
 create mode 100644 Packages/Manual/doc_tex_skel/basic/Introduction_ref/inlining.tex

diff --git a/Packages/Manual/doc_tex_skel/basic/Introduction_ref/inlining.tex b/Packages/Manual/doc_tex_skel/basic/Introduction_ref/inlining.tex
new file mode 100644
index 00000000000..2d3a71539d3
--- /dev/null
+++ b/Packages/Manual/doc_tex_skel/basic/Introduction_ref/inlining.tex
@@ -0,0 +1,29 @@
+\section{Compile-time Flags to Control Inlining}
+\ccIndexMainItem{code optimization}
+\ccIndexMainItem{inlining}
+\ccIndexMainItem{\tt inline}
+
+Making funcitons inlined can, at times, improve the efficiency of your code.
+However this is not always the case and it can differ for a single function
+depending on the application in which it is used. Thus \cgal\ defines a set 
+of compile-time macros that can be used to control whether certain functions 
+are designated as inlined functions or not.  The following table lists the 
+macros and their default values, which are set in one of the \cgal\ include
+files.  
+
+\begin{tabular}{l|l}
+               macro name        & default \\ \hline
+\ccc{CGAL_KERNEL_INLINE}         & inline \\
+\ccc{CGAL_KERNEL_MEDIUM_INLINE}  &  \\
+\ccc{CGAL_KERNEL_LARGE_INLINE}   &  \\
+\ccc{CGAL_FRIEND_INLINE}         &  \\
+\ccc{CGAL_MEDIUM_INLINE}         & inline \\
+\ccc{CGAL_LARGE_INLINE}          &  \\
+\ccc{CGAL_HUGE_INLINE}           & 
+\end{tabular}
+
+If you wish to change the value of one or more of these macros,
+you can simply give it a new value when compiling.  For example, to make
+functions that use the macro \ccc{CGAL_KERNEL_MEDIUM_INLINE} inline functions,
+you should set the value of this macro to \texttt{inline} instead of the
+default blank. 
diff --git a/Packages/Manual/doc_tex_skel/basic/Introduction_ref/main.tex b/Packages/Manual/doc_tex_skel/basic/Introduction_ref/main.tex
index ea15e43a376..9e1faf2d664 100644
--- a/Packages/Manual/doc_tex_skel/basic/Introduction_ref/main.tex
+++ b/Packages/Manual/doc_tex_skel/basic/Introduction_ref/main.tex
@@ -16,4 +16,5 @@ include \ccc{CGAL/basic.h} first).
 
 \input{Introduction_ref/checks}
 
+\input{Introduction_ref/inlining}