mirror of https://github.com/CGAL/cgal
Initial version (replaces 'optimisation_misc.aw')
This commit is contained in:
Sven Schönherr
parent
e31456f563
commit
33d474cad0
|
|
@ -0,0 +1,362 @@
|
|||
@! ============================================================================
|
||||
@! The CGAL Library
|
||||
@! Implementation: basic stuff for optimisation algorithms
|
||||
@! ----------------------------------------------------------------------------
|
||||
@! file : web/Optimisation/optimisation_basic.aw
|
||||
@! author: Sven Schönherr <sven@inf.fu-berlin.de>
|
||||
@! ----------------------------------------------------------------------------
|
||||
@! $CGAL_Chapter: Geometric Optimisation $
|
||||
@! $CGAL_Package: Optimisation_basic WIP $
|
||||
@! $Revision$
|
||||
@! $Date$
|
||||
@! ============================================================================
|
||||
|
||||
@documentclass[twoside]{article}
|
||||
@usepackage[latin1]{inputenc}
|
||||
@usepackage{a4wide2}
|
||||
@usepackage{amssymb}
|
||||
@usepackage{cc_manual}
|
||||
@article
|
||||
|
||||
\setlength{\parskip}{1ex}
|
||||
\renewcommand{\ccFont}{\tt}
|
||||
\renewcommand{\ccEndFont}{}
|
||||
|
||||
@! ============================================================================
|
||||
@! Title
|
||||
@! ============================================================================
|
||||
|
||||
\RCSdef{\rcsRevision}{$Revision$}
|
||||
\RCSdefDate{\rcsDate}{$Date$}
|
||||
\newcommand{\cgalWIP}{{\footnotesize{} (\rcsRevision{} , \rcsDate) }}
|
||||
|
||||
@t vskip 5 mm
|
||||
@t title titlefont centre "Basic Stuff for Optimisation Algorithms*"
|
||||
@t vskip 1 mm
|
||||
@t title smalltitlefont centre "Sven Schönherr"
|
||||
\smallskip
|
||||
\begin{center}
|
||||
\begin{tabular}{l}
|
||||
\verb+$CGAL_Chapter: Geometric Optimisation $+ \\
|
||||
\verb+$CGAL_Package: Optimisation_basic WIP+\cgalWIP\verb+$+ \\
|
||||
\end{tabular}
|
||||
\end{center}
|
||||
@t vskip 1 mm
|
||||
|
||||
\renewcommand{\thefootnote}{\fnsymbol{footnote}}
|
||||
\footnotetext[1]{This work was supported by the ESPRIT IV LTR Project
|
||||
No.~21957 (CGAL).}
|
||||
|
||||
@! ============================================================================
|
||||
@! Introduction and Contents
|
||||
@! ============================================================================
|
||||
|
||||
\section*{Introduction}
|
||||
|
||||
We provide macros for assertions, pre- and postconditions and
|
||||
warnings, and a failure function for the checking functions of the
|
||||
optimisation algorithms.
|
||||
|
||||
\tableofcontents
|
||||
|
||||
@! ============================================================================
|
||||
@! Macros
|
||||
@! ============================================================================
|
||||
|
||||
\clearpage
|
||||
\section{Macros}
|
||||
|
||||
The following macros are used to perform several checks. We
|
||||
distinguish four groups of checks, namely checking for assertions, for
|
||||
preconditions, for postconditions and for warnings. Each group
|
||||
consists of macros for normal checks, for exactness checks, for
|
||||
expensive checks, and for expensive exactness checks.
|
||||
|
||||
@! ------
|
||||
@! Checks
|
||||
@! ------
|
||||
|
||||
\subsection{Checks}
|
||||
|
||||
@macro<check macros>(2) many = @begin
|
||||
@<normal checks>(@1,@2)
|
||||
|
||||
@<exactness checks>(@1,@2)
|
||||
|
||||
@<expensive checks>(@1,@2)
|
||||
|
||||
@<expensive exactness checks>(@1,@2)
|
||||
|
||||
@end
|
||||
|
||||
@! Normal Checks
|
||||
\subsubsection*{Normal Checks}
|
||||
|
||||
@macro<normal checks>(2) many = @begin
|
||||
#if ( defined( CGAL_OPTIMISATION_NO_@1) \
|
||||
|| defined( CGAL_NO_@1) || defined( NDEBUG))
|
||||
# define CGAL_optimisation_@2(EX) ((void)0)
|
||||
# define CGAL_optimisation_@2_msg(EX,MSG) ((void)0)
|
||||
# define CGAL_optimisation_@2_code(CODE)
|
||||
#else
|
||||
# define CGAL_optimisation_@2(EX) \
|
||||
((EX)?((void)0):CGAL_@2_fail( # EX , __FILE__, __LINE__, 0))
|
||||
# define CGAL_optimisation_@2_msg(EX,MSG) \
|
||||
((EX)?((void)0):CGAL_@2_fail( # EX , __FILE__, __LINE__, MSG))
|
||||
# define CGAL_optimisation_@2_code(CODE) CODE
|
||||
#endif // optimisation @2s
|
||||
@end
|
||||
|
||||
@! Exactness Checks
|
||||
\subsubsection*{Exactness Checks}
|
||||
|
||||
@macro<exactness checks>(2) many = @begin
|
||||
#if ( ! ( defined( CGAL_OPTIMISATION_CHECK_EXACTNESS) \
|
||||
|| defined( CGAL_CHECK_EXACTNESS) ) \
|
||||
|| defined( CGAL_OPTIMISATION_NO_@1) \
|
||||
|| defined( CGAL_NO_@1) || defined( NDEBUG))
|
||||
# define CGAL_optimisation_exactness_@2(EX) ((void)0)
|
||||
# define CGAL_optimisation_exactness_@2_msg(EX,MSG) ((void)0)
|
||||
# define CGAL_optimisation_exactness_@2_code(CODE)
|
||||
#else
|
||||
# define CGAL_optimisation_exactness_@2(EX) \
|
||||
((EX)?((void)0):CGAL_@2_fail( # EX , __FILE__, __LINE__, 0))
|
||||
# define CGAL_optimisation_exactness_@2_msg(EX,MSG) \
|
||||
((EX)?((void)0):CGAL_@2_fail( # EX , __FILE__, __LINE__, MSG))
|
||||
# define CGAL_optimisation_exactness_@2_code(CODE) CODE
|
||||
#endif // optimisation exactness @2s
|
||||
@end
|
||||
|
||||
@! Expensive Checks
|
||||
\subsubsection*{Expensive Checks}
|
||||
|
||||
@macro<expensive checks>(2) many = @begin
|
||||
#if ( ! ( defined( CGAL_OPTIMISATION_CHECK_EXPENSIVE) \
|
||||
|| defined( CGAL_CHECK_EXPENSIVE) ) \
|
||||
|| defined( CGAL_OPTIMISATION_NO_@1) \
|
||||
|| defined( CGAL_NO_@1) || defined( NDEBUG))
|
||||
# define CGAL_optimisation_expensive_@2(EX) ((void)0)
|
||||
# define CGAL_optimisation_expensive_@2_msg(EX,MSG) ((void)0)
|
||||
# define CGAL_optimisation_expensive_@2_code(CODE)
|
||||
#else
|
||||
# define CGAL_optimisation_expensive_@2(EX) \
|
||||
((EX)?((void)0):CGAL_@2_fail( # EX , __FILE__, __LINE__, 0))
|
||||
# define CGAL_optimisation_expensive_@2_msg(EX,MSG) \
|
||||
((EX)?((void)0):CGAL_@2_fail( # EX , __FILE__, __LINE__, MSG))
|
||||
# define CGAL_optimisation_expensive_@2_code(CODE) CODE
|
||||
#endif // optimisation expensive @2s
|
||||
@end
|
||||
|
||||
@! Expensive Exactness Checks
|
||||
\subsubsection*{Expensive Exactness Checks}
|
||||
|
||||
@macro<expensive exactness checks>(2) many = @begin
|
||||
#if ( ! ( defined( CGAL_OPTIMISATION_CHECK_EXACTNESS) \
|
||||
|| defined( CGAL_OPTIMISATION_CHECK_EXPENSIVE) \
|
||||
|| defined( CGAL_CHECK_EXACTNESS) \
|
||||
|| defined( CGAL_CHECK_EXPENSIVE) ) \
|
||||
|| defined( CGAL_OPTIMISATION_NO_@1) \
|
||||
|| defined( CGAL_NO_@1) || defined( NDEBUG))
|
||||
# define CGAL_optimisation_expensive_exactness_@2(EX) \
|
||||
((void)0)
|
||||
# define CGAL_optimisation_expensive_exactness_@2_msg(EX,MSG) \
|
||||
((void)0)
|
||||
# define CGAL_optimisation_expensive_exactness_@2_code(CODE)
|
||||
#else
|
||||
# define CGAL_optimisation_expensive_exactness_@2(EX) \
|
||||
((EX)?((void)0):CGAL_@2_fail( # EX , __FILE__, __LINE__, 0))
|
||||
# define CGAL_optimisation_expensive_exactness_@2_msg(EX,MSG) \
|
||||
((EX)?((void)0):CGAL_@2_fail( # EX , __FILE__, __LINE__, MSG))
|
||||
# define CGAL_optimisation_expensive_exactness_@2_code(CODE) CODE
|
||||
#endif // optimisation expensive exactness @2s
|
||||
@end
|
||||
|
||||
|
||||
@! ============================================================================
|
||||
@! Functions
|
||||
@! ============================================================================
|
||||
|
||||
\clearpage
|
||||
\section{Functions}
|
||||
|
||||
@! ----------------------------------------------------------------------------
|
||||
@! Function CGAL__optimisation_is_valid_fail
|
||||
@! ----------------------------------------------------------------------------
|
||||
|
||||
\subsection{Function \ccFont CGAL\_\_optimisation\_is\_valid\_fail}
|
||||
|
||||
This function is called from the checking functions of the
|
||||
optimisation algorithms if a check fails. First, we declare the
|
||||
function.
|
||||
|
||||
@macro<Function _optimisation_is_valid_fail declaration> = @begin
|
||||
bool
|
||||
CGAL__optimisation_is_valid_fail( CGAL_Verbose_ostream& verr,
|
||||
const char* message);
|
||||
@end
|
||||
|
||||
The function prints a failure \ccc{message} to the \cgal\ verbose
|
||||
stream \ccc{verr}.
|
||||
|
||||
@macro<Function _optimisation_is_valid_fail> = @begin
|
||||
bool
|
||||
CGAL__optimisation_is_valid_fail( CGAL_Verbose_ostream& verr,
|
||||
const char* message)
|
||||
{
|
||||
verr << "FAILED." << endl;
|
||||
verr << " --> " << message << endl;
|
||||
verr << " object is NOT valid!" << endl;
|
||||
return( false);
|
||||
}
|
||||
@end
|
||||
|
||||
|
||||
@! ==========================================================================
|
||||
@! Files
|
||||
@! ==========================================================================
|
||||
|
||||
\clearpage
|
||||
\section{Files}
|
||||
|
||||
@! ----------------------------------------------------------------------------
|
||||
@! optimisation_assertions.h
|
||||
@! ----------------------------------------------------------------------------
|
||||
|
||||
\subsection{optimisation\_assertions.h}
|
||||
|
||||
@file <include/CGAL/optimisation_assertions.h> = @begin
|
||||
@<file header>(
|
||||
"include/CGAL/optimisation_assertions.h",
|
||||
"assertion macros for optimisation algorithms",
|
||||
"Geert-Jan Giezeman")
|
||||
|
||||
#ifndef CGAL_OPTIMISATION_ASSERTIONS_H
|
||||
#define CGAL_OPTIMISATION_ASSERTIONS_H
|
||||
|
||||
#ifndef CGAL_ASSERTIONS_H
|
||||
# include <CGAL/assertions.h>
|
||||
#endif
|
||||
|
||||
// macro definitions
|
||||
// =================
|
||||
|
||||
// assertions
|
||||
// ----------
|
||||
@<check macros>("ASSERTIONS","assertion")
|
||||
|
||||
// preconditions
|
||||
// -------------
|
||||
@<check macros>("PRECONDITIONS","precondition")
|
||||
|
||||
// postconditions
|
||||
// --------------
|
||||
@<check macros>("POSTCONDITIONS","postcondition")
|
||||
|
||||
// warnings
|
||||
// --------
|
||||
@<check macros>("WARNINGS","warning")
|
||||
|
||||
#endif // CGAL_OPTIMISATION_ASSERTIONS_H
|
||||
|
||||
@<end of file line>
|
||||
@end
|
||||
|
||||
@! ----------------------------------------------------------------------------
|
||||
@! optimisation_basic.h
|
||||
@! ----------------------------------------------------------------------------
|
||||
|
||||
\subsection{optimisation\_basic.h}
|
||||
|
||||
@file <include/CGAL/optimisation_basic.h> = @begin
|
||||
@<file header>(
|
||||
"include/CGAL/optimisation_basic.h",
|
||||
"basic things for optimisation algorithms",
|
||||
"N.N.")
|
||||
|
||||
#ifndef CGAL_OPTIMISATION_BASIC_H
|
||||
#define CGAL_OPTIMISATION_BASIC_H
|
||||
|
||||
// Function declarations
|
||||
// =====================
|
||||
|
||||
// is_valid failure function
|
||||
// -------------------------
|
||||
#ifndef CGAL_IO_VERBOSE_OSTREAM_H
|
||||
# include <CGAL/IO/Verbose_ostream.h>
|
||||
#endif
|
||||
|
||||
@<Function _optimisation_is_valid_fail declaration>
|
||||
|
||||
#endif // CGAL_OPTIMISATION_BASIC_H
|
||||
|
||||
@<end of file line>
|
||||
@end
|
||||
|
||||
@! ----------------------------------------------------------------------------
|
||||
@! optimisation_basic.C
|
||||
@! ----------------------------------------------------------------------------
|
||||
|
||||
\subsection{optimisation\_basic.C}
|
||||
|
||||
@file <src/optimisation_basic.C> = @begin
|
||||
@<file header>(
|
||||
"src/optimisation_basic.C",
|
||||
"basic things for optimisation algorithms",
|
||||
"N.N.")
|
||||
|
||||
#include <CGAL/basic.h>
|
||||
#include <CGAL/optimisation_basic.h>
|
||||
|
||||
// Function implementations
|
||||
// ========================
|
||||
|
||||
// is_valid failure function
|
||||
// -------------------------
|
||||
@<Function _optimisation_is_valid_fail>
|
||||
|
||||
@<end of file line>
|
||||
@end
|
||||
|
||||
@! ----------------------------------------------------------------------------
|
||||
@! optimisation_Window_stream.h
|
||||
@! ----------------------------------------------------------------------------
|
||||
|
||||
\subsection{optimisation\_Window\_stream.h}
|
||||
|
||||
@file <include/CGAL/IO/optimisation_Window_stream.h> = @begin
|
||||
@<file header>(
|
||||
"include/CGAL/IO/optimisation_Window_stream.h",
|
||||
"graphical output to `leda_window' for optimisation algorith.",
|
||||
"Bernd Gärtner")
|
||||
|
||||
#include <CGAL/IO/Min_circle_2_Window_stream.h>
|
||||
#include <CGAL/IO/Min_ellipse_2_Window_stream.h>
|
||||
|
||||
@<end of file line>
|
||||
@end
|
||||
|
||||
@! ----------------------------------------------------------------------------
|
||||
@! File Header
|
||||
@! ----------------------------------------------------------------------------
|
||||
|
||||
\subsection*{File Header}
|
||||
|
||||
@i ../file_header.awi
|
||||
|
||||
And here comes the specific file header for the product files of this
|
||||
web file.
|
||||
|
||||
@macro <file header>(3) many = @begin
|
||||
@<copyright notice>
|
||||
@<file name>(@1)
|
||||
@<file description>(
|
||||
"Geometric Optimisation",
|
||||
"Optimisation_basic","Optimisation/optimisation_basic",
|
||||
"$Revision$","$Date$",
|
||||
"Sven Schönherr <sven@@inf.fu-berlin.de>",
|
||||
"@3",
|
||||
"ETH Zürich (Bernd Gärtner <gaertner@@inf.ethz.ch>)",
|
||||
"@2")
|
||||
@end
|
||||
|
||||
@! ===== EOF ==================================================================
|
||||
Loading…
Reference in New Issue