Mercurial > hg > truffle
changeset 2892:5005a5607506
Moved design doc to graal project directory.
| author | Thomas Wuerthinger <thomas@wuerthinger.net> |
|---|---|
| date | Wed, 08 Jun 2011 14:06:17 +0200 |
| parents | 75a99b4f1c98 |
| children | 5410e7a2873b |
| files | doc/Goals.odt doc/IR.odt doc/IR.pdf doc/design/.project doc/design/.texlipse doc/design/graal_compiler.pdf doc/design/graal_compiler.tex doc/design/graph_test.pdf doc/design/graph_test.tex doc/design/graphdrawing.tex doc/design/svglov3.clo doc/design/svjour3.cls doc/graal.doxy graal/com.oracle.max.graal.doc.initial/.project graal/com.oracle.max.graal.doc.initial/.texlipse graal/com.oracle.max.graal.doc.initial/graal_compiler.pdf graal/com.oracle.max.graal.doc.initial/graal_compiler.tex graal/com.oracle.max.graal.doc.initial/graph_test.pdf graal/com.oracle.max.graal.doc.initial/graph_test.tex graal/com.oracle.max.graal.doc.initial/graphdrawing.tex graal/com.oracle.max.graal.doc.initial/svglov3.clo graal/com.oracle.max.graal.doc.initial/svjour3.cls |
| diffstat | 22 files changed, 2684 insertions(+), 4345 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/design/.project Wed Jun 08 14:01:51 2011 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,24 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<projectDescription> - <name>GraalDocDesign</name> - <comment></comment> - <projects> - </projects> - <buildSpec> - <buildCommand> - <name>net.sourceforge.texlipse.builder.TexlipseBuilder</name> - <arguments> - </arguments> - </buildCommand> - </buildSpec> - <natures> - <nature>net.sourceforge.texlipse.builder.TexlipseNature</nature> - </natures> - <linkedResources> - <link> - <name>fleqn.clo</name> - <type>1</type> - <location>C:/Program Files (x86)/MiKTeX 2.8/tex/latex/base/fleqn.clo</location> - </link> - </linkedResources> -</projectDescription>
--- a/doc/design/.texlipse Wed Jun 08 14:01:51 2011 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,13 +0,0 @@ -#TeXlipse project settings -#Fri Apr 29 14:13:11 CEST 2011 -builderNum=2 -outputDir= -makeIndSty= -bibrefDir= -outputFormat=pdf -tempDir=tmp -mainTexFile=graal_compiler.tex -outputFile=graal_compiler.pdf -langSpell=en -markDer=true -srcDir=
--- a/doc/design/graal_compiler.tex Wed Jun 08 14:01:51 2011 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,846 +0,0 @@ -\documentclass[twocolumn]{svjour3} -\usepackage{listings} -\usepackage[pdftex]{graphicx} -\usepackage{environ} -\usepackage{amsmath} -\usepackage{amsfonts} -\usepackage[english]{babel} -\usepackage[utf8]{inputenc} -\usepackage{lmodern} -\usepackage[T1]{fontenc} -\usepackage{color} - -\input{graphdrawing} - -\renewcommand*\descriptionlabel[1]{\hspace\labelsep\normalfont\bf #1} - -\newcommand{\Sa}{{\Large$^*$}} -\newcommand{\Sb}{{\Large$^\dag$}} -\newcommand{\Sc}{{\Large$^\S$}} - - -\newcommand{\mynote}[2]{ -\textcolor{red}{\fbox{\bfseries\sffamily\scriptsize#1} - {\small\textsf{\emph{#2}}} -\fbox{\bfseries\sffamily\scriptsize }}} - -\newcommand\TODO[1]{\mynote{TODO}{#1}} -\newcommand\cw[1]{\mynote{CW}{#1}} -\newcommand\ls[1]{\mynote{LS}{#1}} -\newcommand\nodename[1]{\texttt{#1}} - - - -\smartqed % flush right qed marks, e.g. at end of proof - -\journalname{Graal Compiler Design} -\def\makeheadbox{{% -\hbox to0pt{\vbox{\baselineskip=10dd\hrule\hbox -to\hsize{\vrule\kern3pt\vbox{\kern3pt -\hbox{\bfseries The Graal Compiler - Design and Strategy} -\kern3pt}\hfil\kern3pt\vrule}\hrule}% -\hss}}} - -\begin{document} - -\author{Thomas W\"{u}rthinger \Sa, Lukas Stadler \Sc, Gilles Duboscq \Sa} -\institute{\Sa Oracle, \Sc Johannes Kepler University, Linz} - -\date{Created: \today} - -\title{The Graal Compiler} -\subtitle{Design and Strategy \\ \textcolor{red}{work in progress (Oracle internal)}} - -\maketitle - -\abstract{ -The Graal compiler (simply referred to as \emph{the compiler} in the rest of this document) aims at improving upon C1X, the Java port of the HotSpot client compiler, both in terms of modularity and peak performance. -The compiler should work with the Maxine VM and the HotSpot VM. -This document contains information about the proposed design and strategy for developing the compiler.} - -\section{Context} - -In 2009, the Maxine team started with creating C1X, a Java port of the HotSpot client compiler, and integrated it into the Maxine VM. -Part of this effort was the development of a clear and clean compiler-runtime interface that allows the separation of the compiler and the VM. -This compiler-runtime interface enables the use of one compiler for multiple VMs. -In June 2010, we started integrating C1X into the HotSpot VM and we called the resulting system Graal~VM. -Currently, the Graal~VM is fully functional and runs benchmarks (SciMark, DaCapo) at a similar speed as the HotSpot client compiler. - -\section{Goals} -The compiler effort aims at rewriting the high-level intermediate representation of C1X with two main goals: -\begin{description} -\item[Modularity:] A modular design of the compiler should simplify the implementation of new languages, new back-ends, and new optimizations. -\item[Peak Performance:] A more powerful intermediate representation should enable the implementation of aggressive optimizations that impact the peak performance of the resulting machine code. -\end{description} - -\section{Design} -For the implementation of the compiler, we rely on the following design decisions: -\begin{description} -\item[Graph Representation:] -The compiler's intermediate representation is modeled as a graph with nodes that are connected with directed edges. -There is only a single node base class and every node has an associated graph object that does not change during the node's lifetime. -Every node is serializable and has an id that is unique within its graph. -Every edge is classified as either a control flow edge (anti-dependency) or a data flow edge (dependency) and represented as a simple pointer from the source node to the target node. -It is possible to replace a node with another node without traversing the full graph. -The graph does not allow data flow edge cycles or control flow edge cycles. -We achieve this by explicitly modeling loops (see Section~\ref{sec:loops}). -\item[Extensibility:] -The compiler is extensible by allowing developers to add new compiler phases and new node subclasses without modifying the compiler's sources. -A node has an abstract way of expressing its semantics and new compiler phases can ask compiler nodes for their properties and capabilities. -We use the ``everything is an extension'' concept. -Even standard compiler optimizations are internally modeled as extensions, to show that the extension mechanism exposes all necessary functionality. -\item[Detailing:] -The compilation starts with a graph that contains nodes that represent the operations of the source language (e.g., one node for an array store to an object array). -During the compilation, the nodes are replaced with more detailed nodes (e.g., the array store node is split into a null check, a bounds check, a store check, and a memory access). -Compiler phases can choose whether they want to work on the earlier versions of the graph (e.g., escape analysis) or on later versions (e.g., null check elimination). -\item[Generality:] -The compiler does not require Java as its input. -This is achieved by having a graph as the starting point of the compilation and not a Java bytecode array. -Building the graph from the Java bytecodes must happen before giving a method to the compiler. -This enables front-ends for different languages (e.g., Ruby or JavaScript) to provide their own graph. -Also, there is no dependency on a specific back-end, but the output of the compiler is a graph that can then be converted to a different representation in a final compiler phase. -\end{description} - -\section{Milestones} -\label{sec:mile} -The compiler is being developed starting from the current C1X source code base. -This helps us test the compiler at every intermediate development step on a variety of Java benchmarks. -We define the following development milestones (see Section~\ref{sec:conclusions} for planned dates): -\begin{description} -\item[M1:] We have a fully working Graal~VM version with a stripped down C1X compiler that does not perform any optimization. -\item[M2:] We modified the high-level intermediate representation to be based on the compiler graph data structure. -\item[M3:] We have reimplemented and reenabled compiler optimizations in the compiler that previously existed in C1X. -\item[M4:] We have reintegrated the new compiler into the Maxine VM and can use it as a Maxine VM bootstrapping compiler. -\end{description} - -After those four milestones, we see three different possible further development directions that can be followed in parallel: -\begin{itemize} - \item Removal of the XIR template mechanism and replacement with a snippet mechanism that works with the compiler graph. - \item Improvements for peak performance (loop optimizations, escape analysis, bounds check elimination, processing additional interpreter runtime feedback). - \item Implementation of a prototype front-end for a different language, e.g., JavaScript. -\end{itemize} - -\section{Project Source Structure} -In order to support the goal of a modular compiler, the code will be divided into the following source code projects (as subprojects of \textbf{com.oracle.max.graal}). - -\begin{description} - \item[graph] contains the abstract node implementation, the graph implementation and all the associated tools and auxiliary classes. - \item[nodes] contains the implementation of known basic nodes (e.g., phi nodes, control flow nodes, \ldots). - Additional node classes should go into separate projects and be specializations of the known basic nodes. - \item[java] contains code for building graphs from Java bytecodes and Java-specific nodes. - \item[opt] contains optimizations such as global value numbering or conditional constant propagation. - \item[compiler] contains the compiler, including: - \begin{itemize} - \item Scheduling of the compilation phases. - \item Implementation of the \emph{compiler interface} (CI). - \item Implementation of the final compilation phase that produces the low-level representation. - \item Machine code creation, including debug info. - \end{itemize} -\end{description} - - -\section{Graph} - -The \emph{intermediate representation}~(IR) of the compiler is designed as a directed graph. -The graph allocates unique ids for new nodes and can be queried for the node corresponding to a given id as well as for an unordered list of nodes of the graph. -Graphs can manage side data structures (e.g. dominator trees and temporary schedules), which will be automatically invalidated and lazily recomputed whenever the graph changes. These side data structures will usually be understood by more than one optimization. - -The nodes of the graph have the following properties: -\begin{itemize} - \item Each node is always associated with a single graph and this association is immutable. - \item Each node has an immutable id that is unique within its associated graph. - \item Nodes can have a data dependency, which means that one node requires the result of another node as its input. The fact that the result of the first node needs to be computed before the second node can be executed introduces a partial order to the set of nodes. - \item Nodes can have a control flow dependency, which means that the execution of one node will be followed by the execution of another node. This includes conditional execution, memory access serialization and other reasons, and again introduces a partial order to the set of nodes. - \item Nodes can only have data and control dependencies to nodes which belong to the same graph. - \item Control dependencies and data dependencies each represent a \emph{directed acyclic graph} (DAG) on the same set of nodes. This means that data dependencies always point upwards, and control dependencies always point downwards in a drawing of the graph. Situations that normally incur cycles (like loops) are represented by special nodes (see Section~\ref{sec:loops}). - \item Ordering between nodes is specified only to the extent which is required to correctly express the semantics of a given program. This gives the compiler flexibility for the possible scheduling of a node and therefore wiggle room for optimizations. For algorithms that require a fixed ordering of nodes, a temporary schedule can always be generated. - \item Both data and control dependencies can be traversed in both directions, so that each node can be traversed in four directions (see Figure~\ref{fig:directions}): - \begin{itemize} - \item \emph{inputs} are all nodes that this node has data dependencies on. - \item \emph{usages} are all nodes whose inputs contain this node. - \item \emph{successors} are all nodes that have to be after this node in control flow. - \item \emph{predecessors} are all nodes whose successors contain this node. - \end{itemize} - \item Only inputs and successors can be changed, and changes to them will update the usages and predecessors. - \item Every node must be able to support cloning and serialization. - \item The edges of a node also define \textit{happens-before} and \textit{happens-after} relationships as shown in Figure~\ref{fig:directions}. -\end{itemize} - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{graphdirections} -\node{node1}{Node} -\textnode{inputs}{inputs} -\textnode{usages}{usages} -\textnode{successors}{successors} -\textnode{predecessors}{predecessors} -\data{node1}{inputs} -\control{node1}{successors} -\data{usages}{node1} -\control{predecessors}{node1} -\node{node2}{Node} -\textnode{before}{happens-before} -\textnode{after}{happens-after} -\data{node2}{before} -\control{node2}{after} -\data{after}{node2} -\control{before}{node2} -\end{digraphenv} - \caption{A node and its edges.} - \label{fig:directions} -\end{figure} - -\subsection{Inlining} -Inlining is always performed by embedding one graph into another graph. -Nodes cannot be reassigned to another graph, they are cloned instead. -Therefore, inlining is performed by copying and rewiring the nodes of the inlined method into the graph of the outer method. -While the copying will decrease compilation performance, it enables us to cache the graph for the inlined method, optimize it independently from the outer method, and use the optimized graph for subsequent inlinings. -We do not expect a significant negative impact on overall compilation performance. - -We are able to perform the inlining at any point during the compilation of a method and can therefore selectively expand the inlining if a certain optimization turns out to depend on the inlining of a method. -An example for this would be when the escape analysis finds out that a certain object only escapes because of one method call and this method call is not inlined, because the penalty was to high. -In this case, we can chose to nevertheless inline the method in order to increase the chances for finding out that the object does not escape. - -\section{Control Flow} - -Control flow is managed in way where the predecessor node contains direct pointers to its successor nodes. -We reserve the term \textit{instruction} for nodes that are embedded in the control flow. -This is opposite to the approach taken in the server compiler, where control flow and data flow edges point in the same direction. -The advantage that we see in our approach is that there is no need for projection nodes in case of control flow splits. -An \texttt{If} instruction can directly point to its true and false successors without any intermediate nodes. -This makes the graph more compact and simplifies graph traversal. - -Listing~\ref{lst:cfg2} shows an example Java program with an if statement where both paths do not contain any instruction with side effects. -The \texttt{If} instruction can directly point its true and false successors to a \texttt{Merge} instruction. -A \texttt{Phi} node that selects the appropriate value is appended to the \texttt{Merge} instruction. -The \texttt{Return} instruction then has a data dependency on the \texttt{Phi} node. - -\begin{lstlisting}[label=lst:cfg2, caption=Control flow in the graph., captionpos=b] -if (condition) { return 0; } -else { return 1; } -\end{lstlisting} - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{cfg2} -\textnode{entry}{Entry} -\textnode{condition}{condition} -\textnode{const0}{0} -\textnode{const1}{1} -\nodesplit{if}{If} -\control{entry}{if} -\controllabel{if:succ1}{merge} -\controllabel{if:succ2}{merge} -\data{if}{condition} -\node{merge}{Merge} -\node{return}{Return} -\nodetri{phi}{Phi} -\datalabel{phi:in1}{merge} -\datalabel{phi:in2}{const0} -\datalabel{phi:in3}{const1} -\data{return}{phi} -\control{merge}{return} -\end{digraphenv} - \caption{A simple loop with two exits.} - \label{fig:exc1} -\end{figure} - -\section{Exceptions} -\label{sec:Exceptions} - -We do not throw runtime exceptions (e.g., \texttt{IndexOutOf\-BoundsException}, \texttt{NullPointerException}, or \texttt{Out\-Of\-MemoryException}), but deoptimize instead. -This reduces the places in the compiled code where an exact bytecode location and debug information must be known. -Additionally, this greatly reduces the number of exception handler edges in the compiled code. -The main advantage of this technique is however, that we are free in moving around bounds checks, memory allocation, memory accesses with implicit null checks, etc. - -There are only two kinds of instruction that need explicit exception edges, because they are the only instructions that can throw exceptions in compiled code: \texttt{Throw} instructions and \texttt{Invoke} instructions. -They are modelled as instructions with an additional control flow continuation that points to an \texttt{ExceptionDispatch} instruction. -The exception dispatch instruction decides based on the type of the exception object whether the control should flow to the catch handler or to another exception dispatch. -If there is no catch handler in the currently compiled method, then the control flows into the \texttt{Unwind} instruction that handles the exception by forwarding it to the caller. -Listing~\ref{lst:exc1} shows an example Java program with nested try blocks and Figure \ref{fig:exc1} shows the corresponding compiler graph. - -\begin{lstlisting}[label=lst:exc1, caption=Exception dispatch in the compiler graph., captionpos=b] -try { m1(); - try { m2(); - } catch(ExtendedException e) { ... } - m3(); - throw exception; -} catch(Exception e) { ... } -\end{lstlisting} - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{exc1} -\textnode{entry}{Entry} -\textnode{catch1}{catch1} -\textnode{catch2}{catch2} -\nodesplit{m1}{Invoke m1} -\nodesplit{m2}{Invoke m2} -\nodesplit{m3}{Invoke m3} -\nodesplit{dispatch1}{ExceptionDispatch} -\nodesplit{dispatch2}{ExceptionDispatch} -\node{throw}{Throw} -\node{unwind}{Unwind} -\control{entry}{m1} -\controllabel{m1:succ1}{m2} -\controllabel{m1:succ2}{dispatch2} -\controllabel{m2:succ1}{m3} -\controllabel{m2:succ2}{dispatch1} -\controllabel{m3:succ1}{throw} -\controllabel{m3:succ2}{dispatch2} -\control{throw}{dispatch2} -\controllabel{dispatch1:succ2}{catch1} -\controllabel{dispatch1:succ1}{dispatch2} -\controllabel{dispatch2:succ2}{catch2} -\controllabel{dispatch2:succ1}{unwind} -\end{digraphenv} - \caption{A simple loop with two exits.} - \label{fig:exc1} -\end{figure} - -\section{Loops} -\label{sec:loops} -Loops form a first-class construct in the IR that is expressed by specialized IR nodes during all optimization phases. -We only compile methods with a control flow where every loop has a single entry point. -This entry point is a \nodename{LoopBegin} instruction. -This instruction is connected to a \nodename{LoopEnd} instruction that merges all control flow paths that do not exit the loop. -The edge between the \nodename{LoopBegin} and the \nodename{LoopEnd} is the backedge of the loop. -It goes from the beginning to the end in order to make the graph acyclic. -An algorithm that traverses the control flow has to explicitely decide whether it wants to incorporate backedges (i.e., special case of the treatment of \nodename{LoopEnd}) or ignore them. -Figure \ref{fig:loop1} shows a simple example with a loop with a single entry and two exits. - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{layout1} -\textnode{BeforeLoop}{Loop entry} -\textnode{Exit1}{First loop exit} -\textnode{Exit2}{Second loop exit} -\nodesplit{LoopBegin}{LoopBegin} -\node{LoopEnd}{LoopEnd} -\nodesplit{If1}{If} -\nodesplit{If2}{If} -\controllabel{LoopBegin:succ1}{LoopEnd} -\controllabel{LoopBegin:succ2}{If1} -\controllabel{If1:succ1}{If2} -\controllabel{If2:succ1}{LoopEnd} -\controllabel{BeforeLoop}{LoopBegin} -\controllabel{If1:succ2}{Exit1} -\controllabel{If2:succ2}{Exit2} -\end{digraphenv} - \caption{A simple loop with two exits.} - \label{fig:loop1} -\end{figure} - -\subsection{Loop Phis} -Data flow in loops is modeled with special phi nodes at the beginning and the end of the loop. -The \nodename{LoopEnd} instruction merges every value that flows into the next loop iteration in associated \nodename{LoopEndPhi} nodes. -A corresponding \nodename{LoopBeginPhi} node that is associated with the loop header has a control flow dependency on the \nodename{LoopEndPhi} node. -Listing~\ref{lst:loop} shows a simple counting loop that is used as an example in the rest of this section. -Figure~\ref{fig:loop2} shows how the loop is modelled immediately after building the graph. - -\begin{lstlisting}[label=lst:loop, caption=Loop example that counts from 0 to n-1., captionpos=b] -for(int i=0; i<n; ++i) { } -\end{lstlisting} - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{layout2} -\textnode{BeforeLoop}{Loop entry} -\textnode{Exit}{Loop exit} -\textnode{n}{n} -\textnode{Constant0}{0} -\textnode{Constant1}{1} -\nodesplit{LoopBegin}{LoopBegin} -\node{LoopEnd}{LoopEnd} -\nodesplit{If1}{If} -\controllabel{LoopBegin:succ1}{LoopEnd} -\controllabel{LoopBegin:succ2}{If1} -\nodebi{Compare}{<} -\nodebi{LoopBeginPhi}{LoopBeginPhi} -\nodebi{Add}{+} -\datalabel{Add:in1}{LoopBeginPhi} -\datalabel{Add:in2}{Constant1} -\nodebi{LoopEndPhi}{LoopEndPhi} -\control{LoopBeginPhi}{LoopEndPhi} -\data{LoopEndPhi:in1}{LoopEnd} -\data{LoopEndPhi:in2}{Add} -\datalabel{LoopBeginPhi:in1}{LoopBegin} -\datalabel{LoopBeginPhi:in2}{Constant0} -\datalabel{Compare:in1}{LoopBeginPhi} -\datalabel{Compare:in2}{n} -\data{If1}{Compare} -\controllabel{If1:succ1}{LoopEnd} -\controllabel{BeforeLoop}{LoopBegin} -\controllabel{If1:succ2}{Exit} -\end{digraphenv} - \caption{Graph for a loop counting from 0 to n-1.} - \label{fig:loop2} -\end{figure} - -\subsection{Loop Counters} -The compiler is capable of recognizing variables that are only increased within a loop. -A potential overflow of such a variable is prohibited with a guard before the loop (this is not necessary in this example, because the loop variable cannot overflow). -Figure \ref{fig:loop3} shows the compiler graph of the example loop after the loop counter transformation. - - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{layout3} -\textnode{BeforeLoop}{Loop entry} -\textnode{Exit}{Loop exit} -\textnode{n}{n} -\textnode{Constant0}{0} -\textnode{Constant1}{1} -\nodesplit{LoopBegin}{LoopBegin} -\node{LoopEnd}{LoopEnd} -\nodesplit{If1}{If} -\controllabel{LoopBegin:succ1}{LoopEnd} -\controllabel{LoopBegin:succ2}{If1} -\nodebi{Compare}{<} -\nodetri{LoopCounter}{LoopCounter} -\datalabel{LoopCounter:in1}{LoopBegin} -\datalabeltext{LoopCounter:in2}{Constant0}{init} -\datalabeltext{LoopCounter:in3}{Constant1}{stride} -\datalabel{Compare:in1}{LoopCounter} -\datalabel{Compare:in2}{n} -\data{If1}{Compare} -\controllabel{If1:succ1}{LoopEnd} -\controllabel{BeforeLoop}{LoopBegin} -\controllabel{If1:succ2}{Exit} -\end{digraphenv} - \caption{Graph after loop counter transformation.} - \label{fig:loop3} -\end{figure} - -\subsection{Bounded Loops} - -If the total maximum number of iterations of a loop is fixed, then the loop is converted into a bounded loop. -The total number of iterations always denotes the number of full iterations of the loop with the control flowing from the loop begin to the loop end. -If the total number of iterations is reached, the loop is exited directly from the loop header. -In the example, we can infer from the loop exit with the comparison on the loop counter that the total number of iterations of the loop is limited to n. -Figure \ref{fig:loop4} shows the compiler graph of the example loop after the bounded loop transformation. - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{layout4} -\textnode{BeforeLoop}{Loop entry} -\textnode{Exit}{Loop exit} -\textnode{n}{n} -\textnode{Constant0}{0} -\textnode{Constant1}{1} -\nodesplittri{LoopBegin}{BoundedLoopBegin} -\node{LoopEnd}{LoopEnd} -\controllabel{LoopBegin:succ1}{LoopEnd} -\controllabel{LoopBegin:succ2}{LoopEnd} -\controllabel{LoopBegin:succ3}{Exit} -\nodetri{LoopCounter}{LoopCounter} -\datalabel{LoopCounter:in1}{LoopBegin} -\datalabeltext{LoopCounter:in2}{Constant0}{init} -\datalabeltext{LoopCounter:in3}{Constant1}{stride} -\data{LoopBegin}{n} -\controllabel{BeforeLoop}{LoopBegin} -\end{digraphenv} - \caption{Graph after bounded loop transformation.} - \label{fig:loop4} -\end{figure} - -\subsection{Vectorization} - -If we have now a bounded loop with no additional loop exit and no associated phi nodes (only associated loop counters), we can vectorize the loop. -We replace the loop header with a normal instruction that produces a vector of values from 0 to the number of loop iterations minus 1. -The loop counters are replaced with \texttt{VectorAdd} and \texttt{VectorMul} nodes. -The vectorization is only possible if every node of the loop can be replaced with a corresponding vector node. -Figure \ref{fig:loop5} shows the compiler graph of the example loop after vectorization. -The vector nodes all work on an ordered list of integer values and are subject to canonicalization and global value numbering like any other node. - - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{layout5} -\textnode{Entry}{Entry} -\textnode{Exit}{Exit} -\textnode{n}{n} -\textnode{Constant0}{0} -\textnode{Constant1}{1} -\node{Vector}{Vector} -\nodebi{VectorAdd}{VectorAdd} -\nodebi{VectorMul}{VectorMul} -\control{Entry}{Vector} -\control{Vector}{Exit} -\datalabel{VectorAdd:in1}{Vector} -\datalabel{VectorAdd:in2}{Constant0} -\datalabel{VectorMul:in1}{VectorAdd} -\datalabel{VectorMul:in2}{Constant1} -\data{Vector}{n} -\end{digraphenv} - \caption{Graph after vectorization.} - \label{fig:loop5} -\end{figure} - - -\section{Frame States} -A frame state captures the state of the program like it is seen in by an interpreter of the program. -The frame state contains the information that is local to the current activation and will therefore disappear during SSA-form constructions or other compiler optimizations. -For Java, the frame state is defined in terms of the Java bytecode specification (i.e., the values of the local variables, the operand stack, and the locked monitors). -However, a frame state is not a concept specific to Java (e.g., the Crankshaft JavaScript engine uses frame states in their optimizing compiler to model the values of the AST interpreter). - -Frame states are necessary to support the deoptimization of the program, which is the precondition for performing aggressive optimizations that use optimistic assumptions. -Therefore every point in the optimizing compiler that may revert execution back to the interpreter needs a valid frame state. -However, the point where the interpreter continues execution need not correspond exactly to the execution position of the compiled code, because many Java bytecode instructions can be safely reexecuted. -Thus, frame states need only be generated for the states after instructions that cannot be reexecuted, because they modify the state of the program. -Examples for such instructions are: - -\begin{itemize} - \item Array stores (in Java bytecodes {\tt IASTORE, LASTORE, FASTORE, \\DASTORE, AASTORE, BASTORE, CASTORE, SASTORE}) - \item Field stores (in Java bytecodes {\tt PUTSTATIC, PUTFIELD}) - \item Method calls (in Java bytecodes {\tt INVOKEVIRTUAL, INVOKESPECIAL, \\INVOKESTATIC, INVOKEINTERFACE}) - \item Synchronization (in Java bytecodes {\tt MONITORENTER, MONITOREXIT}) -\end{itemize} - -Within the graph a frame state is represented as a node that is attached to the instruction that caused it to be generated using a control dependency (see Figure~\ref{fig:fs1}). -Frame states also have data dependencies on the contents of the state: the local variables and the expression stack. - -The frame state at the method beginning does not have to be explicitely in the graph, because it can always be reconstructed at a later stage. -We save the frame state at control flow merges if there is at least one frame state on any control flow path between a node and its immediate dominator. - - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{fs1} - \nodetrisplit{store1}{ArrayStore} - \nodebi{load1}{ArrayLoad} - \controllabel{store1:succ1}{load1} - \nodetrisplit{store2}{FieldStore} - \control{load1}{store2} - end [shape=plaintext, label="...", width="2.0"] - store2:succ1:s -> end:n [color=red]; - % - \nodeframestate{fs1}{FrameState} - \controllabel{store1:succ2}{fs1} - \nodeframestate{fs2}{FrameState} - \controllabel{store2:succ2}{fs2} -\end{digraphenv} - \caption{Simple example using two frame states.} - \label{fig:fs1} -\end{figure} - - -A deoptimization node needs a valid frame state that specifies the location and state where the interpreter should continue. -The algorithm for constructing frame states makes sure that every possible location in the graph has a well-defined frame state that can be used by a deoptimization instruction. -Therefore, there are no direct links between the deoptimization instruction and its frame state thus allowing the deoptimization instructions to move freely around. - -\subsection{Partial Escape Analysis} - -A partial escape analysis can help to further reduce the number of frame states. -A field or array store does not create a new frame state, when the object that is modified did not have a chance to escape between its creation and the store. - -Listing~\ref{lst:escape1} shows an example of a method that creates two \texttt{Point} objects, connects them, and returns them. -The object allocation of the first \texttt{Point} object does not need a frame state. -We can always reexecute the \texttt{NEW} bytecode again in the interpreter. -The \texttt{Point} object allocated by the compiler will then simply disappear after the next garbage collection. -The following field store is a thread-local memory store, because the \texttt{Point} object did not have any chance to escape. -Same applies to the assignment of the \texttt{next} field and the third field assignment. -Therefore, the whole method \texttt{getPoint} does not need an explicit frame state, because at any time during execution of this method, we can deoptimize and continue execution in the interpreter at the first bytecode of the method. - -\begin{lstlisting}[label=lst:escape1, caption=Example method that needs no frame state., captionpos=b] -void getPoint() { - Point p = new Point(); - p.x = 1; - p.next = new Point(); - p.next.x = 2; - return p; -} -\end{lstlisting} - -The reduction of frame states makes it easier for the compiler to perform memory optimizations like memory access coalescing. -We believe that this reduction on frame states is the key to effective vectorization and other compiler optimizations where compilers of compilers of unmanaged languages have advantages. - -\subsection{Guards} -A guard is a node that deoptimizes based on a conditional expression. -Guards are not attached to a certain frame state, they can move around freely and will always use the correct frame state when the nodes are scheduled (i.e., the last emitted frame state). -The node that is guarded by the deoptimization has a data dependency on the guard and the guard in turn has a data dependency on the condition. -A guard must not be moved above any \texttt{If} nodes. -Therefore, we use \texttt{Anchor} instructions after a control flow split and a data dependency from the guard to this anchor. -The anchor is the most distant instruction that is postdominated by the guarded instruction and the guard can be scheduled anywhere between those two nodes. -This ensures maximum flexibility for the guard instruction and guarantees that we only deoptimize if the control flow would have reached the guarded instruction (without taking exceptions into account). - -To illustrate the strengths of this approach, we show the graph for the Java code snippet shown in \ref{lst:guard1}. -The example looks artificial, but in case of method inlining, this is a pattern that is not unlikely to be present in a normal Java program. -Figure \ref{fig:guard0} shows the compiler graph for the example method after graph building. -The field stores are both represented by a single instruction and the null check that is implicitely incorporated in the field store. - -\begin{lstlisting}[label=lst:guard1, caption=Example method that demonstrates the strengths of modelling the guards explicitely., captionpos=b] -void init(Point p) { - if (p != null) { - p.x = 0; - } - p.y = 0; -} -\end{lstlisting} - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{guard0} - \textnode{entry}{Entry} - \nodesplit{if}{If} - \node{merge}{Merge} - \node{return}{Return} - \node{cmpnull}{NonNull} - \textnode{p}{p} - \textnode{const0}{0} - \nodebisplit{store1}{FieldStore x} - \nodebisplit{store2}{FieldStore y} - \nodeframestate{fs1}{FrameState} - \nodeframestate{fs2}{FrameState} - \datalabel{store1:in1}{p} - \datalabel{store2:in1}{p} - \datalabel{store1:in2}{const0} - \datalabel{store2:in2}{const0} - \control{entry}{if} - \data{if}{cmpnull} - \controllabel{if:succ1}{merge} - \controllabel{if:succ2}{store1} - \controllabel{store1:succ1}{merge} - \controllabel{store1:succ2}{fs1} - \control{merge}{store2} - \controllabel{store2:succ1}{return} - \controllabel{store2:succ2}{fs2} - \data{cmpnull}{p} -\end{digraphenv} - \caption{Initial graph with the two field stores.} - \label{fig:guard0} -\end{figure} - -Figure~\ref{fig:guard1} shows the example graph at a later compilation phase when the field store instructions are lowered to memory store instructions and explicitely modelled null check guards. -The guards are attached to anchor instructions that delimit their possible schedule. -The first guard must not be moved outside the \texttt{if} block; the second guard may be moved before the \texttt{If} instruction, because at this point it is already guaranteed that the second store is executed. - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{guard1} - \textnode{entry}{Entry} - \node{anchor1}{Anchor} - \node{anchor2}{Anchor} - \nodesplit{if}{If} - \node{merge}{Merge} - \node{return}{Return} - \node{cmpnull}{NonNull} - \textnode{p}{p} - \textnode{const0}{0} - \nodeguard{guard1}{Guard} - \nodeguard{guard2}{Guard} - \nodetrisplit{store1}{MemStore 16 (int)} - \nodetrisplit{store2}{MemStore 20 (int)} - \nodeframestate{fs1}{FrameState} - \nodeframestate{fs2}{FrameState} - \data{store1:in1}{p} - \data{store2:in1}{p} - \data{store1:in2}{const0} - \data{store2:in2}{const0} - \data{store1:in3}{guard1} - \data{store2:in3}{guard2} - \data{guard1:in1}{anchor2} - \data{guard2:in1}{anchor1} - \data{guard1:in2}{cmpnull} - \data{guard2:in2}{cmpnull} - \control{entry}{anchor1} - \control{anchor1}{if} - \data{if}{cmpnull} - \controllabel{if:succ1}{merge} - \controllabel{if:succ2}{anchor2} - \control{anchor2}{store1} - \controllabel{store1:succ1}{merge} - \controllabel{store1:succ2}{fs1} - \control{merge}{store2} - \controllabel{store2:succ1}{return} - \controllabel{store2:succ2}{fs2} - \data{cmpnull}{p} -\end{digraphenv} - \caption{A load guarded by a null check guard.} - \label{fig:guard1} -\end{figure} - -The first guard can be easily removed, because it is guarded by an \texttt{If} instruction that checks the same condition. -Therefore we can remove the guard and the anchor from the graph and this gives us the graph shown in Figure \ref{fig:guard2}. - -There is another optimization for guard instructions: If two guards that are anchored to the true and false branch of the same \texttt{If} instruction have the same condition, they can be merged, so that the resulting guard is anchored at the most distant node of which the \texttt{If} instruction is a postdominator. - - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{guard2} - \textnode{entry}{Entry} - \node{anchor1}{Anchor} - \nodesplit{if}{If} - \node{merge}{Merge} - \node{return}{Return} - \node{cmpnull}{NonNull} - \textnode{p}{p} - \textnode{const0}{0} - \nodeguard{guard2}{Guard} - \nodetrisplit{store1}{MemStore 16 (int)} - \nodetrisplit{store2}{MemStore 20 (int)} - \nodeframestate{fs1}{FrameState} - \nodeframestate{fs2}{FrameState} - \data{store1:in1}{p} - \data{store2:in1}{p} - \data{store1:in2}{const0} - \data{store2:in2}{const0} - \data{store2:in3}{guard2} - \data{guard2:in1}{anchor1} - \data{guard2:in2}{cmpnull} - \control{entry}{anchor1} - \control{anchor1}{if} - \data{if}{cmpnull} - \controllabel{if:succ1}{merge} - \controllabel{if:succ2}{store1} - \controllabel{store1:succ1}{merge} - \controllabel{store1:succ2}{fs1} - \control{merge}{store2} - \controllabel{store2:succ1}{return} - \controllabel{store2:succ2}{fs2} - \data{cmpnull}{p} -\end{digraphenv} - \caption{After removing redundant guards.} - \label{fig:guard2} -\end{figure} - -The remaining guard can now be moved above the \texttt{If} condition and be used to eliminate the need for the \texttt{If} node. -From this point on, the guard can however no longer be moved below the first memory store. -We use a control dependency from the guard to the field store to express this condition. -The link between the second store and the guard and the control flow merge instruction is no longer necessary. - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{guard3} - \textnode{entry}{Entry} - \node{anchor1}{Anchor} - \node{return}{Return} - \node{cmpnull}{NonNull} - \textnode{p}{p} - \textnode{const0}{0} - \nodeguard{guard2}{Guard} - \nodetrisplit{store1}{MemStore 16 (int)} - \nodetrisplit{store2}{MemStore 20 (int)} - \nodeframestate{fs1}{FrameState} - \nodeframestate{fs2}{FrameState} - \data{store1:in1}{p} - \data{store2:in1}{p} - \data{store1:in2}{const0} - \data{store2:in2}{const0} - \data{store2:in3}{guard2} - \data{guard2:in1}{anchor1} - \data{guard2:in2}{cmpnull} - \control{guard2}{store1} - \control{entry}{anchor1} - \control{anchor1}{store1} - \controllabel{store1:succ2}{fs1} - \control{store1}{store2} - \controllabel{store2:succ1}{return} - \controllabel{store2:succ2}{fs2} - \data{cmpnull}{p} -\end{digraphenv} - \caption{After eliminating an if with a guard.} - \label{fig:guard3} -\end{figure} - -At some point during the compilation, guards need to be fixed, which means that appropriate data and control dependencies will be inserted so that they cannot move outside the scope of the associated frame state. -This will generate deoptimization-free zones that can be targeted by the most aggressive optimizations. -A simple algorithm for this removal of frame states would be to move all guards as far upwards as possible and then the guards are fixed using anchor nodes. -In our example, the guard is already fixed, so there is no deoptimization point that uses any of the memory store frame states. -Therefore we can delete the frame states from the graph (see Figure \ref{fig:guard4}). - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{guard4} - \textnode{entry}{Entry} - \node{anchor1}{Anchor} - \node{return}{Return} - \node{cmpnull}{NonNull} - \textnode{p}{p} - \textnode{const0}{0} - \nodeguard{guard2}{Guard} - \nodetrisplit{store1}{MemStore 16 (int)} - \nodetrisplit{store2}{MemStore 20 (int)} - \data{store1:in1}{p} - \data{store2:in1}{p} - \data{store1:in2}{const0} - \data{store2:in2}{const0} - \data{store2:in3}{guard2} - \data{guard2:in1}{anchor1} - \data{guard2:in2}{cmpnull} - \control{guard2}{store1} - \control{entry}{anchor1} - \control{anchor1}{store1} - \control{store1}{store2} - \controllabel{store2:succ1}{return} - \data{cmpnull}{p} -\end{digraphenv} - \caption{After removing the frame states.} - \label{fig:guard4} -\end{figure} - -Now we can use memory coalescing to combine the two stores without frame state to adjacent locations in the same object. -This is only possible if the first store does not have a frame state. -Figure \ref{fig:guard5} shows the resulting graph. - - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{guard5} - \textnode{entry}{Entry} - \node{anchor1}{Anchor} - \node{return}{Return} - \node{cmpnull}{NonNull} - \textnode{p}{p} - \textnode{const0}{0} - \nodeguard{guard2}{Guard} - \nodetrisplit{store1}{MemStore 16 (long)} - \data{store1:in1}{p} - \data{store1:in2}{const0} - \data{guard2:in1}{anchor1} - \data{guard2:in2}{cmpnull} - \control{guard2}{store1} - \control{entry}{anchor1} - \control{anchor1}{store1} - \controllabel{store1:succ1}{return} - \data{cmpnull}{p} -\end{digraphenv} - \caption{After coalescing the two memory stores.} - \label{fig:guard5} -\end{figure} - -A memory store that immediately follows a null check guard instruction on the same object, can be combined into a store with an implicit null check (that deoptimizes instead of throwing the exception). -Therefore, we can remove the guard again and also the anchor is no longer necessary. -Figure~\ref{fig:guard6} shows now that fully optimized graph that is generated for Listing~\ref{lst:guard1}. - -\begin{figure}[h] - \centering -\begin{digraphenv}{scale=0.5}{guard6} - \textnode{entry}{Entry} - \node{return}{Return} - \textnode{p}{p} - \textnode{const0}{0} - \nodetrisplit{store1}{DeoptimizingMemStore 16 (long)} - \data{store1:in1}{p} - \data{store1:in2}{const0} - \control{entry}{store1} - \controllabel{store1:succ1}{return} -\end{digraphenv} - \caption{Fully optimized method.} - \label{fig:guard6} -\end{figure} - - -\section{Conclusions} -\label{sec:conclusions} -This document sketched the strategy for the Graph compiler. -We already reached M1 (as defined in Section~\ref{sec:mile}) and have the following plans for M2 to M4: -\begin{description} -\item[M2:] June 30th, 2011 -\item[M3:] August 15th, 2011 -\item[M4:] September 30th, 2011 -\end{description} -After we reach M4, we want to create a new project road map that further improves the Graal compiler with respect to its two main goals: Modularity and peak performance. - -\end{document}
--- a/doc/design/graph_test.tex Wed Jun 08 14:01:51 2011 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,160 +0,0 @@ -\documentclass[twocolumn]{svjour3} -\usepackage[pdftex]{graphicx} -\usepackage{environ} -\usepackage{amsmath} -\usepackage{amsfonts} -\usepackage[english]{babel} -\usepackage[utf8]{inputenc} -\usepackage{lmodern} -\usepackage[T1]{fontenc} -\usepackage{color} - -\input{graphdrawing} - -\renewcommand*\descriptionlabel[1]{\hspace\labelsep\normalfont\bf #1} - -\newcommand{\Sa}{{\Large$^*$}} -\newcommand{\Sb}{{\Large$^\dag$}} -\newcommand{\Sc}{{\Large$^\S$}} - -\smartqed % flush right qed marks, e.g. at end of proof - -\journalname{Test} -\def\makeheadbox{{% -\hbox to0pt{\vbox{\baselineskip=10dd\hrule\hbox -to\hsize{\vrule\kern3pt\vbox{\kern3pt -\hbox{\bfseries Test} -\kern3pt}\hfil\kern3pt\vrule}\hrule}% -\hss}}} - -\begin{document} - -\author{} -\institute{} - -\date{Created: \today} - -\title{Test} -\subtitle{} - -\maketitle - -\begin{digraphenv}{scale=0.5}{layout1} - \nodestart - \nodeend - \data{a}{start} - \data{b}{start} - \node{a}{a} - \node{b}{b} - \nodesplit{if}{if} - \node{nop}{nop} - \nodebi{add}{+} - \controllabel{if:succ1}{nop} - \controllabel{if:succ2}{add} - \datalabel{add:in1}{a} - \datalabel{add:in2}{b} - \control{nop}{end} -\end{digraphenv} - -\begin{digraphenv}{scale=0.5}{layout2} - \node{node1}{nop} - \nodebi{node2}{+} - \nodetri{node3}{phi} - \nodesplit{node4}{if} -\end{digraphenv} - -\begin{digraphenv}{scale=0.5}{layout3} - \node{a}{a} - \node{b}{b} - \nodesplit{if}{if} - \node{nop}{nop} - \nodebi{add}{+} - \controllabel{if:succ1}{nop} - \controllabel{if:succ2}{add} - \datalabel{add:in1}{a} - \datalabel{add:in2}{b} -\end{digraphenv} - -\begin{digraphenv}{scale=0.5}{layout4} - \node{arr}{arr} - \node{i}{i} - \node{j}{j} - \node{v}{v} - \nodetri{astore1}{astore} - \datalabel{astore1:in1}{arr} - \datalabel{astore1:in2}{i} - \datalabel{astore1:in3}{v} - \nodebi{add}{+} - \datalabel{add:in1}{i} - \datalabel{add:in2}{j} - \nodetri{astore2}{astore} - \datalabel{astore2:in1}{arr} - \datalabel{astore2:in2}{add} - \datalabel{astore2:in3}{v} - \cnode{fs}{framestate}{lightblue} - \control{fs}{astore2} - \data{fs}{astore1} -% \data{fs}{arr} -% \data{fs}{i} -% \data{fs}{j} -% \data{fs}{v} - \control{astore1}{astore2} -\end{digraphenv} - -\begin{digraphenv}{scale=0.5}{layout5} - \nodestart - \nodeend - % input projections - \node{a}{proj:a} - \node{b}{proj:b} - \data{a}{start} - \data{b}{start} - % if - \nodebi{cmp1}{<} - \datalabel{cmp1:in1}{a} - \datalabel{cmp1:in2}{b} - \nodesplit{if}{if} - \data{if}{cmp1} - \control{start}{if} - % branches - \nodebi{add1}{+} - \datalabel{add1:in1}{a} - \datalabel{add1:in2}{b} - \nodebi{sub1}{-} - \datalabel{sub1:in1}{a} - \datalabel{sub1:in2}{b} - \controllabel{if:succ1}{add1} - \controllabel{if:succ2}{sub1} - % merge - \nodebi{merge}{merge} - \control{add1}{merge} - \control{sub1}{merge} - % phi - \nodebi{phi1}{phi} - \datalabel{phi1:in1}{add1} - \datalabel{phi1:in2}{sub1} - % ret - \node{ret}{ret} - \data{ret}{phi1} - \control{merge}{ret} - \control{ret}{end} -\end{digraphenv} - -\end{document} - - - - - - - - - - - - - - - - -
--- a/doc/design/graphdrawing.tex Wed Jun 08 14:01:51 2011 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,109 +0,0 @@ - -% graph drawing -\newwrite\dotfile -\newcommand{\digraph}[3][scale=1]{ - \immediate\openout\dotfile=dot_temp_#2.dot - \immediate\write\dotfile{digraph #2 { margin=0; pad=0; concentrate=false; \string#3}} - \immediate\closeout\dotfile - \immediate\write18{bash -c "dot -Tpdf dot_temp_#2.dot > dot_temp_#2.pdf"} - \IfFileExists{dot_temp_#2.pdf} - % the pdf exists: include it - { \includegraphics[#1]{dot_temp_#2} } - % the pdf was not created - show a hint - { \fbox{ \begin{tabular}{l} - The file \texttt{dot_temp_#2.pdf} hasn't been created from - \texttt{dot_temp_#2.dot} yet. \\ - We attempted to create it with:\\ - `\texttt{dot -Tpdf dot_temp_#2.dot > dot_temp_#2.pdf}' \\ - but that seems not to have worked. You need to execute `\texttt{pdflatex}' with \\ - the `\texttt{-shell-escape} option. - \end{tabular}} - } -} - -\NewEnviron{digraphenv}[2]{\digraph[#1]{#2}{ nodesep="0.1"; ranksep="0.08 equally"; \BODY }} - -\newcommand{\control}[2]{#1:successors:s -> #2:predecessors:n [color=red];} -\newcommand{\controllabel}[2]{#1:s -> #2:predecessors:n [color=red];} -\newcommand{\data}[2]{#2:usages:s -> #1:inputs [color=black,dir=back];} -\newcommand{\datalabel}[2]{#2:usages:s -> #1:n [color=black,dir=back];} -\newcommand{\datalabeltext}[3]{#2:usages:s -> #1:n [color=black,dir=back,label="#3"];} - -\newcommand{\textnode}[2]{#1 [shape=plaintext, label="#2"]} -\newcommand{\genericnodestart}[1]{#1 [shape=plaintext, label=< <TABLE BORDER="0" CELLSPACING="0"><TR><TD CELLPADDING="0"><TABLE BORDER="0" CELLSPACING="2" CELLPADDING="0"><TR><TD WIDTH="15" HEIGHT="5" PORT="predecessors" BGCOLOR="rosybrown1"></TD></TR></TABLE></TD><TD COLSPAN="2" CELLPADDING="0" ALIGN="RIGHT"><TABLE BORDER="0" CELLSPACING="2" CELLPADDING="0"><TR>} -\newcommand{\genericnodeend}[0]{</TR></TABLE></TD><TD CELLPADDING="0"><TABLE BORDER="0" CELLSPACING="2" CELLPADDING="0"><TR><TD WIDTH="15" HEIGHT="5" PORT="usages" BGCOLOR="lightgrey"></TD></TR></TABLE></TD></TR></TABLE>>]} -\newcommand{\portinput}[1]{<TD WIDTH="15" HEIGHT="5" PORT="#1" BGCOLOR="lightgrey"></TD>} -\newcommand{\portsuccessor}[1]{<TD WIDTH="15" HEIGHT="5" PORT="#1" BGCOLOR="rosybrown1"></TD>} -\newcommand{\portempty}[0]{<TD WIDTH="15" HEIGHT="5"></TD>} -\newcommand{\genericnodelabel}[2]{</TR></TABLE></TD></TR><TR><TD BORDER="1" COLSPAN="3" BGCOLOR="#2"><FONT POINT-SIZE="12">#1</FONT></TD></TR><TR><TD COLSPAN="2" CELLPADDING="0" ALIGN="RIGHT"><TABLE BORDER="0" CELLSPACING="2" CELLPADDING="0"><TR>} - -\newcommand{\nodestart}[0]{start [shape=plaintext, rank=source, label=< <TABLE BORDER="0" CELLSPACING="0"><TR><TD COLSPAN="3"><TABLE BORDER="0"><TR><TD></TD> \genericnodelabel{start}{lightyellow} \portsuccessor{successors} \portempty \genericnodeend } - -\newcommand{\nodeend}[0]{\genericnodestart{end} \portempty \portinput{inputs} \genericnodelabel{end}{lightyellow} <TD></TD></TR></TABLE></TD><TD></TD></TR></TABLE>>]} - -\newcommand{\nodeconst}[2]{#1 [margin="0.05, 0.05", shape=plaintext, label=< <TABLE BORDER="0" CELLSPACING="0"><TR><TD BORDER="1" BGCOLOR="white"><FONT POINT-SIZE="12">#2</FONT></TD></TR><TR><TD WIDTH="15" HEIGHT="5" PORT="usages" BGCOLOR="lightgrey"></TD></TR></TABLE>>]} -\newcommand{\nodeframestate}[2]{#1 [margin="0.05, 0.05", shape=plaintext, label=< <TABLE BORDER="0" CELLSPACING="0"><TR><TD WIDTH="15" HEIGHT="5" PORT="predecessors" BGCOLOR="rosybrown1"></TD><TD WIDTH="15" HEIGHT="5"></TD><TD HEIGHT="5" PORT="inputs" BGCOLOR="lightgrey"></TD></TR><TR><TD BORDER="1" COLSPAN="3" BGCOLOR="lightblue"><FONT POINT-SIZE="12">#2</FONT></TD></TR></TABLE>>]} - - -\newcommand{\node}[2]{\genericnodestart{#1} \portempty \portinput{inputs} \genericnodelabel{#2}{white} \portsuccessor{successors} \portempty \genericnodeend } -\newcommand{\nodebi}[2]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \genericnodelabel{#2}{white} \portsuccessor{successors} \portempty \genericnodeend } -\newcommand{\nodetri}[2]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \portinput{in3} \genericnodelabel{#2}{white} \portsuccessor{successors} \portempty \portempty \genericnodeend } -\newcommand{\nodequad}[2]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \portinput{in3} \portinput{in4} \genericnodelabel{#2}{white} \portsuccessor{successors} \portempty \portempty \portempty \genericnodeend } -\newcommand{\nodesplit}[2]{\genericnodestart{#1} \portempty \portinput{inputs} \genericnodelabel{#2}{white} \portsuccessor{succ1} \portsuccessor{succ2} \genericnodeend } -\newcommand{\nodequadsplit}[2]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \portinput{in3} \portinput{in4} \genericnodelabel{#2}{white} \portsuccessor{succ1} \portsuccessor{succ2} \portempty \portempty \genericnodeend } -\newcommand{\nodetrisplit}[2]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \portinput{in3} \genericnodelabel{#2}{white} \portsuccessor{succ1} \portsuccessor{succ2} \portempty \genericnodeend } -\newcommand{\nodesplittri}[2]{\genericnodestart{#1} \portempty \portinput{inputs} \genericnodelabel{#2}{white} \portsuccessor{succ1} \portsuccessor{succ2} \portsuccessor{succ3} \genericnodeend } -\newcommand{\nodebisplit}[2]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \genericnodelabel{#2}{white} \portsuccessor{succ1} \portsuccessor{succ2} \portempty \genericnodeend } - -\newcommand{\nodeguard}[2]{\cnodebi{#1}{#2}{rosybrown1}} - -\newcommand{\cnode}[3]{\genericnodestart{#1} \portempty \portinput{inputs} \genericnodelabel{#2}{#3} \portsuccessor{successors} \portempty \genericnodeend } -\newcommand{\cnodebi}[3]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \genericnodelabel{#2}{#3} \portsuccessor{successors} \portempty \genericnodeend } -\newcommand{\cnodetri}[3]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \portinput{in3} \genericnodelabel{#2}{#3} \portsuccessor{successors} \portempty \portempty \genericnodeend } -\newcommand{\cnodesplit}[3]{\genericnodestart{#1} \portempty \portinput{inputs} \genericnodelabel{#2}{#3} \portsuccessor{succ1} \portsuccessor{succ2} \genericnodeend } - -% this doesn't work: -%\newenvironment{graphfigure}[2]{\begin{figure}[h] \label{fig:#1} \centering \begin{digraphenv}{scale=0.5}{#1}}{\end{digraphenv} \caption{#2} \end{figure}} - -%%%%%%%%%%%%%% example: - -% \begin{digraphenv}{scale=0.5}{MyGraph} -% \node{start}{start} -% \node{end}{end} -% % input projections -% \node{a}{proj:a} -% \node{b}{proj:b} -% \data{a}{start} -% \data{b}{start} -% % if -% \nodebi{cmp1}{<} -% \datalabel{cmp1:in1}{a} -% \datalabel{cmp1:in2}{b} -% \nodesplit{if}{if} -% \data{if}{cmp1} -% \control{start}{if} -% % branches -% \nodebi{add1}{+} -% \datalabel{add1:in1}{a} -% \datalabel{add1:in2}{b} -% \nodebi{sub1}{-} -% \datalabel{sub1:in1}{a} -% \datalabel{sub1:in2}{b} -% \controllabel{if:succ1}{add1} -% \controllabel{if:succ2}{sub1} -% % merge -% \nodebi{merge}{merge} -% \control{add1}{merge} -% \control{sub1}{merge} -% % phi -% \nodebi{phi1}{phi} -% \datalabel{phi1:in1}{add1} -% \datalabel{phi1:in2}{sub1} -% % ret -% \node{ret}{ret} -% \data{ret}{phi1} -% \control{merge}{ret} -% \control{ret}{end} -% \end{digraphenv} - -%%%%%%%%%%%%%%%
--- a/doc/design/svglov3.clo Wed Jun 08 14:01:51 2011 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,101 +0,0 @@ -% SVJour3 DOCUMENT CLASS OPTION SVGLOV3 -- for standardised journals -% -% This is an enhancement for the LaTeX -% SVJour3 document class for Springer journals -% -%% -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} -\ProvidesFile{svglov3.clo} - [2006/02/03 v3.1 - style option for standardised journals] -\typeout{SVJour Class option: svglov3.clo for standardised journals} -\def\validfor{svjour3} -\ExecuteOptions{final,10pt,runningheads} -% No size changing allowed, hence a "copy" of size10.clo is included -\renewcommand\normalsize{% -\if@twocolumn - \@setfontsize\normalsize\@xpt{12.5pt}% -\else - \if@smallext - \@setfontsize\normalsize\@xpt\@xiipt - \else - \@setfontsize\normalsize{9.5pt}{11.5pt}% - \fi -\fi - \abovedisplayskip=3 mm plus6pt minus 4pt - \belowdisplayskip=3 mm plus6pt minus 4pt - \abovedisplayshortskip=0.0 mm plus6pt - \belowdisplayshortskip=2 mm plus4pt minus 4pt - \let\@listi\@listI} -\normalsize -\newcommand\small{% -\if@twocolumn - \@setfontsize\small{8.5pt}\@xpt -\else - \if@smallext - \@setfontsize\small\@viiipt{9.5pt}% - \else - \@setfontsize\small\@viiipt{9.25pt}% - \fi -\fi - \abovedisplayskip 8.5\p@ \@plus3\p@ \@minus4\p@ - \abovedisplayshortskip \z@ \@plus2\p@ - \belowdisplayshortskip 4\p@ \@plus2\p@ \@minus2\p@ - \def\@listi{\leftmargin\leftmargini - \parsep 0\p@ \@plus1\p@ \@minus\p@ - \topsep 4\p@ \@plus2\p@ \@minus4\p@ - \itemsep0\p@}% - \belowdisplayskip \abovedisplayskip -} -\let\footnotesize\small -\newcommand\scriptsize{\@setfontsize\scriptsize\@viipt\@viiipt} -\newcommand\tiny{\@setfontsize\tiny\@vpt\@vipt} -\if@twocolumn - \newcommand\large{\@setfontsize\large\@xiipt\@xivpt} - \newcommand\LARGE{\@setfontsize\LARGE{16pt}{18pt}} -\else - \newcommand\large{\@setfontsize\large\@xipt\@xiipt} - \newcommand\LARGE{\@setfontsize\LARGE{13pt}{15pt}} -\fi -\newcommand\Large{\@setfontsize\Large\@xivpt{16dd}} -\newcommand\huge{\@setfontsize\huge\@xxpt{25}} -\newcommand\Huge{\@setfontsize\Huge\@xxvpt{30}} -% -\def\runheadhook{\rlap{\smash{\lower6.5pt\hbox to\textwidth{\hrulefill}}}} -\if@twocolumn -\setlength{\textwidth}{17.4cm} -\setlength{\textheight}{234mm} -\AtEndOfClass{\setlength\columnsep{6mm}} -\else - \if@smallext - \setlength{\textwidth}{11.9cm} - \setlength{\textheight}{19.4cm} - \else - \setlength{\textwidth}{12.2cm} - \setlength{\textheight}{19.8cm} - \fi -\fi -% -\AtBeginDocument{% -\@ifundefined{@journalname} - {\typeout{Unknown journal: specify \string\journalname\string{% -<name of your journal>\string} in preambel^^J}}{}} -% -\endinput -%% -%% End of file `svglov3.clo'.
--- a/doc/design/svjour3.cls Wed Jun 08 14:01:51 2011 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1431 +0,0 @@ -% SVJour3 DOCUMENT CLASS -- version 3.2 for LaTeX2e -% -% LaTeX document class for Springer journals -% -%% -%% -%% \CharacterTable -%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z -%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z -%% Digits \0\1\2\3\4\5\6\7\8\9 -%% Exclamation \! Double quote \" Hash (number) \# -%% Dollar \$ Percent \% Ampersand \& -%% Acute accent \' Left paren \( Right paren \) -%% Asterisk \* Plus \+ Comma \, -%% Minus \- Point \. Solidus \/ -%% Colon \: Semicolon \; Less than \< -%% Equals \= Greater than \> Question mark \? -%% Commercial at \@ Left bracket \[ Backslash \\ -%% Right bracket \] Circumflex \^ Underscore \_ -%% Grave accent \` Left brace \{ Vertical bar \| -%% Right brace \} Tilde \~} -\NeedsTeXFormat{LaTeX2e}[1995/12/01] -\ProvidesClass{svjour3}[2007/05/08 v3.2 -^^JLaTeX document class for Springer journals] -\newcommand\@ptsize{} -\newif\if@restonecol -\newif\if@titlepage -\@titlepagefalse -\DeclareOption{a4paper} - {\setlength\paperheight {297mm}% - \setlength\paperwidth {210mm}} -\DeclareOption{10pt}{\renewcommand\@ptsize{0}} -\DeclareOption{twoside}{\@twosidetrue \@mparswitchtrue} -\DeclareOption{draft}{\setlength\overfullrule{5pt}} -\DeclareOption{final}{\setlength\overfullrule{0pt}} -\DeclareOption{fleqn}{\input{fleqn.clo}\AtBeginDocument{\mathindent\z@}% -\AtBeginDocument{\@ifpackageloaded{amsmath}{\@mathmargin\z@}{}}% -\PassOptionsToPackage{fleqn}{amsmath}} -%%% -\DeclareOption{onecolumn}{} -\DeclareOption{smallcondensed}{} -\DeclareOption{twocolumn}{\@twocolumntrue\ExecuteOptions{fleqn}} -\newif\if@smallext\@smallextfalse -\DeclareOption{smallextended}{\@smallexttrue} -\let\if@mathematic\iftrue -\let\if@numbook\iffalse -\DeclareOption{numbook}{\let\if@envcntsect\iftrue - \AtEndOfPackage{% - \renewcommand\thefigure{\thesection.\@arabic\c@figure}% - \renewcommand\thetable{\thesection.\@arabic\c@table}% - \renewcommand\theequation{\thesection.\@arabic\c@equation}% - \@addtoreset{figure}{section}% - \@addtoreset{table}{section}% - \@addtoreset{equation}{section}% - }% -} -\DeclareOption{openbib}{% - \AtEndOfPackage{% - \renewcommand\@openbib@code{% - \advance\leftmargin\bibindent - \itemindent -\bibindent - \listparindent \itemindent - \parsep \z@ - }% - \renewcommand\newblock{\par}}% -} -\DeclareOption{natbib}{% -\AtEndOfClass{\RequirePackage{natbib}% -% Changing some parameters of NATBIB -\setlength{\bibhang}{\parindent}% -%\setlength{\bibsep}{0mm}% -\let\bibfont=\small -\def\@biblabel#1{#1.}% -\newcommand{\etal}{et al.}% -\bibpunct{(}{)}{;}{a}{}{,}}} -% -\let\if@runhead\iffalse -\DeclareOption{runningheads}{\let\if@runhead\iftrue} -\let\if@smartrunh\iffalse -\DeclareOption{smartrunhead}{\let\if@smartrunh\iftrue} -\DeclareOption{nosmartrunhead}{\let\if@smartrunh\iffalse} -\let\if@envcntreset\iffalse -\DeclareOption{envcountreset}{\let\if@envcntreset\iftrue} -\let\if@envcntsame\iffalse -\DeclareOption{envcountsame}{\let\if@envcntsame\iftrue} -\let\if@envcntsect\iffalse -\DeclareOption{envcountsect}{\let\if@envcntsect\iftrue} -\let\if@referee\iffalse -\DeclareOption{referee}{\let\if@referee\iftrue} -\def\makereferee{\def\baselinestretch{2}} -\let\if@instindent\iffalse -\DeclareOption{instindent}{\let\if@instindent\iftrue} -\let\if@smartand\iffalse -\DeclareOption{smartand}{\let\if@smartand\iftrue} -\let\if@spthms\iftrue -\DeclareOption{nospthms}{\let\if@spthms\iffalse} -% -% language and babel dependencies -\DeclareOption{deutsch}{\def\switcht@@therlang{\switcht@deutsch}% -\gdef\svlanginfo{\typeout{Man spricht deutsch.}\global\let\svlanginfo\relax}} -\DeclareOption{francais}{\def\switcht@@therlang{\switcht@francais}% -\gdef\svlanginfo{\typeout{On parle francais.}\global\let\svlanginfo\relax}} -\let\switcht@@therlang\relax -\let\svlanginfo\relax -% -\AtBeginDocument{\@ifpackageloaded{babel}{% -\@ifundefined{extrasenglish}{}{\addto\extrasenglish{\switcht@albion}}% -\@ifundefined{extrasUKenglish}{}{\addto\extrasUKenglish{\switcht@albion}}% -\@ifundefined{extrasfrenchb}{}{\addto\extrasfrenchb{\switcht@francais}}% -\@ifundefined{extrasgerman}{}{\addto\extrasgerman{\switcht@deutsch}}% -\@ifundefined{extrasngerman}{}{\addto\extrasngerman{\switcht@deutsch}}% -}{\switcht@@therlang}% -} -% -\def\ClassInfoNoLine#1#2{% - \ClassInfo{#1}{#2\@gobble}% -} -\let\journalopt\@empty -\DeclareOption*{% -\InputIfFileExists{sv\CurrentOption.clo}{% -\global\let\journalopt\CurrentOption}{% -\ClassWarning{Springer-SVJour3}{Specified option or subpackage -"\CurrentOption" not found -}\OptionNotUsed}} -\ExecuteOptions{a4paper,twoside,10pt,instindent} -\ProcessOptions -% -\ifx\journalopt\@empty\relax -\ClassInfoNoLine{Springer-SVJour3}{extra/valid Springer sub-package (-> *.clo) -\MessageBreak not found in option list of \string\documentclass -\MessageBreak - autoactivating "global" style}{} -\input{svglov3.clo} -\else -\@ifundefined{validfor}{% -\ClassError{Springer-SVJour3}{Possible option clash for sub-package -\MessageBreak "sv\journalopt.clo" - option file not valid -\MessageBreak for this class}{Perhaps you used an option of the old -Springer class SVJour!} -}{} -\fi -% -\if@smartrunh\AtEndDocument{\islastpageeven\getlastpagenumber}\fi -% -\newcommand{\twocoltest}[2]{\if@twocolumn\def\@gtempa{#2}\else\def\@gtempa{#1}\fi -\@gtempa\makeatother} -\newcommand{\columncase}{\makeatletter\twocoltest} -% -\DeclareMathSymbol{\Gamma}{\mathalpha}{letters}{"00} -\DeclareMathSymbol{\Delta}{\mathalpha}{letters}{"01} -\DeclareMathSymbol{\Theta}{\mathalpha}{letters}{"02} -\DeclareMathSymbol{\Lambda}{\mathalpha}{letters}{"03} -\DeclareMathSymbol{\Xi}{\mathalpha}{letters}{"04} -\DeclareMathSymbol{\Pi}{\mathalpha}{letters}{"05} -\DeclareMathSymbol{\Sigma}{\mathalpha}{letters}{"06} -\DeclareMathSymbol{\Upsilon}{\mathalpha}{letters}{"07} -\DeclareMathSymbol{\Phi}{\mathalpha}{letters}{"08} -\DeclareMathSymbol{\Psi}{\mathalpha}{letters}{"09} -\DeclareMathSymbol{\Omega}{\mathalpha}{letters}{"0A} -% -\setlength\parindent{15\p@} -\setlength\smallskipamount{3\p@ \@plus 1\p@ \@minus 1\p@} -\setlength\medskipamount{6\p@ \@plus 2\p@ \@minus 2\p@} -\setlength\bigskipamount{12\p@ \@plus 4\p@ \@minus 4\p@} -\setlength\headheight{12\p@} -\setlength\headsep {14.50dd} -\setlength\topskip {10\p@} -\setlength\footskip{30\p@} -\setlength\maxdepth{.5\topskip} -% -\@settopoint\textwidth -\setlength\marginparsep {10\p@} -\setlength\marginparpush{5\p@} -\setlength\topmargin{-10pt} -\if@twocolumn - \setlength\oddsidemargin {-30\p@} - \setlength\evensidemargin{-30\p@} -\else - \setlength\oddsidemargin {\z@} - \setlength\evensidemargin{\z@} -\fi -\setlength\marginparwidth {48\p@} -\setlength\footnotesep{8\p@} -\setlength{\skip\footins}{9\p@ \@plus 4\p@ \@minus 2\p@} -\setlength\floatsep {12\p@ \@plus 2\p@ \@minus 2\p@} -\setlength\textfloatsep{20\p@ \@plus 2\p@ \@minus 4\p@} -\setlength\intextsep {20\p@ \@plus 2\p@ \@minus 2\p@} -\setlength\dblfloatsep {12\p@ \@plus 2\p@ \@minus 2\p@} -\setlength\dbltextfloatsep{20\p@ \@plus 2\p@ \@minus 4\p@} -\setlength\@fptop{0\p@} -\setlength\@fpsep{12\p@ \@plus 2\p@ \@minus 2\p@} -\setlength\@fpbot{0\p@ \@plus 1fil} -\setlength\@dblfptop{0\p@} -\setlength\@dblfpsep{12\p@ \@plus 2\p@ \@minus 2\p@} -\setlength\@dblfpbot{0\p@ \@plus 1fil} -\setlength\partopsep{2\p@ \@plus 1\p@ \@minus 1\p@} -\def\@listi{\leftmargin\leftmargini - \parsep \z@ - \topsep 6\p@ \@plus2\p@ \@minus4\p@ - \itemsep\parsep} -\let\@listI\@listi -\@listi -\def\@listii {\leftmargin\leftmarginii - \labelwidth\leftmarginii - \advance\labelwidth-\labelsep - \topsep \z@ - \parsep \topsep - \itemsep \parsep} -\def\@listiii{\leftmargin\leftmarginiii - \labelwidth\leftmarginiii - \advance\labelwidth-\labelsep - \topsep \z@ - \parsep \topsep - \itemsep \parsep} -\def\@listiv {\leftmargin\leftmarginiv - \labelwidth\leftmarginiv - \advance\labelwidth-\labelsep} -\def\@listv {\leftmargin\leftmarginv - \labelwidth\leftmarginv - \advance\labelwidth-\labelsep} -\def\@listvi {\leftmargin\leftmarginvi - \labelwidth\leftmarginvi - \advance\labelwidth-\labelsep} -% -\setlength\lineskip{1\p@} -\setlength\normallineskip{1\p@} -\renewcommand\baselinestretch{} -\setlength\parskip{0\p@ \@plus \p@} -\@lowpenalty 51 -\@medpenalty 151 -\@highpenalty 301 -\setcounter{topnumber}{4} -\renewcommand\topfraction{.9} -\setcounter{bottomnumber}{2} -\renewcommand\bottomfraction{.7} -\setcounter{totalnumber}{6} -\renewcommand\textfraction{.1} -\renewcommand\floatpagefraction{.85} -\setcounter{dbltopnumber}{3} -\renewcommand\dbltopfraction{.85} -\renewcommand\dblfloatpagefraction{.85} -\def\ps@headings{% - \let\@oddfoot\@empty\let\@evenfoot\@empty - \def\@evenhead{\small\csname runheadhook\endcsname - \rlap{\thepage}\hfil\leftmark\unskip}% - \def\@oddhead{\small\csname runheadhook\endcsname - \ignorespaces\rightmark\hfil\llap{\thepage}}% - \let\@mkboth\@gobbletwo - \let\sectionmark\@gobble - \let\subsectionmark\@gobble - } -% make indentations changeable -\def\setitemindent#1{\settowidth{\labelwidth}{#1}% - \leftmargini\labelwidth - \advance\leftmargini\labelsep - \def\@listi{\leftmargin\leftmargini - \labelwidth\leftmargini\advance\labelwidth by -\labelsep - \parsep=\parskip - \topsep=\medskipamount - \itemsep=\parskip \advance\itemsep by -\parsep}} -\def\setitemitemindent#1{\settowidth{\labelwidth}{#1}% - \leftmarginii\labelwidth - \advance\leftmarginii\labelsep -\def\@listii{\leftmargin\leftmarginii - \labelwidth\leftmarginii\advance\labelwidth by -\labelsep - \parsep=\parskip - \topsep=\z@ - \itemsep=\parskip \advance\itemsep by -\parsep}} -% labels of description -\def\descriptionlabel#1{\hspace\labelsep #1\hfil} -% adjusted environment "description" -% if an optional parameter (at the first two levels of lists) -% is present, its width is considered to be the widest mark -% throughout the current list. -\def\description{\@ifnextchar[{\@describe}{\list{}{\labelwidth\z@ - \itemindent-\leftmargin \let\makelabel\descriptionlabel}}} -\let\enddescription\endlist -% -\def\describelabel#1{#1\hfil} -\def\@describe[#1]{\relax\ifnum\@listdepth=0 -\setitemindent{#1}\else\ifnum\@listdepth=1 -\setitemitemindent{#1}\fi\fi -\list{--}{\let\makelabel\describelabel}} -% -\newdimen\logodepth -\logodepth=1.2cm -\newdimen\headerboxheight -\headerboxheight=163pt % 18 10.5dd-lines - 2\baselineskip -\if@twocolumn\else\advance\headerboxheight by-14.5mm\fi -\newdimen\betweenumberspace % dimension for space between -\betweenumberspace=3.33pt % number and text of titles. -\newdimen\aftertext % dimension for space after -\aftertext=5pt % text of title. -\newdimen\headlineindent % dimension for space between -\headlineindent=1.166cm % number and text of headings. -\if@mathematic - \def\runinend{} % \enspace} - \def\floatcounterend{\enspace} - \def\sectcounterend{} -\else - \def\runinend{.} - \def\floatcounterend{.\ } - \def\sectcounterend{.} -\fi -\def\email#1{\emailname: #1} -\def\keywords#1{\par\addvspace\medskipamount{\rightskip=0pt plus1cm -\def\and{\ifhmode\unskip\nobreak\fi\ $\cdot$ -}\noindent\keywordname\enspace\ignorespaces#1\par}} -% -\def\subclassname{{\bfseries Mathematics Subject Classification -(2000)}\enspace} -\def\subclass#1{\par\addvspace\medskipamount{\rightskip=0pt plus1cm -\def\and{\ifhmode\unskip\nobreak\fi\ $\cdot$ -}\noindent\subclassname\ignorespaces#1\par}} -% -\def\PACSname{\textbf{PACS}\enspace} -\def\PACS#1{\par\addvspace\medskipamount{\rightskip=0pt plus1cm -\def\and{\ifhmode\unskip\nobreak\fi\ $\cdot$ -}\noindent\PACSname\ignorespaces#1\par}} -% -\def\CRclassname{{\bfseries CR Subject Classification}\enspace} -\def\CRclass#1{\par\addvspace\medskipamount{\rightskip=0pt plus1cm -\def\and{\ifhmode\unskip\nobreak\fi\ $\cdot$ -}\noindent\CRclassname\ignorespaces#1\par}} -% -\def\ESMname{\textbf{Electronic Supplementary Material}\enspace} -\def\ESM#1{\par\addvspace\medskipamount -\noindent\ESMname\ignorespaces#1\par} -% -\newcounter{inst} -\newcounter{auth} -\def\authdepth{2} -\newdimen\instindent -\newbox\authrun -\newtoks\authorrunning -\newbox\titrun -\newtoks\titlerunning -\def\authorfont{\bfseries} - -\def\combirunning#1{\gdef\@combi{#1}} -\def\@combi{} -\newbox\combirun -% -\def\ps@last{\def\@evenhead{\small\rlap{\thepage}\hfil -\lastevenhead}} -\newcounter{lastpage} -\def\islastpageeven{\@ifundefined{lastpagenumber} -{\setcounter{lastpage}{0}}{\setcounter{lastpage}{\lastpagenumber}} -\ifnum\value{lastpage}>0 - \ifodd\value{lastpage}% - \else - \if@smartrunh - \thispagestyle{last}% - \fi - \fi -\fi} -\def\getlastpagenumber{\clearpage -\addtocounter{page}{-1}% - \immediate\write\@auxout{\string\gdef\string\lastpagenumber{\thepage}}% - \immediate\write\@auxout{\string\newlabel{LastPage}{{}{\thepage}}}% - \addtocounter{page}{1}} - -\def\journalname#1{\gdef\@journalname{#1}} - -\def\dedication#1{\gdef\@dedic{#1}} -\def\@dedic{} - -\let\@date\undefined -\def\notused{~} - -\def\institute#1{\gdef\@institute{#1}} - -\def\offprints#1{\begingroup -\def\protect{\noexpand\protect\noexpand}\xdef\@thanks{\@thanks -\protect\footnotetext[0]{\unskip\hskip-15pt{\itshape Send offprint requests -to\/}: \ignorespaces#1}}\endgroup\ignorespaces} - -%\def\mail#1{\gdef\@mail{#1}} -%\def\@mail{} - -\def\@thanks{} - -\def\@fnsymbol#1{\ifcase#1\or\star\or{\star\star}\or{\star\star\star}% - \or \dagger\or \ddagger\or - \mathchar "278\or \mathchar "27B\or \|\or **\or \dagger\dagger - \or \ddagger\ddagger \else\@ctrerr\fi\relax} -% -%\def\invthanks#1{\footnotetext[0]{\kern-\bibindent#1}} -% -\def\nothanksmarks{\def\thanks##1{\protected@xdef\@thanks{\@thanks - \protect\footnotetext[0]{\kern-\bibindent##1}}}} -% -\def\subtitle#1{\gdef\@subtitle{#1}} -\def\@subtitle{} - -\def\headnote#1{\gdef\@headnote{#1}} -\def\@headnote{} - -\def\papertype#1{\gdef\paper@type{\MakeUppercase{#1}}} -\def\paper@type{} - -\def\ch@ckobl#1#2{\@ifundefined{@#1} - {\typeout{SVJour3 warning: Missing -\expandafter\string\csname#1\endcsname}% - \csname #1\endcsname{#2}} - {}} -% -\def\ProcessRunnHead{% - \def\\{\unskip\ \ignorespaces}% - \def\thanks##1{\unskip{}}% - \instindent=\textwidth - \advance\instindent by-\headlineindent - \if!\the\titlerunning!\else - \edef\@title{\the\titlerunning}% - \fi - \global\setbox\titrun=\hbox{\small\rmfamily\unboldmath\ignorespaces\@title - \unskip}% - \ifdim\wd\titrun>\instindent - \typeout{^^JSVJour3 Warning: Title too long for running head.}% - \typeout{Please supply a shorter form with \string\titlerunning - \space prior to \string\maketitle}% - \global\setbox\titrun=\hbox{\small\rmfamily - Title Suppressed Due to Excessive Length}% - \fi - \xdef\@title{\copy\titrun}% -% - \if!\the\authorrunning! - \else - \setcounter{auth}{1}% - \edef\@author{\the\authorrunning}% - \fi - \ifnum\value{inst}>\authdepth - \def\stripauthor##1\and##2\endauthor{% - \protected@xdef\@author{##1\unskip\unskip\if!##2!\else\ et al.\fi}}% - \expandafter\stripauthor\@author\and\endauthor - \else - \gdef\and{\unskip, \ignorespaces}% - {\def\and{\noexpand\protect\noexpand\and}% - \protected@xdef\@author{\@author}} - \fi - \global\setbox\authrun=\hbox{\small\rmfamily\unboldmath\ignorespaces - \@author\unskip}% - \ifdim\wd\authrun>\instindent - \typeout{^^JSVJour3 Warning: Author name(s) too long for running head. - ^^JPlease supply a shorter form with \string\authorrunning - \space prior to \string\maketitle}% - \global\setbox\authrun=\hbox{\small\rmfamily Please give a shorter version - with: {\tt\string\authorrunning\space and - \string\titlerunning\space prior to \string\maketitle}}% - \fi - \xdef\@author{\copy\authrun}% - \markboth{\@author}{\@title}% -} -% -\let\orithanks=\thanks -\def\thanks#1{\ClassWarning{SVJour3}{\string\thanks\space may only be -used inside of \string\title, \string\author,\MessageBreak -and \string\date\space prior to \string\maketitle}} -% -\def\maketitle{\par\let\thanks=\orithanks -\ch@ckobl{journalname}{Noname} -\ch@ckobl{date}{the date of receipt and acceptance should be inserted -later} -\ch@ckobl{title}{A title should be given} -\ch@ckobl{author}{Name(s) and initial(s) of author(s) should be given} -\ch@ckobl{institute}{Address(es) of author(s) should be given} -\begingroup -% - \renewcommand\thefootnote{\@fnsymbol\c@footnote}% - \def\@makefnmark{$^{\@thefnmark}$}% - \renewcommand\@makefntext[1]{% - \noindent - \hb@xt@\bibindent{\hss\@makefnmark\enspace}##1\vrule height0pt - width0pt depth8pt} -% - \def\lastand{\ifnum\value{inst}=2\relax - \unskip{} \andname\ - \else - \unskip, \andname\ - \fi}% - \def\and{\stepcounter{auth}\relax - \if@smartand - \ifnum\value{auth}=\value{inst}% - \lastand - \else - \unskip, - \fi - \else - \unskip, - \fi}% - \thispagestyle{empty} - \ifnum \col@number=\@ne - \@maketitle - \else - \twocolumn[\@maketitle]% - \fi -% - \global\@topnum\z@ - \if!\@thanks!\else - \@thanks -\insert\footins{\vskip-3pt\hrule\@width\if@twocolumn\columnwidth -\else 38mm\fi\vskip3pt}% - \fi - {\def\thanks##1{\unskip{}}% - \def\iand{\\[5pt]\let\and=\nand}% - \def\nand{\ifhmode\unskip\nobreak\fi\ $\cdot$ }% - \let\and=\nand - \def\at{\\\let\and=\iand}% - \footnotetext[0]{\kern-\bibindent - \ignorespaces\@institute}\vspace{5dd}}% -%\if!\@mail!\else -% \footnotetext[0]{\kern-\bibindent\mailname\ -% \ignorespaces\@mail}% -%\fi -% - \if@runhead - \ProcessRunnHead - \fi -% - \endgroup - \setcounter{footnote}{0} - \global\let\thanks\relax - \global\let\maketitle\relax - \global\let\@maketitle\relax - \global\let\@thanks\@empty - \global\let\@author\@empty - \global\let\@date\@empty - \global\let\@title\@empty - \global\let\@subtitle\@empty - \global\let\title\relax - \global\let\author\relax - \global\let\date\relax - \global\let\and\relax} - -\def\makeheadbox{{% -\hbox to0pt{\vbox{\baselineskip=10dd\hrule\hbox -to\hsize{\vrule\kern3pt\vbox{\kern3pt -\hbox{\bfseries\@journalname\ manuscript No.} -\hbox{(will be inserted by the editor)} -\kern3pt}\hfil\kern3pt\vrule}\hrule}% -\hss}}} -% -\def\rubric{\setbox0=\hbox{\small\strut}\@tempdima=\ht0\advance -\@tempdima\dp0\advance\@tempdima2\fboxsep\vrule\@height\@tempdima -\@width\z@} -\newdimen\rubricwidth -% -\def\@maketitle{\newpage -\normalfont -\vbox to0pt{\if@twocolumn\vskip-39pt\else\vskip-49pt\fi -\nointerlineskip -\makeheadbox\vss}\nointerlineskip -\vbox to 0pt{\offinterlineskip\rubricwidth=\columnwidth -%%%%\vskip-12.5pt % -12.5pt -\if@twocolumn\else % one column journal - \divide\rubricwidth by144\multiply\rubricwidth by89 % perform golden section - \vskip-\topskip -\fi -\hrule\@height0.35mm\noindent -\advance\fboxsep by.25mm -\global\advance\rubricwidth by0pt -\rubric -\vss}\vskip19.5pt % war 9pt -% -\if@twocolumn\else - \gdef\footnoterule{% - \kern-3\p@ - \hrule\@width38mm % \columnwidth \rubricwidth - \kern2.6\p@} -\fi -% - \setbox\authrun=\vbox\bgroup - \if@twocolumn - \hrule\@height10.5mm\@width0\p@ - \else - \hrule\@height 2mm\@width0\p@ - \fi - \pretolerance=10000 - \rightskip=0pt plus 4cm - \nothanksmarks -% \if!\@headnote!\else -% \noindent -% {\LARGE\normalfont\itshape\ignorespaces\@headnote\par}\vskip 3.5mm -% \fi - {\LARGE\bfseries - \noindent\ignorespaces - \@title \par}\vskip 17pt\relax - \if!\@subtitle!\else - {\large\bfseries - \pretolerance=10000 - \rightskip=0pt plus 3cm - \vskip-12pt -% \noindent\ignorespaces\@subtitle \par}\vskip 11.24pt\relax - \noindent\ignorespaces\@subtitle \par}\vskip 17pt\relax - \fi - {\authorfont - \setbox0=\vbox{\setcounter{auth}{1}\def\and{\stepcounter{auth} }% - \hfuzz=2\textwidth\def\thanks##1{}\@author}% - \setcounter{footnote}{0}% - \global\value{inst}=\value{auth}% - \setcounter{auth}{1}% - \if@twocolumn - \rightskip43mm plus 4cm minus 3mm - \else % one column journal - \rightskip=\linewidth - \advance\rightskip by-\rubricwidth - \advance\rightskip by0pt plus 4cm minus 3mm - \fi -% -\def\and{\unskip\nobreak\enskip{\boldmath$\cdot$}\enskip\ignorespaces}% - \noindent\ignorespaces\@author\vskip7.23pt} -% - \small - \if!\@dedic!\else - \par - \normalsize\it - \addvspace\baselineskip - \noindent\@dedic - \fi - \egroup % end of header box - \@tempdima=\headerboxheight - \advance\@tempdima by-\ht\authrun - \unvbox\authrun - \ifdim\@tempdima>0pt - \vrule width0pt height\@tempdima\par - \fi - \noindent{\small\@date\if@twocolumn\vskip 7.2mm\else\vskip 5.2mm\fi} - \global\@minipagetrue - \global\everypar{\global\@minipagefalse\global\everypar{}}% -%\vskip22.47pt -} -% -\if@mathematic - \def\vec#1{\ensuremath{\mathchoice - {\mbox{\boldmath$\displaystyle\mathbf{#1}$}} - {\mbox{\boldmath$\textstyle\mathbf{#1}$}} - {\mbox{\boldmath$\scriptstyle\mathbf{#1}$}} - {\mbox{\boldmath$\scriptscriptstyle\mathbf{#1}$}}}} -\else - \def\vec#1{\ensuremath{\mathchoice - {\mbox{\boldmath$\displaystyle#1$}} - {\mbox{\boldmath$\textstyle#1$}} - {\mbox{\boldmath$\scriptstyle#1$}} - {\mbox{\boldmath$\scriptscriptstyle#1$}}}} -\fi -% -\def\tens#1{\ensuremath{\mathsf{#1}}} -% -\setcounter{secnumdepth}{3} -\newcounter {section} -\newcounter {subsection}[section] -\newcounter {subsubsection}[subsection] -\newcounter {paragraph}[subsubsection] -\newcounter {subparagraph}[paragraph] -\renewcommand\thesection {\@arabic\c@section} -\renewcommand\thesubsection {\thesection.\@arabic\c@subsection} -\renewcommand\thesubsubsection{\thesubsection.\@arabic\c@subsubsection} -\renewcommand\theparagraph {\thesubsubsection.\@arabic\c@paragraph} -\renewcommand\thesubparagraph {\theparagraph.\@arabic\c@subparagraph} -% -\def\@hangfrom#1{\setbox\@tempboxa\hbox{#1}% - \hangindent \z@\noindent\box\@tempboxa} -% -\def\@seccntformat#1{\csname the#1\endcsname\sectcounterend -\hskip\betweenumberspace} -% -% \newif\if@sectrule -% \if@twocolumn\else\let\@sectruletrue=\relax\fi -% \if@avier\let\@sectruletrue=\relax\fi -% \def\makesectrule{\if@sectrule\global\@sectrulefalse\null\vglue-\topskip -% \hrule\nobreak\parskip=5pt\relax\fi} -% % -% \let\makesectruleori=\makesectrule -% \def\restoresectrule{\global\let\makesectrule=\makesectruleori\global\@sectrulefalse} -% \def\nosectrule{\let\makesectrule=\restoresectrule} -% -\def\@startsection#1#2#3#4#5#6{% - \if@noskipsec \leavevmode \fi - \par - \@tempskipa #4\relax - \@afterindenttrue - \ifdim \@tempskipa <\z@ - \@tempskipa -\@tempskipa \@afterindentfalse - \fi - \if@nobreak - \everypar{}% - \else - \addpenalty\@secpenalty\addvspace\@tempskipa - \fi -% \ifnum#2=1\relax\@sectruletrue\fi - \@ifstar - {\@ssect{#3}{#4}{#5}{#6}}% - {\@dblarg{\@sect{#1}{#2}{#3}{#4}{#5}{#6}}}} -% -\def\@sect#1#2#3#4#5#6[#7]#8{% - \ifnum #2>\c@secnumdepth - \let\@svsec\@empty - \else - \refstepcounter{#1}% - \protected@edef\@svsec{\@seccntformat{#1}\relax}% - \fi - \@tempskipa #5\relax - \ifdim \@tempskipa>\z@ - \begingroup - #6{% \makesectrule - \@hangfrom{\hskip #3\relax\@svsec}% - \raggedright - \hyphenpenalty \@M% - \interlinepenalty \@M #8\@@par}% - \endgroup - \csname #1mark\endcsname{#7}% - \addcontentsline{toc}{#1}{% - \ifnum #2>\c@secnumdepth \else - \protect\numberline{\csname the#1\endcsname\sectcounterend}% - \fi - #7}% - \else - \def\@svsechd{% - #6{\hskip #3\relax - \@svsec #8\/\hskip\aftertext}% - \csname #1mark\endcsname{#7}% - \addcontentsline{toc}{#1}{% - \ifnum #2>\c@secnumdepth \else - \protect\numberline{\csname the#1\endcsname}% - \fi - #7}}% - \fi - \@xsect{#5}} -% -\def\@ssect#1#2#3#4#5{% - \@tempskipa #3\relax - \ifdim \@tempskipa>\z@ - \begingroup - #4{% \makesectrule - \@hangfrom{\hskip #1}% - \interlinepenalty \@M #5\@@par}% - \endgroup - \else - \def\@svsechd{#4{\hskip #1\relax #5}}% - \fi - \@xsect{#3}} - -% -% measures and setting of sections -% -\def\section{\@startsection{section}{1}{\z@}% - {-21dd plus-8pt minus-4pt}{10.5dd} - {\normalsize\bfseries\boldmath}} -\def\subsection{\@startsection{subsection}{2}{\z@}% - {-21dd plus-8pt minus-4pt}{10.5dd} - {\normalsize\upshape}} -\def\subsubsection{\@startsection{subsubsection}{3}{\z@}% - {-13dd plus-8pt minus-4pt}{10.5dd} - {\normalsize\itshape}} -\def\paragraph{\@startsection{paragraph}{4}{\z@}% - {-13pt plus-8pt minus-4pt}{\z@}{\normalsize\itshape}} - -\setlength\leftmargini {\parindent} -\leftmargin \leftmargini -\setlength\leftmarginii {\parindent} -\setlength\leftmarginiii {1.87em} -\setlength\leftmarginiv {1.7em} -\setlength\leftmarginv {.5em} -\setlength\leftmarginvi {.5em} -\setlength \labelsep {.5em} -\setlength \labelwidth{\leftmargini} -\addtolength\labelwidth{-\labelsep} -\@beginparpenalty -\@lowpenalty -\@endparpenalty -\@lowpenalty -\@itempenalty -\@lowpenalty -\renewcommand\theenumi{\@arabic\c@enumi} -\renewcommand\theenumii{\@alph\c@enumii} -\renewcommand\theenumiii{\@roman\c@enumiii} -\renewcommand\theenumiv{\@Alph\c@enumiv} -\newcommand\labelenumi{\theenumi.} -\newcommand\labelenumii{(\theenumii)} -\newcommand\labelenumiii{\theenumiii.} -\newcommand\labelenumiv{\theenumiv.} -\renewcommand\p@enumii{\theenumi} -\renewcommand\p@enumiii{\theenumi(\theenumii)} -\renewcommand\p@enumiv{\p@enumiii\theenumiii} -\newcommand\labelitemi{\normalfont\bfseries --} -\newcommand\labelitemii{\normalfont\bfseries --} -\newcommand\labelitemiii{$\m@th\bullet$} -\newcommand\labelitemiv{$\m@th\cdot$} - -\if@spthms -% definition of the "\spnewtheorem" command. -% -% Usage: -% -% \spnewtheorem{env_nam}{caption}[within]{cap_font}{body_font} -% or \spnewtheorem{env_nam}[numbered_like]{caption}{cap_font}{body_font} -% or \spnewtheorem*{env_nam}{caption}{cap_font}{body_font} -% -% New is "cap_font" and "body_font". It stands for -% fontdefinition of the caption and the text itself. -% -% "\spnewtheorem*" gives a theorem without number. -% -% A defined spnewthoerem environment is used as described -% by Lamport. -% -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -\def\@thmcountersep{} -\def\@thmcounterend{} -\newcommand\nocaption{\noexpand\@gobble} -\newdimen\spthmsep \spthmsep=5pt - -\def\spnewtheorem{\@ifstar{\@sthm}{\@Sthm}} - -% definition of \spnewtheorem with number - -\def\@spnthm#1#2{% - \@ifnextchar[{\@spxnthm{#1}{#2}}{\@spynthm{#1}{#2}}} -\def\@Sthm#1{\@ifnextchar[{\@spothm{#1}}{\@spnthm{#1}}} - -\def\@spxnthm#1#2[#3]#4#5{\expandafter\@ifdefinable\csname #1\endcsname - {\@definecounter{#1}\@addtoreset{#1}{#3}% - \expandafter\xdef\csname the#1\endcsname{\expandafter\noexpand - \csname the#3\endcsname \noexpand\@thmcountersep \@thmcounter{#1}}% - \expandafter\xdef\csname #1name\endcsname{#2}% - \global\@namedef{#1}{\@spthm{#1}{\csname #1name\endcsname}{#4}{#5}}% - \global\@namedef{end#1}{\@endtheorem}}} - -\def\@spynthm#1#2#3#4{\expandafter\@ifdefinable\csname #1\endcsname - {\@definecounter{#1}% - \expandafter\xdef\csname the#1\endcsname{\@thmcounter{#1}}% - \expandafter\xdef\csname #1name\endcsname{#2}% - \global\@namedef{#1}{\@spthm{#1}{\csname #1name\endcsname}{#3}{#4}}% - \global\@namedef{end#1}{\@endtheorem}}} - -\def\@spothm#1[#2]#3#4#5{% - \@ifundefined{c@#2}{\@latexerr{No theorem environment `#2' defined}\@eha}% - {\expandafter\@ifdefinable\csname #1\endcsname - {\global\@namedef{the#1}{\@nameuse{the#2}}% - \expandafter\xdef\csname #1name\endcsname{#3}% - \global\@namedef{#1}{\@spthm{#2}{\csname #1name\endcsname}{#4}{#5}}% - \global\@namedef{end#1}{\@endtheorem}}}} - -\def\@spthm#1#2#3#4{\topsep 7\p@ \@plus2\p@ \@minus4\p@ -\labelsep=\spthmsep\refstepcounter{#1}% -\@ifnextchar[{\@spythm{#1}{#2}{#3}{#4}}{\@spxthm{#1}{#2}{#3}{#4}}} - -\def\@spxthm#1#2#3#4{\@spbegintheorem{#2}{\csname the#1\endcsname}{#3}{#4}% - \ignorespaces} - -\def\@spythm#1#2#3#4[#5]{\@spopargbegintheorem{#2}{\csname - the#1\endcsname}{#5}{#3}{#4}\ignorespaces} - -\def\normalthmheadings{\def\@spbegintheorem##1##2##3##4{\trivlist\normalfont - \item[\hskip\labelsep{##3##1\ ##2\@thmcounterend}]##4} -\def\@spopargbegintheorem##1##2##3##4##5{\trivlist - \item[\hskip\labelsep{##4##1\ ##2}]{##4(##3)\@thmcounterend\ }##5}} -\normalthmheadings - -\def\reversethmheadings{\def\@spbegintheorem##1##2##3##4{\trivlist\normalfont - \item[\hskip\labelsep{##3##2\ ##1\@thmcounterend}]##4} -\def\@spopargbegintheorem##1##2##3##4##5{\trivlist - \item[\hskip\labelsep{##4##2\ ##1}]{##4(##3)\@thmcounterend\ }##5}} - -% definition of \spnewtheorem* without number - -\def\@sthm#1#2{\@Ynthm{#1}{#2}} - -\def\@Ynthm#1#2#3#4{\expandafter\@ifdefinable\csname #1\endcsname - {\global\@namedef{#1}{\@Thm{\csname #1name\endcsname}{#3}{#4}}% - \expandafter\xdef\csname #1name\endcsname{#2}% - \global\@namedef{end#1}{\@endtheorem}}} - -\def\@Thm#1#2#3{\topsep 7\p@ \@plus2\p@ \@minus4\p@ -\@ifnextchar[{\@Ythm{#1}{#2}{#3}}{\@Xthm{#1}{#2}{#3}}} - -\def\@Xthm#1#2#3{\@Begintheorem{#1}{#2}{#3}\ignorespaces} - -\def\@Ythm#1#2#3[#4]{\@Opargbegintheorem{#1} - {#4}{#2}{#3}\ignorespaces} - -\def\@Begintheorem#1#2#3{#3\trivlist - \item[\hskip\labelsep{#2#1\@thmcounterend}]} - -\def\@Opargbegintheorem#1#2#3#4{#4\trivlist - \item[\hskip\labelsep{#3#1}]{#3(#2)\@thmcounterend\ }} - -% initialize theorem environment - -\if@envcntsect - \def\@thmcountersep{.} - \spnewtheorem{theorem}{Theorem}[section]{\bfseries}{\itshape} -\else - \spnewtheorem{theorem}{Theorem}{\bfseries}{\itshape} - \if@envcntreset - \@addtoreset{theorem}{section} - \else - \@addtoreset{theorem}{chapter} - \fi -\fi - -%definition of divers theorem environments -\spnewtheorem*{claim}{Claim}{\itshape}{\rmfamily} -\spnewtheorem*{proof}{Proof}{\itshape}{\rmfamily} -\if@envcntsame % all environments like "Theorem" - using its counter - \def\spn@wtheorem#1#2#3#4{\@spothm{#1}[theorem]{#2}{#3}{#4}} -\else % all environments with their own counter - \if@envcntsect % show section counter - \def\spn@wtheorem#1#2#3#4{\@spxnthm{#1}{#2}[section]{#3}{#4}} - \else % not numbered with section - \if@envcntreset - \def\spn@wtheorem#1#2#3#4{\@spynthm{#1}{#2}{#3}{#4} - \@addtoreset{#1}{section}} - \else - \let\spn@wtheorem=\@spynthm - \fi - \fi -\fi -% -\let\spdefaulttheorem=\spn@wtheorem -% -\spn@wtheorem{case}{Case}{\itshape}{\rmfamily} -\spn@wtheorem{conjecture}{Conjecture}{\itshape}{\rmfamily} -\spn@wtheorem{corollary}{Corollary}{\bfseries}{\itshape} -\spn@wtheorem{definition}{Definition}{\bfseries}{\rmfamily} -\spn@wtheorem{example}{Example}{\itshape}{\rmfamily} -\spn@wtheorem{exercise}{Exercise}{\bfseries}{\rmfamily} -\spn@wtheorem{lemma}{Lemma}{\bfseries}{\itshape} -\spn@wtheorem{note}{Note}{\itshape}{\rmfamily} -\spn@wtheorem{problem}{Problem}{\bfseries}{\rmfamily} -\spn@wtheorem{property}{Property}{\itshape}{\rmfamily} -\spn@wtheorem{proposition}{Proposition}{\bfseries}{\itshape} -\spn@wtheorem{question}{Question}{\itshape}{\rmfamily} -\spn@wtheorem{solution}{Solution}{\bfseries}{\rmfamily} -\spn@wtheorem{remark}{Remark}{\itshape}{\rmfamily} -% -\newenvironment{theopargself} - {\def\@spopargbegintheorem##1##2##3##4##5{\trivlist - \item[\hskip\labelsep{##4##1\ ##2}]{##4##3\@thmcounterend\ }##5} - \def\@Opargbegintheorem##1##2##3##4{##4\trivlist - \item[\hskip\labelsep{##3##1}]{##3##2\@thmcounterend\ }}}{} -\newenvironment{theopargself*} - {\def\@spopargbegintheorem##1##2##3##4##5{\trivlist - \item[\hskip\labelsep{##4##1\ ##2}]{\hspace*{-\labelsep}##4##3\@thmcounterend}##5} - \def\@Opargbegintheorem##1##2##3##4{##4\trivlist - \item[\hskip\labelsep{##3##1}]{\hspace*{-\labelsep}##3##2\@thmcounterend}}}{} -% -\fi - -\def\@takefromreset#1#2{% - \def\@tempa{#1}% - \let\@tempd\@elt - \def\@elt##1{% - \def\@tempb{##1}% - \ifx\@tempa\@tempb\else - \@addtoreset{##1}{#2}% - \fi}% - \expandafter\expandafter\let\expandafter\@tempc\csname cl@#2\endcsname - \expandafter\def\csname cl@#2\endcsname{}% - \@tempc - \let\@elt\@tempd} - -\def\squareforqed{\hbox{\rlap{$\sqcap$}$\sqcup$}} -\def\qed{\ifmmode\else\unskip\quad\fi\squareforqed} -\def\smartqed{\def\qed{\ifmmode\squareforqed\else{\unskip\nobreak\hfil -\penalty50\hskip1em\null\nobreak\hfil\squareforqed -\parfillskip=0pt\finalhyphendemerits=0\endgraf}\fi}} - -% Define `abstract' environment -\def\abstract{\topsep=0pt\partopsep=0pt\parsep=0pt\itemsep=0pt\relax -\trivlist\item[\hskip\labelsep -{\bfseries\abstractname}]\if!\abstractname!\hskip-\labelsep\fi} -\if@twocolumn -% \if@avier -% \def\endabstract{\endtrivlist\addvspace{5mm}\strich} -% \def\strich{\hrule\vskip1ptplus12pt} -% \else - \def\endabstract{\endtrivlist\addvspace{3mm}} -% \fi -\else -\fi -% -\newenvironment{verse} - {\let\\\@centercr - \list{}{\itemsep \z@ - \itemindent -1.5em% - \listparindent\itemindent - \rightmargin \leftmargin - \advance\leftmargin 1.5em}% - \item\relax} - {\endlist} -\newenvironment{quotation} - {\list{}{\listparindent 1.5em% - \itemindent \listparindent - \rightmargin \leftmargin - \parsep \z@ \@plus\p@}% - \item\relax} - {\endlist} -\newenvironment{quote} - {\list{}{\rightmargin\leftmargin}% - \item\relax} - {\endlist} -\newcommand\appendix{\par\small - \setcounter{section}{0}% - \setcounter{subsection}{0}% - \renewcommand\thesection{\@Alph\c@section}} -\setlength\arraycolsep{1.5\p@} -\setlength\tabcolsep{6\p@} -\setlength\arrayrulewidth{.4\p@} -\setlength\doublerulesep{2\p@} -\setlength\tabbingsep{\labelsep} -\skip\@mpfootins = \skip\footins -\setlength\fboxsep{3\p@} -\setlength\fboxrule{.4\p@} -\renewcommand\theequation{\@arabic\c@equation} -\newcounter{figure} -\renewcommand\thefigure{\@arabic\c@figure} -\def\fps@figure{tbp} -\def\ftype@figure{1} -\def\ext@figure{lof} -\def\fnum@figure{\figurename~\thefigure} -\newenvironment{figure} - {\@float{figure}} - {\end@float} -\newenvironment{figure*} - {\@dblfloat{figure}} - {\end@dblfloat} -\newcounter{table} -\renewcommand\thetable{\@arabic\c@table} -\def\fps@table{tbp} -\def\ftype@table{2} -\def\ext@table{lot} -\def\fnum@table{\tablename~\thetable} -\newenvironment{table} - {\@float{table}} - {\end@float} -\newenvironment{table*} - {\@dblfloat{table}} - {\end@dblfloat} -% -\def \@floatboxreset {% - \reset@font - \small - \@setnobreak - \@setminipage -} -% -\newcommand{\tableheadseprule}{\noalign{\hrule height.375mm}} -% -\newlength\abovecaptionskip -\newlength\belowcaptionskip -\setlength\abovecaptionskip{10\p@} -\setlength\belowcaptionskip{0\p@} -\newcommand\leftlegendglue{} - -\def\fig@type{figure} - -\newdimen\figcapgap\figcapgap=3pt -\newdimen\tabcapgap\tabcapgap=5.5pt - -\@ifundefined{floatlegendstyle}{\def\floatlegendstyle{\bfseries}}{} - -\long\def\@caption#1[#2]#3{\par\addcontentsline{\csname - ext@#1\endcsname}{#1}{\protect\numberline{\csname - the#1\endcsname}{\ignorespaces #2}}\begingroup - \@parboxrestore - \@makecaption{\csname fnum@#1\endcsname}{\ignorespaces #3}\par - \endgroup} - -\def\capstrut{\vrule\@width\z@\@height\topskip} - -\@ifundefined{captionstyle}{\def\captionstyle{\normalfont\small}}{} - -\long\def\@makecaption#1#2{% - \captionstyle - \ifx\@captype\fig@type - \vskip\figcapgap - \fi - \setbox\@tempboxa\hbox{{\floatlegendstyle #1\floatcounterend}% - \capstrut #2}% - \ifdim \wd\@tempboxa >\hsize - {\floatlegendstyle #1\floatcounterend}\capstrut #2\par - \else - \hbox to\hsize{\leftlegendglue\unhbox\@tempboxa\hfil}% - \fi - \ifx\@captype\fig@type\else - \vskip\tabcapgap - \fi} - -\newdimen\figgap\figgap=1cc -\long\def\@makesidecaption#1#2{% - \parbox[b]{\@tempdimb}{\captionstyle{\floatlegendstyle - #1\floatcounterend}#2}} -\def\sidecaption#1\caption{% -\setbox\@tempboxa=\hbox{#1\unskip}% -\if@twocolumn - \ifdim\hsize<\textwidth\else - \ifdim\wd\@tempboxa<\columnwidth - \typeout{Double column float fits into single column - - ^^Jyou'd better switch the environment. }% - \fi - \fi -\fi -\@tempdimb=\hsize -\advance\@tempdimb by-\figgap -\advance\@tempdimb by-\wd\@tempboxa -\ifdim\@tempdimb<3cm - \typeout{\string\sidecaption: No sufficient room for the legend; - using normal \string\caption. }% - \unhbox\@tempboxa - \let\@capcommand=\@caption -\else - \let\@capcommand=\@sidecaption - \leavevmode - \unhbox\@tempboxa - \hfill -\fi -\refstepcounter\@captype -\@dblarg{\@capcommand\@captype}} - -\long\def\@sidecaption#1[#2]#3{\addcontentsline{\csname - ext@#1\endcsname}{#1}{\protect\numberline{\csname - the#1\endcsname}{\ignorespaces #2}}\begingroup - \@parboxrestore - \@makesidecaption{\csname fnum@#1\endcsname}{\ignorespaces #3}\par - \endgroup} - -% Define `acknowledgement' environment -\def\acknowledgement{\par\addvspace{17pt}\small\rmfamily -\trivlist\if!\ackname!\item[]\else -\item[\hskip\labelsep -{\bfseries\ackname}]\fi} -\def\endacknowledgement{\endtrivlist\addvspace{6pt}} -\newenvironment{acknowledgements}{\begin{acknowledgement}} -{\end{acknowledgement}} -% Define `noteadd' environment -\def\noteadd{\par\addvspace{17pt}\small\rmfamily -\trivlist\item[\hskip\labelsep -{\itshape\noteaddname}]} -\def\endnoteadd{\endtrivlist\addvspace{6pt}} - -\DeclareOldFontCommand{\rm}{\normalfont\rmfamily}{\mathrm} -\DeclareOldFontCommand{\sf}{\normalfont\sffamily}{\mathsf} -\DeclareOldFontCommand{\tt}{\normalfont\ttfamily}{\mathtt} -\DeclareOldFontCommand{\bf}{\normalfont\bfseries}{\mathbf} -\DeclareOldFontCommand{\it}{\normalfont\itshape}{\mathit} -\DeclareOldFontCommand{\sl}{\normalfont\slshape}{\@nomath\sl} -\DeclareOldFontCommand{\sc}{\normalfont\scshape}{\@nomath\sc} -\DeclareRobustCommand*\cal{\@fontswitch\relax\mathcal} -\DeclareRobustCommand*\mit{\@fontswitch\relax\mathnormal} -\newcommand\@pnumwidth{1.55em} -\newcommand\@tocrmarg{2.55em} -\newcommand\@dotsep{4.5} -\setcounter{tocdepth}{1} -\newcommand\tableofcontents{% - \section*{\contentsname}% - \@starttoc{toc}% - \addtocontents{toc}{\begingroup\protect\small}% - \AtEndDocument{\addtocontents{toc}{\endgroup}}% - } -\newcommand*\l@part[2]{% - \ifnum \c@tocdepth >-2\relax - \addpenalty\@secpenalty - \addvspace{2.25em \@plus\p@}% - \begingroup - \setlength\@tempdima{3em}% - \parindent \z@ \rightskip \@pnumwidth - \parfillskip -\@pnumwidth - {\leavevmode - \large \bfseries #1\hfil \hb@xt@\@pnumwidth{\hss #2}}\par - \nobreak - \if@compatibility - \global\@nobreaktrue - \everypar{\global\@nobreakfalse\everypar{}}% - \fi - \endgroup - \fi} -\newcommand*\l@section{\@dottedtocline{1}{0pt}{1.5em}} -\newcommand*\l@subsection{\@dottedtocline{2}{1.5em}{2.3em}} -\newcommand*\l@subsubsection{\@dottedtocline{3}{3.8em}{3.2em}} -\newcommand*\l@paragraph{\@dottedtocline{4}{7.0em}{4.1em}} -\newcommand*\l@subparagraph{\@dottedtocline{5}{10em}{5em}} -\newcommand\listoffigures{% - \section*{\listfigurename - \@mkboth{\listfigurename}% - {\listfigurename}}% - \@starttoc{lof}% - } -\newcommand*\l@figure{\@dottedtocline{1}{1.5em}{2.3em}} -\newcommand\listoftables{% - \section*{\listtablename - \@mkboth{\listtablename}{\listtablename}}% - \@starttoc{lot}% - } -\let\l@table\l@figure -\newdimen\bibindent -\setlength\bibindent{\parindent} -\def\@biblabel#1{#1.} -\def\@lbibitem[#1]#2{\item[{[#1]}\hfill]\if@filesw - {\let\protect\noexpand - \immediate - \write\@auxout{\string\bibcite{#2}{#1}}}\fi\ignorespaces} -\newenvironment{thebibliography}[1] - {\section*{\refname - \@mkboth{\refname}{\refname}}\small - \list{\@biblabel{\@arabic\c@enumiv}}% - {\settowidth\labelwidth{\@biblabel{#1}}% - \leftmargin\labelwidth - \advance\leftmargin\labelsep - \@openbib@code - \usecounter{enumiv}% - \let\p@enumiv\@empty - \renewcommand\theenumiv{\@arabic\c@enumiv}}% - \sloppy\clubpenalty4000\widowpenalty4000% - \sfcode`\.\@m} - {\def\@noitemerr - {\@latex@warning{Empty `thebibliography' environment}}% - \endlist} -% -\newcount\@tempcntc -\def\@citex[#1]#2{\if@filesw\immediate\write\@auxout{\string\citation{#2}}\fi - \@tempcnta\z@\@tempcntb\m@ne\def\@citea{}\@cite{\@for\@citeb:=#2\do - {\@ifundefined - {b@\@citeb}{\@citeo\@tempcntb\m@ne\@citea\def\@citea{,}{\bfseries - ?}\@warning - {Citation `\@citeb' on page \thepage \space undefined}}% - {\setbox\z@\hbox{\global\@tempcntc0\csname b@\@citeb\endcsname\relax}% - \ifnum\@tempcntc=\z@ \@citeo\@tempcntb\m@ne - \@citea\def\@citea{,\hskip0.1em\ignorespaces}\hbox{\csname b@\@citeb\endcsname}% - \else - \advance\@tempcntb\@ne - \ifnum\@tempcntb=\@tempcntc - \else\advance\@tempcntb\m@ne\@citeo - \@tempcnta\@tempcntc\@tempcntb\@tempcntc\fi\fi}}\@citeo}{#1}} -\def\@citeo{\ifnum\@tempcnta>\@tempcntb\else - \@citea\def\@citea{,\hskip0.1em\ignorespaces}% - \ifnum\@tempcnta=\@tempcntb\the\@tempcnta\else - {\advance\@tempcnta\@ne\ifnum\@tempcnta=\@tempcntb \else \def\@citea{--}\fi - \advance\@tempcnta\m@ne\the\@tempcnta\@citea\the\@tempcntb}\fi\fi} -% -\newcommand\newblock{\hskip .11em\@plus.33em\@minus.07em} -\let\@openbib@code\@empty -\newenvironment{theindex} - {\if@twocolumn - \@restonecolfalse - \else - \@restonecoltrue - \fi - \columnseprule \z@ - \columnsep 35\p@ - \twocolumn[\section*{\indexname}]% - \@mkboth{\indexname}{\indexname}% - \thispagestyle{plain}\parindent\z@ - \parskip\z@ \@plus .3\p@\relax - \let\item\@idxitem} - {\if@restonecol\onecolumn\else\clearpage\fi} -\newcommand\@idxitem{\par\hangindent 40\p@} -\newcommand\subitem{\@idxitem \hspace*{20\p@}} -\newcommand\subsubitem{\@idxitem \hspace*{30\p@}} -\newcommand\indexspace{\par \vskip 10\p@ \@plus5\p@ \@minus3\p@\relax} - -\if@twocolumn - \renewcommand\footnoterule{% - \kern-3\p@ - \hrule\@width\columnwidth - \kern2.6\p@} -\else - \renewcommand\footnoterule{% - \kern-3\p@ - \hrule\@width.382\columnwidth - \kern2.6\p@} -\fi -\newcommand\@makefntext[1]{% - \noindent - \hb@xt@\bibindent{\hss\@makefnmark\enspace}#1} -% -\def\trans@english{\switcht@albion} -\def\trans@french{\switcht@francais} -\def\trans@german{\switcht@deutsch} -\newenvironment{translation}[1]{\if!#1!\else -\@ifundefined{selectlanguage}{\csname trans@#1\endcsname}{\selectlanguage{#1}}% -\fi}{} -% languages -% English section -\def\switcht@albion{%\typeout{English spoken.}% - \def\abstractname{Abstract}% - \def\ackname{Acknowledgements}% - \def\andname{and}% - \def\lastandname{, and}% - \def\appendixname{Appendix}% - \def\chaptername{Chapter}% - \def\claimname{Claim}% - \def\conjecturename{Conjecture}% - \def\contentsname{Contents}% - \def\corollaryname{Corollary}% - \def\definitionname{Definition}% - \def\emailname{E-mail}% - \def\examplename{Example}% - \def\exercisename{Exercise}% - \def\figurename{Fig.}% - \def\keywordname{{\bfseries Keywords}}% - \def\indexname{Index}% - \def\lemmaname{Lemma}% - \def\contriblistname{List of Contributors}% - \def\listfigurename{List of Figures}% - \def\listtablename{List of Tables}% - \def\mailname{{\itshape Correspondence to\/}:}% - \def\noteaddname{Note added in proof}% - \def\notename{Note}% - \def\partname{Part}% - \def\problemname{Problem}% - \def\proofname{Proof}% - \def\propertyname{Property}% - \def\questionname{Question}% - \def\refname{References}% - \def\remarkname{Remark}% - \def\seename{see}% - \def\solutionname{Solution}% - \def\tablename{Table}% - \def\theoremname{Theorem}% -}\switcht@albion % make English default -% -% French section -\def\switcht@francais{\svlanginfo -%\typeout{On parle francais.}% - \def\abstractname{R\'esum\'e\runinend}% - \def\ackname{Remerciements\runinend}% - \def\andname{et}% - \def\lastandname{ et}% - \def\appendixname{Appendice}% - \def\chaptername{Chapitre}% - \def\claimname{Pr\'etention}% - \def\conjecturename{Hypoth\`ese}% - \def\contentsname{Table des mati\`eres}% - \def\corollaryname{Corollaire}% - \def\definitionname{D\'efinition}% - \def\emailname{E-mail}% - \def\examplename{Exemple}% - \def\exercisename{Exercice}% - \def\figurename{Fig.}% - \def\keywordname{{\bfseries Mots-cl\'e\runinend}}% - \def\indexname{Index}% - \def\lemmaname{Lemme}% - \def\contriblistname{Liste des contributeurs}% - \def\listfigurename{Liste des figures}% - \def\listtablename{Liste des tables}% - \def\mailname{{\itshape Correspondence to\/}:}% - \def\noteaddname{Note ajout\'ee \`a l'\'epreuve}% - \def\notename{Remarque}% - \def\partname{Partie}% - \def\problemname{Probl\`eme}% - \def\proofname{Preuve}% - \def\propertyname{Caract\'eristique}% -%\def\propositionname{Proposition}% - \def\questionname{Question}% - \def\refname{Bibliographie}% - \def\remarkname{Remarque}% - \def\seename{voyez}% - \def\solutionname{Solution}% -%\def\subclassname{{\it Subject Classifications\/}:}% - \def\tablename{Tableau}% - \def\theoremname{Th\'eor\`eme}% -} -% -% German section -\def\switcht@deutsch{\svlanginfo -%\typeout{Man spricht deutsch.}% - \def\abstractname{Zusammenfassung\runinend}% - \def\ackname{Danksagung\runinend}% - \def\andname{und}% - \def\lastandname{ und}% - \def\appendixname{Anhang}% - \def\chaptername{Kapitel}% - \def\claimname{Behauptung}% - \def\conjecturename{Hypothese}% - \def\contentsname{Inhaltsverzeichnis}% - \def\corollaryname{Korollar}% -%\def\definitionname{Definition}% - \def\emailname{E-Mail}% - \def\examplename{Beispiel}% - \def\exercisename{\"Ubung}% - \def\figurename{Abb.}% - \def\keywordname{{\bfseries Schl\"usselw\"orter\runinend}}% - \def\indexname{Index}% -%\def\lemmaname{Lemma}% - \def\contriblistname{Mitarbeiter}% - \def\listfigurename{Abbildungsverzeichnis}% - \def\listtablename{Tabellenverzeichnis}% - \def\mailname{{\itshape Correspondence to\/}:}% - \def\noteaddname{Nachtrag}% - \def\notename{Anmerkung}% - \def\partname{Teil}% -%\def\problemname{Problem}% - \def\proofname{Beweis}% - \def\propertyname{Eigenschaft}% -%\def\propositionname{Proposition}% - \def\questionname{Frage}% - \def\refname{Literatur}% - \def\remarkname{Anmerkung}% - \def\seename{siehe}% - \def\solutionname{L\"osung}% -%\def\subclassname{{\it Subject Classifications\/}:}% - \def\tablename{Tabelle}% -%\def\theoremname{Theorem}% -} -\newcommand\today{} -\edef\today{\ifcase\month\or - January\or February\or March\or April\or May\or June\or - July\or August\or September\or October\or November\or December\fi - \space\number\day, \number\year} -\setlength\columnsep{1.5cc} -\setlength\columnseprule{0\p@} -% -\frenchspacing -\clubpenalty=10000 -\widowpenalty=10000 -\def\thisbottomragged{\def\@textbottom{\vskip\z@ plus.0001fil -\global\let\@textbottom\relax}} -\pagestyle{headings} -\pagenumbering{arabic} -\if@twocolumn - \twocolumn -\fi -%\if@avier -% \onecolumn -% \setlength{\textwidth}{156mm} -% \setlength{\textheight}{226mm} -%\fi -\if@referee - \makereferee -\fi -\flushbottom -\endinput -%% -%% End of file `svjour3.cls'.
--- a/doc/graal.doxy Wed Jun 08 14:01:51 2011 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1661 +0,0 @@ -# Doxyfile 1.7.1 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project -# -# All text after a hash (#) is considered a comment and will be ignored -# The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. - -PROJECT_NAME = GRAAL - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. - -PROJECT_NUMBER = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. - -OUTPUT_DIRECTORY = . - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. - -CREATE_SUBDIRS = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief -# description. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. - -FULL_PATH_NAMES = YES - -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems -# doesn't support long names like on DOS, Mac, or CD-ROM. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) - -JAVADOC_AUTOBRIEF = NO - -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. - -TAB_SIZE = 8 - -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. - -OPTIMIZE_OUTPUT_JAVA = YES - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this -# tag. The format is ext=language, where ext is a file extension, and language -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. - -EXTENSION_MAPPING = - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen to replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. - -SUBGROUPING = YES - -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. - -TYPEDEF_HIDES_STRUCT = NO - -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penality. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will rougly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols - -SYMBOL_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespace are hidden. - -EXTRACT_ANON_NSPACES = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. - -HIDE_SCOPE_NAMES = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. - -SHOW_INCLUDE_FILES = YES - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. - -SORT_BY_SCOPE_NAME = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. - -SHOW_USED_FILES = YES - -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command <command> <input-file>, where <command> is the value of -# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. The create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. -# You can optionally specify a file name after the option, if omitted -# DoxygenLayout.xml will be used as the name of the layout file. - -LAYOUT_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. - -WARNINGS = YES - -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. - -WARN_IF_UNDOCUMENTED = YES - -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be abled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. - -WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. - -INPUT = src - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 - -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.d \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.idl \ - *.odl \ - *.cs \ - *.php \ - *.php3 \ - *.inc \ - *.m \ - *.mm \ - *.dox \ - *.py \ - *.f90 \ - *.f \ - *.vhd \ - *.vhdl - -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded -# from the input. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command <filter> <input-file>, where <filter> -# is the value of the INPUT_FILTER tag, and <input-file> is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be -# ignored. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER -# is applied to all files. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). - -FILTER_SOURCE_FILES = NO - -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. - -SOURCE_BROWSER = YES - -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. - -STRIP_CODE_COMMENTS = NO - -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. Otherwise they will link to the documentation. - -REFERENCES_LINK_SOURCE = YES - -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. - -ALPHABETICAL_INDEX = YES - -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! - -HTML_STYLESHEET = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the stylesheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. -# The allowed range is 0 to 359. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use -# grayscales only. A value of 255 will produce the most vivid colors. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, -# and 100 does not change the gamma. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. - -HTML_TIMESTAMP = YES - -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). - -HTML_DYNAMIC_SECTIONS = NO - -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. - -GENERATE_DOCSET = NO - -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = - -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. - -HHC_LOCATION = - -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). - -GENERATE_CHI = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. - -CHM_INDEX_ENCODING = - -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a -# Qt Compressed Help (.qch) of the generated HTML documentation. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders - -QHP_VIRTUAL_FOLDER = doc - -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> -# Qt Help Project / Custom Filters</a>. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's -# filter section matches. -# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> -# Qt Help Project / Filter Attributes</a>. - -QHP_SECT_FILTER_ATTRS = - -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before -# the help appears. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. - -DISABLE_INDEX = NO - -# This tag can be used to set the number of enum values (range [1..20]) -# that doxygen will group on one line in the generated HTML documentation. - -ENUM_VALUES_PER_LINE = 4 - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. - -GENERATE_TREEVIEW = YES - -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. - -USE_INLINE_TREES = NO - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. - -TREEVIEW_WIDTH = 250 - -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. - -EXT_LINKS_IN_WINDOW = NO - -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern browsers. -# Note that when changing this option you need to delete any form_*.png files -# in the HTML output before the changes have effect. - -FORMULA_TRANSPARENT = YES - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box -# for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets -# (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. - -SEARCHENGINE = YES - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a PHP enabled web server instead of at the web client -# using Javascript. Doxygen will generate the search PHP script and index -# file to put on the web server. The advantage of the server -# based approach is that it scales better to large projects and allows -# full text search. The disadvances is that it is more difficult to setup -# and does not have live searching capabilities. - -SERVER_BASED_SEARCH = NO - -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will -# generate Latex output. - -GENERATE_LATEX = YES - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `latex' will be used as the default path. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the -# default command name. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and -# executive. If left blank a4wide will be used. - -PAPER_TYPE = a4wide - -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX -# packages that should be included in the LaTeX output. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a -# standard header. Notice: only use this tag if you know what you are doing! - -LATEX_HEADER = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references -# This makes the output suitable for online browsing using a pdf viewer. - -PDF_HYPERLINKS = YES - -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a -# higher quality PDF documentation. - -USE_PDFLATEX = YES - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. -# This option is also used when generating formulas in HTML. - -LATEX_BATCHMODE = NO - -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. - -LATEX_HIDE_INDICES = NO - -# If LATEX_SOURCE_CODE is set to YES then doxygen will include -# source code with syntax highlighting in the LaTeX output. -# Note that which sources are shown also depends on other settings -# such as SOURCE_BROWSER. - -LATEX_SOURCE_CODE = NO - -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with -# other RTF readers or editors. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `rtf' will be used as the default path. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. -# Note: wordpad (write) and others do not support links. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide -# replacements, missing definitions are set to their default value. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an rtf document. -# Syntax is similar to doxygen's config file. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will -# generate man pages - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `man' will be used as the default path. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to -# the generated man pages (default is the subroutine's section .3) - -MAN_EXTENSION = .3 - -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command -# would be unable to find the correct page. The default is NO. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of -# the code including all documentation. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `xml' will be used as the default path. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental -# and incomplete at the moment. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able -# to generate PDF and DVI output from the Perl module output. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller -# and Perl will parse it just the same. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same -# Makefile don't overwrite each other's variables. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include -# files. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled -# way by setting EXPAND_ONLY_PREDEF to YES. - -MACRO_EXPANSION = NO - -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the -# PREDEFINED and EXPAND_AS_DEFINED tags. - -EXPAND_ONLY_PREDEF = NO - -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# in the INCLUDE_PATH (see below) will be search if a #include is found. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by -# the preprocessor. - -INCLUDE_PATH = - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will -# be used. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. - -PREDEFINED = - -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse -# the parser if not removed. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create -# a tag file that is based on the input files it reads. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes -# will be listed. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will -# be listed. - -EXTERNAL_GROUPS = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of `which perl'). - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option is superseded by the HAVE_DOT option below. This is only a -# fallback. It is recommended to install and use dot, since it yields more -# powerful graphs. - -CLASS_DIAGRAMS = NO - -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. - -HIDE_UNDOC_RELATIONS = NO - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section -# have no effect if this option is set to NO (the default) - -HAVE_DOT = YES - -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is -# allowed to run in parallel. When set to 0 (the default) doxygen will -# base this on the number of processors available in the system. You can set it -# explicitly to a value larger than 0 to get control over the balance -# between CPU load and processing speed. - -DOT_NUM_THREADS = 0 - -# By default doxygen will write a font called FreeSans.ttf to the output -# directory and reference it in all dot files that doxygen generates. This -# font does not include all possible unicode characters however, so when you need -# these (or just want a differently looking font) you can specify the font name -# using DOT_FONTNAME. You need need to make sure dot is able to find the font, -# which can be done by putting it in a standard location or by setting the -# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory -# containing the font. - -DOT_FONTNAME = FreeSans.ttf - -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. -# The default size is 10pt. - -DOT_FONTSIZE = 10 - -# By default doxygen will tell dot to use the output directory to look for the -# FreeSans.ttf font (which doxygen will put there itself). If you specify a -# different font using DOT_FONTNAME you can set the path where dot -# can find it using this tag. - -DOT_FONTPATH = - -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# the CLASS_DIAGRAMS tag to NO. - -CLASS_GRAPH = YES - -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and -# class references variables) of the class with other documented classes. - -COLLABORATION_GRAPH = YES - -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for groups, showing the direct groups dependencies - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. - -UML_LOOK = YES - -# If set to YES, the inheritance and collaboration graphs will show the -# relations between templates and their instances. - -TEMPLATE_RELATIONS = NO - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with -# other documented files. - -INCLUDE_GRAPH = YES - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or -# indirectly include this file. - -INCLUDED_BY_GRAPH = YES - -# If the CALL_GRAPH and HAVE_DOT options are set to YES then -# doxygen will generate a call dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable call graphs -# for selected functions only using the \callgraph command. - -CALL_GRAPH = NO - -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then -# doxygen will generate a caller dependency graph for every global function -# or class method. Note that enabling this option will significantly increase -# the time of a run. So in most cases it will be better to enable caller -# graphs for selected functions only using the \callergraph command. - -CALLER_GRAPH = NO - -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will graphical hierarchy of all classes instead of a textual one. - -GRAPHICAL_HIERARCHY = YES - -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include -# relations between the files in the directories. - -DIRECTORY_GRAPH = YES - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are png, jpg, or gif -# If left blank png will be used. - -DOT_IMAGE_FORMAT = png - -# The tag DOT_PATH can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found in the path. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the -# \dotfile command). - -DOTFILE_DIRS = - -# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of -# nodes that will be shown in the graph. If the number of nodes in a graph -# becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the -# number of direct children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note -# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. - -DOT_GRAPH_MAX_NODES = 500 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that the size of a graph can be further restricted by -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. - -MAX_DOT_GRAPH_DEPTH = 0 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not -# seem to support this out of the box. Warning: Depending on the platform used, -# enabling this option may lead to badly anti-aliased labels on the edges of -# a graph (i.e. they become hard to read). - -DOT_TRANSPARENT = NO - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) -# support this, this feature is disabled by default. - -DOT_MULTI_TARGETS = YES - -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and -# arrows in the dot generated graphs. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate -# the various graphs. - -DOT_CLEANUP = YES
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/graal/com.oracle.max.graal.doc.initial/.project Wed Jun 08 14:06:17 2011 +0200 @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>com.oracle.max.graal.doc.initial</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>net.sourceforge.texlipse.builder.TexlipseBuilder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>net.sourceforge.texlipse.builder.TexlipseNature</nature> + </natures> + <linkedResources> + <link> + <name>fleqn.clo</name> + <type>1</type> + <location>C:/Program Files (x86)/MiKTeX 2.8/tex/latex/base/fleqn.clo</location> + </link> + </linkedResources> +</projectDescription>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/graal/com.oracle.max.graal.doc.initial/.texlipse Wed Jun 08 14:06:17 2011 +0200 @@ -0,0 +1,13 @@ +#TeXlipse project settings +#Fri Apr 29 14:13:11 CEST 2011 +builderNum=2 +outputDir= +makeIndSty= +bibrefDir= +outputFormat=pdf +tempDir=tmp +mainTexFile=graal_compiler.tex +outputFile=graal_compiler.pdf +langSpell=en +markDer=true +srcDir=
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/graal/com.oracle.max.graal.doc.initial/graal_compiler.tex Wed Jun 08 14:06:17 2011 +0200 @@ -0,0 +1,846 @@ +\documentclass[twocolumn]{svjour3} +\usepackage{listings} +\usepackage[pdftex]{graphicx} +\usepackage{environ} +\usepackage{amsmath} +\usepackage{amsfonts} +\usepackage[english]{babel} +\usepackage[utf8]{inputenc} +\usepackage{lmodern} +\usepackage[T1]{fontenc} +\usepackage{color} + +\input{graphdrawing} + +\renewcommand*\descriptionlabel[1]{\hspace\labelsep\normalfont\bf #1} + +\newcommand{\Sa}{{\Large$^*$}} +\newcommand{\Sb}{{\Large$^\dag$}} +\newcommand{\Sc}{{\Large$^\S$}} + + +\newcommand{\mynote}[2]{ +\textcolor{red}{\fbox{\bfseries\sffamily\scriptsize#1} + {\small\textsf{\emph{#2}}} +\fbox{\bfseries\sffamily\scriptsize }}} + +\newcommand\TODO[1]{\mynote{TODO}{#1}} +\newcommand\cw[1]{\mynote{CW}{#1}} +\newcommand\ls[1]{\mynote{LS}{#1}} +\newcommand\nodename[1]{\texttt{#1}} + + + +\smartqed % flush right qed marks, e.g. at end of proof + +\journalname{Graal Compiler Design} +\def\makeheadbox{{% +\hbox to0pt{\vbox{\baselineskip=10dd\hrule\hbox +to\hsize{\vrule\kern3pt\vbox{\kern3pt +\hbox{\bfseries The Graal Compiler - Design and Strategy} +\kern3pt}\hfil\kern3pt\vrule}\hrule}% +\hss}}} + +\begin{document} + +\author{Thomas W\"{u}rthinger \Sa, Lukas Stadler \Sc, Gilles Duboscq \Sa} +\institute{\Sa Oracle, \Sc Johannes Kepler University, Linz} + +\date{Created: \today} + +\title{The Graal Compiler} +\subtitle{Design and Strategy \\ \textcolor{red}{work in progress (Oracle internal)}} + +\maketitle + +\abstract{ +The Graal compiler (simply referred to as \emph{the compiler} in the rest of this document) aims at improving upon C1X, the Java port of the HotSpot client compiler, both in terms of modularity and peak performance. +The compiler should work with the Maxine VM and the HotSpot VM. +This document contains information about the proposed design and strategy for developing the compiler.} + +\section{Context} + +In 2009, the Maxine team started with creating C1X, a Java port of the HotSpot client compiler, and integrated it into the Maxine VM. +Part of this effort was the development of a clear and clean compiler-runtime interface that allows the separation of the compiler and the VM. +This compiler-runtime interface enables the use of one compiler for multiple VMs. +In June 2010, we started integrating C1X into the HotSpot VM and we called the resulting system Graal~VM. +Currently, the Graal~VM is fully functional and runs benchmarks (SciMark, DaCapo) at a similar speed as the HotSpot client compiler. + +\section{Goals} +The compiler effort aims at rewriting the high-level intermediate representation of C1X with two main goals: +\begin{description} +\item[Modularity:] A modular design of the compiler should simplify the implementation of new languages, new back-ends, and new optimizations. +\item[Peak Performance:] A more powerful intermediate representation should enable the implementation of aggressive optimizations that impact the peak performance of the resulting machine code. +\end{description} + +\section{Design} +For the implementation of the compiler, we rely on the following design decisions: +\begin{description} +\item[Graph Representation:] +The compiler's intermediate representation is modeled as a graph with nodes that are connected with directed edges. +There is only a single node base class and every node has an associated graph object that does not change during the node's lifetime. +Every node is serializable and has an id that is unique within its graph. +Every edge is classified as either a control flow edge (anti-dependency) or a data flow edge (dependency) and represented as a simple pointer from the source node to the target node. +It is possible to replace a node with another node without traversing the full graph. +The graph does not allow data flow edge cycles or control flow edge cycles. +We achieve this by explicitly modeling loops (see Section~\ref{sec:loops}). +\item[Extensibility:] +The compiler is extensible by allowing developers to add new compiler phases and new node subclasses without modifying the compiler's sources. +A node has an abstract way of expressing its semantics and new compiler phases can ask compiler nodes for their properties and capabilities. +We use the ``everything is an extension'' concept. +Even standard compiler optimizations are internally modeled as extensions, to show that the extension mechanism exposes all necessary functionality. +\item[Detailing:] +The compilation starts with a graph that contains nodes that represent the operations of the source language (e.g., one node for an array store to an object array). +During the compilation, the nodes are replaced with more detailed nodes (e.g., the array store node is split into a null check, a bounds check, a store check, and a memory access). +Compiler phases can choose whether they want to work on the earlier versions of the graph (e.g., escape analysis) or on later versions (e.g., null check elimination). +\item[Generality:] +The compiler does not require Java as its input. +This is achieved by having a graph as the starting point of the compilation and not a Java bytecode array. +Building the graph from the Java bytecodes must happen before giving a method to the compiler. +This enables front-ends for different languages (e.g., Ruby or JavaScript) to provide their own graph. +Also, there is no dependency on a specific back-end, but the output of the compiler is a graph that can then be converted to a different representation in a final compiler phase. +\end{description} + +\section{Milestones} +\label{sec:mile} +The compiler is being developed starting from the current C1X source code base. +This helps us test the compiler at every intermediate development step on a variety of Java benchmarks. +We define the following development milestones (see Section~\ref{sec:conclusions} for planned dates): +\begin{description} +\item[M1:] We have a fully working Graal~VM version with a stripped down C1X compiler that does not perform any optimization. +\item[M2:] We modified the high-level intermediate representation to be based on the compiler graph data structure. +\item[M3:] We have reimplemented and reenabled compiler optimizations in the compiler that previously existed in C1X. +\item[M4:] We have reintegrated the new compiler into the Maxine VM and can use it as a Maxine VM bootstrapping compiler. +\end{description} + +After those four milestones, we see three different possible further development directions that can be followed in parallel: +\begin{itemize} + \item Removal of the XIR template mechanism and replacement with a snippet mechanism that works with the compiler graph. + \item Improvements for peak performance (loop optimizations, escape analysis, bounds check elimination, processing additional interpreter runtime feedback). + \item Implementation of a prototype front-end for a different language, e.g., JavaScript. +\end{itemize} + +\section{Project Source Structure} +In order to support the goal of a modular compiler, the code will be divided into the following source code projects (as subprojects of \textbf{com.oracle.max.graal}). + +\begin{description} + \item[graph] contains the abstract node implementation, the graph implementation and all the associated tools and auxiliary classes. + \item[nodes] contains the implementation of known basic nodes (e.g., phi nodes, control flow nodes, \ldots). + Additional node classes should go into separate projects and be specializations of the known basic nodes. + \item[java] contains code for building graphs from Java bytecodes and Java-specific nodes. + \item[opt] contains optimizations such as global value numbering or conditional constant propagation. + \item[compiler] contains the compiler, including: + \begin{itemize} + \item Scheduling of the compilation phases. + \item Implementation of the \emph{compiler interface} (CI). + \item Implementation of the final compilation phase that produces the low-level representation. + \item Machine code creation, including debug info. + \end{itemize} +\end{description} + + +\section{Graph} + +The \emph{intermediate representation}~(IR) of the compiler is designed as a directed graph. +The graph allocates unique ids for new nodes and can be queried for the node corresponding to a given id as well as for an unordered list of nodes of the graph. +Graphs can manage side data structures (e.g. dominator trees and temporary schedules), which will be automatically invalidated and lazily recomputed whenever the graph changes. These side data structures will usually be understood by more than one optimization. + +The nodes of the graph have the following properties: +\begin{itemize} + \item Each node is always associated with a single graph and this association is immutable. + \item Each node has an immutable id that is unique within its associated graph. + \item Nodes can have a data dependency, which means that one node requires the result of another node as its input. The fact that the result of the first node needs to be computed before the second node can be executed introduces a partial order to the set of nodes. + \item Nodes can have a control flow dependency, which means that the execution of one node will be followed by the execution of another node. This includes conditional execution, memory access serialization and other reasons, and again introduces a partial order to the set of nodes. + \item Nodes can only have data and control dependencies to nodes which belong to the same graph. + \item Control dependencies and data dependencies each represent a \emph{directed acyclic graph} (DAG) on the same set of nodes. This means that data dependencies always point upwards, and control dependencies always point downwards in a drawing of the graph. Situations that normally incur cycles (like loops) are represented by special nodes (see Section~\ref{sec:loops}). + \item Ordering between nodes is specified only to the extent which is required to correctly express the semantics of a given program. This gives the compiler flexibility for the possible scheduling of a node and therefore wiggle room for optimizations. For algorithms that require a fixed ordering of nodes, a temporary schedule can always be generated. + \item Both data and control dependencies can be traversed in both directions, so that each node can be traversed in four directions (see Figure~\ref{fig:directions}): + \begin{itemize} + \item \emph{inputs} are all nodes that this node has data dependencies on. + \item \emph{usages} are all nodes whose inputs contain this node. + \item \emph{successors} are all nodes that have to be after this node in control flow. + \item \emph{predecessors} are all nodes whose successors contain this node. + \end{itemize} + \item Only inputs and successors can be changed, and changes to them will update the usages and predecessors. + \item Every node must be able to support cloning and serialization. + \item The edges of a node also define \textit{happens-before} and \textit{happens-after} relationships as shown in Figure~\ref{fig:directions}. +\end{itemize} + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{graphdirections} +\node{node1}{Node} +\textnode{inputs}{inputs} +\textnode{usages}{usages} +\textnode{successors}{successors} +\textnode{predecessors}{predecessors} +\data{node1}{inputs} +\control{node1}{successors} +\data{usages}{node1} +\control{predecessors}{node1} +\node{node2}{Node} +\textnode{before}{happens-before} +\textnode{after}{happens-after} +\data{node2}{before} +\control{node2}{after} +\data{after}{node2} +\control{before}{node2} +\end{digraphenv} + \caption{A node and its edges.} + \label{fig:directions} +\end{figure} + +\subsection{Inlining} +Inlining is always performed by embedding one graph into another graph. +Nodes cannot be reassigned to another graph, they are cloned instead. +Therefore, inlining is performed by copying and rewiring the nodes of the inlined method into the graph of the outer method. +While the copying will decrease compilation performance, it enables us to cache the graph for the inlined method, optimize it independently from the outer method, and use the optimized graph for subsequent inlinings. +We do not expect a significant negative impact on overall compilation performance. + +We are able to perform the inlining at any point during the compilation of a method and can therefore selectively expand the inlining if a certain optimization turns out to depend on the inlining of a method. +An example for this would be when the escape analysis finds out that a certain object only escapes because of one method call and this method call is not inlined, because the penalty was to high. +In this case, we can chose to nevertheless inline the method in order to increase the chances for finding out that the object does not escape. + +\section{Control Flow} + +Control flow is managed in way where the predecessor node contains direct pointers to its successor nodes. +We reserve the term \textit{instruction} for nodes that are embedded in the control flow. +This is opposite to the approach taken in the server compiler, where control flow and data flow edges point in the same direction. +The advantage that we see in our approach is that there is no need for projection nodes in case of control flow splits. +An \texttt{If} instruction can directly point to its true and false successors without any intermediate nodes. +This makes the graph more compact and simplifies graph traversal. + +Listing~\ref{lst:cfg2} shows an example Java program with an if statement where both paths do not contain any instruction with side effects. +The \texttt{If} instruction can directly point its true and false successors to a \texttt{Merge} instruction. +A \texttt{Phi} node that selects the appropriate value is appended to the \texttt{Merge} instruction. +The \texttt{Return} instruction then has a data dependency on the \texttt{Phi} node. + +\begin{lstlisting}[label=lst:cfg2, caption=Control flow in the graph., captionpos=b] +if (condition) { return 0; } +else { return 1; } +\end{lstlisting} + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{cfg2} +\textnode{entry}{Entry} +\textnode{condition}{condition} +\textnode{const0}{0} +\textnode{const1}{1} +\nodesplit{if}{If} +\control{entry}{if} +\controllabel{if:succ1}{merge} +\controllabel{if:succ2}{merge} +\data{if}{condition} +\node{merge}{Merge} +\node{return}{Return} +\nodetri{phi}{Phi} +\datalabel{phi:in1}{merge} +\datalabel{phi:in2}{const0} +\datalabel{phi:in3}{const1} +\data{return}{phi} +\control{merge}{return} +\end{digraphenv} + \caption{A simple loop with two exits.} + \label{fig:exc1} +\end{figure} + +\section{Exceptions} +\label{sec:Exceptions} + +We do not throw runtime exceptions (e.g., \texttt{IndexOutOf\-BoundsException}, \texttt{NullPointerException}, or \texttt{Out\-Of\-MemoryException}), but deoptimize instead. +This reduces the places in the compiled code where an exact bytecode location and debug information must be known. +Additionally, this greatly reduces the number of exception handler edges in the compiled code. +The main advantage of this technique is however, that we are free in moving around bounds checks, memory allocation, memory accesses with implicit null checks, etc. + +There are only two kinds of instruction that need explicit exception edges, because they are the only instructions that can throw exceptions in compiled code: \texttt{Throw} instructions and \texttt{Invoke} instructions. +They are modelled as instructions with an additional control flow continuation that points to an \texttt{ExceptionDispatch} instruction. +The exception dispatch instruction decides based on the type of the exception object whether the control should flow to the catch handler or to another exception dispatch. +If there is no catch handler in the currently compiled method, then the control flows into the \texttt{Unwind} instruction that handles the exception by forwarding it to the caller. +Listing~\ref{lst:exc1} shows an example Java program with nested try blocks and Figure \ref{fig:exc1} shows the corresponding compiler graph. + +\begin{lstlisting}[label=lst:exc1, caption=Exception dispatch in the compiler graph., captionpos=b] +try { m1(); + try { m2(); + } catch(ExtendedException e) { ... } + m3(); + throw exception; +} catch(Exception e) { ... } +\end{lstlisting} + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{exc1} +\textnode{entry}{Entry} +\textnode{catch1}{catch1} +\textnode{catch2}{catch2} +\nodesplit{m1}{Invoke m1} +\nodesplit{m2}{Invoke m2} +\nodesplit{m3}{Invoke m3} +\nodesplit{dispatch1}{ExceptionDispatch} +\nodesplit{dispatch2}{ExceptionDispatch} +\node{throw}{Throw} +\node{unwind}{Unwind} +\control{entry}{m1} +\controllabel{m1:succ1}{m2} +\controllabel{m1:succ2}{dispatch2} +\controllabel{m2:succ1}{m3} +\controllabel{m2:succ2}{dispatch1} +\controllabel{m3:succ1}{throw} +\controllabel{m3:succ2}{dispatch2} +\control{throw}{dispatch2} +\controllabel{dispatch1:succ2}{catch1} +\controllabel{dispatch1:succ1}{dispatch2} +\controllabel{dispatch2:succ2}{catch2} +\controllabel{dispatch2:succ1}{unwind} +\end{digraphenv} + \caption{A simple loop with two exits.} + \label{fig:exc1} +\end{figure} + +\section{Loops} +\label{sec:loops} +Loops form a first-class construct in the IR that is expressed by specialized IR nodes during all optimization phases. +We only compile methods with a control flow where every loop has a single entry point. +This entry point is a \nodename{LoopBegin} instruction. +This instruction is connected to a \nodename{LoopEnd} instruction that merges all control flow paths that do not exit the loop. +The edge between the \nodename{LoopBegin} and the \nodename{LoopEnd} is the backedge of the loop. +It goes from the beginning to the end in order to make the graph acyclic. +An algorithm that traverses the control flow has to explicitely decide whether it wants to incorporate backedges (i.e., special case of the treatment of \nodename{LoopEnd}) or ignore them. +Figure \ref{fig:loop1} shows a simple example with a loop with a single entry and two exits. + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{layout1} +\textnode{BeforeLoop}{Loop entry} +\textnode{Exit1}{First loop exit} +\textnode{Exit2}{Second loop exit} +\nodesplit{LoopBegin}{LoopBegin} +\node{LoopEnd}{LoopEnd} +\nodesplit{If1}{If} +\nodesplit{If2}{If} +\controllabel{LoopBegin:succ1}{LoopEnd} +\controllabel{LoopBegin:succ2}{If1} +\controllabel{If1:succ1}{If2} +\controllabel{If2:succ1}{LoopEnd} +\controllabel{BeforeLoop}{LoopBegin} +\controllabel{If1:succ2}{Exit1} +\controllabel{If2:succ2}{Exit2} +\end{digraphenv} + \caption{A simple loop with two exits.} + \label{fig:loop1} +\end{figure} + +\subsection{Loop Phis} +Data flow in loops is modeled with special phi nodes at the beginning and the end of the loop. +The \nodename{LoopEnd} instruction merges every value that flows into the next loop iteration in associated \nodename{LoopEndPhi} nodes. +A corresponding \nodename{LoopBeginPhi} node that is associated with the loop header has a control flow dependency on the \nodename{LoopEndPhi} node. +Listing~\ref{lst:loop} shows a simple counting loop that is used as an example in the rest of this section. +Figure~\ref{fig:loop2} shows how the loop is modelled immediately after building the graph. + +\begin{lstlisting}[label=lst:loop, caption=Loop example that counts from 0 to n-1., captionpos=b] +for(int i=0; i<n; ++i) { } +\end{lstlisting} + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{layout2} +\textnode{BeforeLoop}{Loop entry} +\textnode{Exit}{Loop exit} +\textnode{n}{n} +\textnode{Constant0}{0} +\textnode{Constant1}{1} +\nodesplit{LoopBegin}{LoopBegin} +\node{LoopEnd}{LoopEnd} +\nodesplit{If1}{If} +\controllabel{LoopBegin:succ1}{LoopEnd} +\controllabel{LoopBegin:succ2}{If1} +\nodebi{Compare}{<} +\nodebi{LoopBeginPhi}{LoopBeginPhi} +\nodebi{Add}{+} +\datalabel{Add:in1}{LoopBeginPhi} +\datalabel{Add:in2}{Constant1} +\nodebi{LoopEndPhi}{LoopEndPhi} +\control{LoopBeginPhi}{LoopEndPhi} +\data{LoopEndPhi:in1}{LoopEnd} +\data{LoopEndPhi:in2}{Add} +\datalabel{LoopBeginPhi:in1}{LoopBegin} +\datalabel{LoopBeginPhi:in2}{Constant0} +\datalabel{Compare:in1}{LoopBeginPhi} +\datalabel{Compare:in2}{n} +\data{If1}{Compare} +\controllabel{If1:succ1}{LoopEnd} +\controllabel{BeforeLoop}{LoopBegin} +\controllabel{If1:succ2}{Exit} +\end{digraphenv} + \caption{Graph for a loop counting from 0 to n-1.} + \label{fig:loop2} +\end{figure} + +\subsection{Loop Counters} +The compiler is capable of recognizing variables that are only increased within a loop. +A potential overflow of such a variable is prohibited with a guard before the loop (this is not necessary in this example, because the loop variable cannot overflow). +Figure \ref{fig:loop3} shows the compiler graph of the example loop after the loop counter transformation. + + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{layout3} +\textnode{BeforeLoop}{Loop entry} +\textnode{Exit}{Loop exit} +\textnode{n}{n} +\textnode{Constant0}{0} +\textnode{Constant1}{1} +\nodesplit{LoopBegin}{LoopBegin} +\node{LoopEnd}{LoopEnd} +\nodesplit{If1}{If} +\controllabel{LoopBegin:succ1}{LoopEnd} +\controllabel{LoopBegin:succ2}{If1} +\nodebi{Compare}{<} +\nodetri{LoopCounter}{LoopCounter} +\datalabel{LoopCounter:in1}{LoopBegin} +\datalabeltext{LoopCounter:in2}{Constant0}{init} +\datalabeltext{LoopCounter:in3}{Constant1}{stride} +\datalabel{Compare:in1}{LoopCounter} +\datalabel{Compare:in2}{n} +\data{If1}{Compare} +\controllabel{If1:succ1}{LoopEnd} +\controllabel{BeforeLoop}{LoopBegin} +\controllabel{If1:succ2}{Exit} +\end{digraphenv} + \caption{Graph after loop counter transformation.} + \label{fig:loop3} +\end{figure} + +\subsection{Bounded Loops} + +If the total maximum number of iterations of a loop is fixed, then the loop is converted into a bounded loop. +The total number of iterations always denotes the number of full iterations of the loop with the control flowing from the loop begin to the loop end. +If the total number of iterations is reached, the loop is exited directly from the loop header. +In the example, we can infer from the loop exit with the comparison on the loop counter that the total number of iterations of the loop is limited to n. +Figure \ref{fig:loop4} shows the compiler graph of the example loop after the bounded loop transformation. + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{layout4} +\textnode{BeforeLoop}{Loop entry} +\textnode{Exit}{Loop exit} +\textnode{n}{n} +\textnode{Constant0}{0} +\textnode{Constant1}{1} +\nodesplittri{LoopBegin}{BoundedLoopBegin} +\node{LoopEnd}{LoopEnd} +\controllabel{LoopBegin:succ1}{LoopEnd} +\controllabel{LoopBegin:succ2}{LoopEnd} +\controllabel{LoopBegin:succ3}{Exit} +\nodetri{LoopCounter}{LoopCounter} +\datalabel{LoopCounter:in1}{LoopBegin} +\datalabeltext{LoopCounter:in2}{Constant0}{init} +\datalabeltext{LoopCounter:in3}{Constant1}{stride} +\data{LoopBegin}{n} +\controllabel{BeforeLoop}{LoopBegin} +\end{digraphenv} + \caption{Graph after bounded loop transformation.} + \label{fig:loop4} +\end{figure} + +\subsection{Vectorization} + +If we have now a bounded loop with no additional loop exit and no associated phi nodes (only associated loop counters), we can vectorize the loop. +We replace the loop header with a normal instruction that produces a vector of values from 0 to the number of loop iterations minus 1. +The loop counters are replaced with \texttt{VectorAdd} and \texttt{VectorMul} nodes. +The vectorization is only possible if every node of the loop can be replaced with a corresponding vector node. +Figure \ref{fig:loop5} shows the compiler graph of the example loop after vectorization. +The vector nodes all work on an ordered list of integer values and are subject to canonicalization and global value numbering like any other node. + + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{layout5} +\textnode{Entry}{Entry} +\textnode{Exit}{Exit} +\textnode{n}{n} +\textnode{Constant0}{0} +\textnode{Constant1}{1} +\node{Vector}{Vector} +\nodebi{VectorAdd}{VectorAdd} +\nodebi{VectorMul}{VectorMul} +\control{Entry}{Vector} +\control{Vector}{Exit} +\datalabel{VectorAdd:in1}{Vector} +\datalabel{VectorAdd:in2}{Constant0} +\datalabel{VectorMul:in1}{VectorAdd} +\datalabel{VectorMul:in2}{Constant1} +\data{Vector}{n} +\end{digraphenv} + \caption{Graph after vectorization.} + \label{fig:loop5} +\end{figure} + + +\section{Frame States} +A frame state captures the state of the program like it is seen in by an interpreter of the program. +The frame state contains the information that is local to the current activation and will therefore disappear during SSA-form constructions or other compiler optimizations. +For Java, the frame state is defined in terms of the Java bytecode specification (i.e., the values of the local variables, the operand stack, and the locked monitors). +However, a frame state is not a concept specific to Java (e.g., the Crankshaft JavaScript engine uses frame states in their optimizing compiler to model the values of the AST interpreter). + +Frame states are necessary to support the deoptimization of the program, which is the precondition for performing aggressive optimizations that use optimistic assumptions. +Therefore every point in the optimizing compiler that may revert execution back to the interpreter needs a valid frame state. +However, the point where the interpreter continues execution need not correspond exactly to the execution position of the compiled code, because many Java bytecode instructions can be safely reexecuted. +Thus, frame states need only be generated for the states after instructions that cannot be reexecuted, because they modify the state of the program. +Examples for such instructions are: + +\begin{itemize} + \item Array stores (in Java bytecodes {\tt IASTORE, LASTORE, FASTORE, \\DASTORE, AASTORE, BASTORE, CASTORE, SASTORE}) + \item Field stores (in Java bytecodes {\tt PUTSTATIC, PUTFIELD}) + \item Method calls (in Java bytecodes {\tt INVOKEVIRTUAL, INVOKESPECIAL, \\INVOKESTATIC, INVOKEINTERFACE}) + \item Synchronization (in Java bytecodes {\tt MONITORENTER, MONITOREXIT}) +\end{itemize} + +Within the graph a frame state is represented as a node that is attached to the instruction that caused it to be generated using a control dependency (see Figure~\ref{fig:fs1}). +Frame states also have data dependencies on the contents of the state: the local variables and the expression stack. + +The frame state at the method beginning does not have to be explicitely in the graph, because it can always be reconstructed at a later stage. +We save the frame state at control flow merges if there is at least one frame state on any control flow path between a node and its immediate dominator. + + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{fs1} + \nodetrisplit{store1}{ArrayStore} + \nodebi{load1}{ArrayLoad} + \controllabel{store1:succ1}{load1} + \nodetrisplit{store2}{FieldStore} + \control{load1}{store2} + end [shape=plaintext, label="...", width="2.0"] + store2:succ1:s -> end:n [color=red]; + % + \nodeframestate{fs1}{FrameState} + \controllabel{store1:succ2}{fs1} + \nodeframestate{fs2}{FrameState} + \controllabel{store2:succ2}{fs2} +\end{digraphenv} + \caption{Simple example using two frame states.} + \label{fig:fs1} +\end{figure} + + +A deoptimization node needs a valid frame state that specifies the location and state where the interpreter should continue. +The algorithm for constructing frame states makes sure that every possible location in the graph has a well-defined frame state that can be used by a deoptimization instruction. +Therefore, there are no direct links between the deoptimization instruction and its frame state thus allowing the deoptimization instructions to move freely around. + +\subsection{Partial Escape Analysis} + +A partial escape analysis can help to further reduce the number of frame states. +A field or array store does not create a new frame state, when the object that is modified did not have a chance to escape between its creation and the store. + +Listing~\ref{lst:escape1} shows an example of a method that creates two \texttt{Point} objects, connects them, and returns them. +The object allocation of the first \texttt{Point} object does not need a frame state. +We can always reexecute the \texttt{NEW} bytecode again in the interpreter. +The \texttt{Point} object allocated by the compiler will then simply disappear after the next garbage collection. +The following field store is a thread-local memory store, because the \texttt{Point} object did not have any chance to escape. +Same applies to the assignment of the \texttt{next} field and the third field assignment. +Therefore, the whole method \texttt{getPoint} does not need an explicit frame state, because at any time during execution of this method, we can deoptimize and continue execution in the interpreter at the first bytecode of the method. + +\begin{lstlisting}[label=lst:escape1, caption=Example method that needs no frame state., captionpos=b] +void getPoint() { + Point p = new Point(); + p.x = 1; + p.next = new Point(); + p.next.x = 2; + return p; +} +\end{lstlisting} + +The reduction of frame states makes it easier for the compiler to perform memory optimizations like memory access coalescing. +We believe that this reduction on frame states is the key to effective vectorization and other compiler optimizations where compilers of compilers of unmanaged languages have advantages. + +\subsection{Guards} +A guard is a node that deoptimizes based on a conditional expression. +Guards are not attached to a certain frame state, they can move around freely and will always use the correct frame state when the nodes are scheduled (i.e., the last emitted frame state). +The node that is guarded by the deoptimization has a data dependency on the guard and the guard in turn has a data dependency on the condition. +A guard must not be moved above any \texttt{If} nodes. +Therefore, we use \texttt{Anchor} instructions after a control flow split and a data dependency from the guard to this anchor. +The anchor is the most distant instruction that is postdominated by the guarded instruction and the guard can be scheduled anywhere between those two nodes. +This ensures maximum flexibility for the guard instruction and guarantees that we only deoptimize if the control flow would have reached the guarded instruction (without taking exceptions into account). + +To illustrate the strengths of this approach, we show the graph for the Java code snippet shown in \ref{lst:guard1}. +The example looks artificial, but in case of method inlining, this is a pattern that is not unlikely to be present in a normal Java program. +Figure \ref{fig:guard0} shows the compiler graph for the example method after graph building. +The field stores are both represented by a single instruction and the null check that is implicitely incorporated in the field store. + +\begin{lstlisting}[label=lst:guard1, caption=Example method that demonstrates the strengths of modelling the guards explicitely., captionpos=b] +void init(Point p) { + if (p != null) { + p.x = 0; + } + p.y = 0; +} +\end{lstlisting} + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{guard0} + \textnode{entry}{Entry} + \nodesplit{if}{If} + \node{merge}{Merge} + \node{return}{Return} + \node{cmpnull}{NonNull} + \textnode{p}{p} + \textnode{const0}{0} + \nodebisplit{store1}{FieldStore x} + \nodebisplit{store2}{FieldStore y} + \nodeframestate{fs1}{FrameState} + \nodeframestate{fs2}{FrameState} + \datalabel{store1:in1}{p} + \datalabel{store2:in1}{p} + \datalabel{store1:in2}{const0} + \datalabel{store2:in2}{const0} + \control{entry}{if} + \data{if}{cmpnull} + \controllabel{if:succ1}{merge} + \controllabel{if:succ2}{store1} + \controllabel{store1:succ1}{merge} + \controllabel{store1:succ2}{fs1} + \control{merge}{store2} + \controllabel{store2:succ1}{return} + \controllabel{store2:succ2}{fs2} + \data{cmpnull}{p} +\end{digraphenv} + \caption{Initial graph with the two field stores.} + \label{fig:guard0} +\end{figure} + +Figure~\ref{fig:guard1} shows the example graph at a later compilation phase when the field store instructions are lowered to memory store instructions and explicitely modelled null check guards. +The guards are attached to anchor instructions that delimit their possible schedule. +The first guard must not be moved outside the \texttt{if} block; the second guard may be moved before the \texttt{If} instruction, because at this point it is already guaranteed that the second store is executed. + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{guard1} + \textnode{entry}{Entry} + \node{anchor1}{Anchor} + \node{anchor2}{Anchor} + \nodesplit{if}{If} + \node{merge}{Merge} + \node{return}{Return} + \node{cmpnull}{NonNull} + \textnode{p}{p} + \textnode{const0}{0} + \nodeguard{guard1}{Guard} + \nodeguard{guard2}{Guard} + \nodetrisplit{store1}{MemStore 16 (int)} + \nodetrisplit{store2}{MemStore 20 (int)} + \nodeframestate{fs1}{FrameState} + \nodeframestate{fs2}{FrameState} + \data{store1:in1}{p} + \data{store2:in1}{p} + \data{store1:in2}{const0} + \data{store2:in2}{const0} + \data{store1:in3}{guard1} + \data{store2:in3}{guard2} + \data{guard1:in1}{anchor2} + \data{guard2:in1}{anchor1} + \data{guard1:in2}{cmpnull} + \data{guard2:in2}{cmpnull} + \control{entry}{anchor1} + \control{anchor1}{if} + \data{if}{cmpnull} + \controllabel{if:succ1}{merge} + \controllabel{if:succ2}{anchor2} + \control{anchor2}{store1} + \controllabel{store1:succ1}{merge} + \controllabel{store1:succ2}{fs1} + \control{merge}{store2} + \controllabel{store2:succ1}{return} + \controllabel{store2:succ2}{fs2} + \data{cmpnull}{p} +\end{digraphenv} + \caption{A load guarded by a null check guard.} + \label{fig:guard1} +\end{figure} + +The first guard can be easily removed, because it is guarded by an \texttt{If} instruction that checks the same condition. +Therefore we can remove the guard and the anchor from the graph and this gives us the graph shown in Figure \ref{fig:guard2}. + +There is another optimization for guard instructions: If two guards that are anchored to the true and false branch of the same \texttt{If} instruction have the same condition, they can be merged, so that the resulting guard is anchored at the most distant node of which the \texttt{If} instruction is a postdominator. + + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{guard2} + \textnode{entry}{Entry} + \node{anchor1}{Anchor} + \nodesplit{if}{If} + \node{merge}{Merge} + \node{return}{Return} + \node{cmpnull}{NonNull} + \textnode{p}{p} + \textnode{const0}{0} + \nodeguard{guard2}{Guard} + \nodetrisplit{store1}{MemStore 16 (int)} + \nodetrisplit{store2}{MemStore 20 (int)} + \nodeframestate{fs1}{FrameState} + \nodeframestate{fs2}{FrameState} + \data{store1:in1}{p} + \data{store2:in1}{p} + \data{store1:in2}{const0} + \data{store2:in2}{const0} + \data{store2:in3}{guard2} + \data{guard2:in1}{anchor1} + \data{guard2:in2}{cmpnull} + \control{entry}{anchor1} + \control{anchor1}{if} + \data{if}{cmpnull} + \controllabel{if:succ1}{merge} + \controllabel{if:succ2}{store1} + \controllabel{store1:succ1}{merge} + \controllabel{store1:succ2}{fs1} + \control{merge}{store2} + \controllabel{store2:succ1}{return} + \controllabel{store2:succ2}{fs2} + \data{cmpnull}{p} +\end{digraphenv} + \caption{After removing redundant guards.} + \label{fig:guard2} +\end{figure} + +The remaining guard can now be moved above the \texttt{If} condition and be used to eliminate the need for the \texttt{If} node. +From this point on, the guard can however no longer be moved below the first memory store. +We use a control dependency from the guard to the field store to express this condition. +The link between the second store and the guard and the control flow merge instruction is no longer necessary. + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{guard3} + \textnode{entry}{Entry} + \node{anchor1}{Anchor} + \node{return}{Return} + \node{cmpnull}{NonNull} + \textnode{p}{p} + \textnode{const0}{0} + \nodeguard{guard2}{Guard} + \nodetrisplit{store1}{MemStore 16 (int)} + \nodetrisplit{store2}{MemStore 20 (int)} + \nodeframestate{fs1}{FrameState} + \nodeframestate{fs2}{FrameState} + \data{store1:in1}{p} + \data{store2:in1}{p} + \data{store1:in2}{const0} + \data{store2:in2}{const0} + \data{store2:in3}{guard2} + \data{guard2:in1}{anchor1} + \data{guard2:in2}{cmpnull} + \control{guard2}{store1} + \control{entry}{anchor1} + \control{anchor1}{store1} + \controllabel{store1:succ2}{fs1} + \control{store1}{store2} + \controllabel{store2:succ1}{return} + \controllabel{store2:succ2}{fs2} + \data{cmpnull}{p} +\end{digraphenv} + \caption{After eliminating an if with a guard.} + \label{fig:guard3} +\end{figure} + +At some point during the compilation, guards need to be fixed, which means that appropriate data and control dependencies will be inserted so that they cannot move outside the scope of the associated frame state. +This will generate deoptimization-free zones that can be targeted by the most aggressive optimizations. +A simple algorithm for this removal of frame states would be to move all guards as far upwards as possible and then the guards are fixed using anchor nodes. +In our example, the guard is already fixed, so there is no deoptimization point that uses any of the memory store frame states. +Therefore we can delete the frame states from the graph (see Figure \ref{fig:guard4}). + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{guard4} + \textnode{entry}{Entry} + \node{anchor1}{Anchor} + \node{return}{Return} + \node{cmpnull}{NonNull} + \textnode{p}{p} + \textnode{const0}{0} + \nodeguard{guard2}{Guard} + \nodetrisplit{store1}{MemStore 16 (int)} + \nodetrisplit{store2}{MemStore 20 (int)} + \data{store1:in1}{p} + \data{store2:in1}{p} + \data{store1:in2}{const0} + \data{store2:in2}{const0} + \data{store2:in3}{guard2} + \data{guard2:in1}{anchor1} + \data{guard2:in2}{cmpnull} + \control{guard2}{store1} + \control{entry}{anchor1} + \control{anchor1}{store1} + \control{store1}{store2} + \controllabel{store2:succ1}{return} + \data{cmpnull}{p} +\end{digraphenv} + \caption{After removing the frame states.} + \label{fig:guard4} +\end{figure} + +Now we can use memory coalescing to combine the two stores without frame state to adjacent locations in the same object. +This is only possible if the first store does not have a frame state. +Figure \ref{fig:guard5} shows the resulting graph. + + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{guard5} + \textnode{entry}{Entry} + \node{anchor1}{Anchor} + \node{return}{Return} + \node{cmpnull}{NonNull} + \textnode{p}{p} + \textnode{const0}{0} + \nodeguard{guard2}{Guard} + \nodetrisplit{store1}{MemStore 16 (long)} + \data{store1:in1}{p} + \data{store1:in2}{const0} + \data{guard2:in1}{anchor1} + \data{guard2:in2}{cmpnull} + \control{guard2}{store1} + \control{entry}{anchor1} + \control{anchor1}{store1} + \controllabel{store1:succ1}{return} + \data{cmpnull}{p} +\end{digraphenv} + \caption{After coalescing the two memory stores.} + \label{fig:guard5} +\end{figure} + +A memory store that immediately follows a null check guard instruction on the same object, can be combined into a store with an implicit null check (that deoptimizes instead of throwing the exception). +Therefore, we can remove the guard again and also the anchor is no longer necessary. +Figure~\ref{fig:guard6} shows now that fully optimized graph that is generated for Listing~\ref{lst:guard1}. + +\begin{figure}[h] + \centering +\begin{digraphenv}{scale=0.5}{guard6} + \textnode{entry}{Entry} + \node{return}{Return} + \textnode{p}{p} + \textnode{const0}{0} + \nodetrisplit{store1}{DeoptimizingMemStore 16 (long)} + \data{store1:in1}{p} + \data{store1:in2}{const0} + \control{entry}{store1} + \controllabel{store1:succ1}{return} +\end{digraphenv} + \caption{Fully optimized method.} + \label{fig:guard6} +\end{figure} + + +\section{Conclusions} +\label{sec:conclusions} +This document sketched the strategy for the Graph compiler. +We already reached M1 (as defined in Section~\ref{sec:mile}) and have the following plans for M2 to M4: +\begin{description} +\item[M2:] June 30th, 2011 +\item[M3:] August 15th, 2011 +\item[M4:] September 30th, 2011 +\end{description} +After we reach M4, we want to create a new project road map that further improves the Graal compiler with respect to its two main goals: Modularity and peak performance. + +\end{document}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/graal/com.oracle.max.graal.doc.initial/graph_test.tex Wed Jun 08 14:06:17 2011 +0200 @@ -0,0 +1,160 @@ +\documentclass[twocolumn]{svjour3} +\usepackage[pdftex]{graphicx} +\usepackage{environ} +\usepackage{amsmath} +\usepackage{amsfonts} +\usepackage[english]{babel} +\usepackage[utf8]{inputenc} +\usepackage{lmodern} +\usepackage[T1]{fontenc} +\usepackage{color} + +\input{graphdrawing} + +\renewcommand*\descriptionlabel[1]{\hspace\labelsep\normalfont\bf #1} + +\newcommand{\Sa}{{\Large$^*$}} +\newcommand{\Sb}{{\Large$^\dag$}} +\newcommand{\Sc}{{\Large$^\S$}} + +\smartqed % flush right qed marks, e.g. at end of proof + +\journalname{Test} +\def\makeheadbox{{% +\hbox to0pt{\vbox{\baselineskip=10dd\hrule\hbox +to\hsize{\vrule\kern3pt\vbox{\kern3pt +\hbox{\bfseries Test} +\kern3pt}\hfil\kern3pt\vrule}\hrule}% +\hss}}} + +\begin{document} + +\author{} +\institute{} + +\date{Created: \today} + +\title{Test} +\subtitle{} + +\maketitle + +\begin{digraphenv}{scale=0.5}{layout1} + \nodestart + \nodeend + \data{a}{start} + \data{b}{start} + \node{a}{a} + \node{b}{b} + \nodesplit{if}{if} + \node{nop}{nop} + \nodebi{add}{+} + \controllabel{if:succ1}{nop} + \controllabel{if:succ2}{add} + \datalabel{add:in1}{a} + \datalabel{add:in2}{b} + \control{nop}{end} +\end{digraphenv} + +\begin{digraphenv}{scale=0.5}{layout2} + \node{node1}{nop} + \nodebi{node2}{+} + \nodetri{node3}{phi} + \nodesplit{node4}{if} +\end{digraphenv} + +\begin{digraphenv}{scale=0.5}{layout3} + \node{a}{a} + \node{b}{b} + \nodesplit{if}{if} + \node{nop}{nop} + \nodebi{add}{+} + \controllabel{if:succ1}{nop} + \controllabel{if:succ2}{add} + \datalabel{add:in1}{a} + \datalabel{add:in2}{b} +\end{digraphenv} + +\begin{digraphenv}{scale=0.5}{layout4} + \node{arr}{arr} + \node{i}{i} + \node{j}{j} + \node{v}{v} + \nodetri{astore1}{astore} + \datalabel{astore1:in1}{arr} + \datalabel{astore1:in2}{i} + \datalabel{astore1:in3}{v} + \nodebi{add}{+} + \datalabel{add:in1}{i} + \datalabel{add:in2}{j} + \nodetri{astore2}{astore} + \datalabel{astore2:in1}{arr} + \datalabel{astore2:in2}{add} + \datalabel{astore2:in3}{v} + \cnode{fs}{framestate}{lightblue} + \control{fs}{astore2} + \data{fs}{astore1} +% \data{fs}{arr} +% \data{fs}{i} +% \data{fs}{j} +% \data{fs}{v} + \control{astore1}{astore2} +\end{digraphenv} + +\begin{digraphenv}{scale=0.5}{layout5} + \nodestart + \nodeend + % input projections + \node{a}{proj:a} + \node{b}{proj:b} + \data{a}{start} + \data{b}{start} + % if + \nodebi{cmp1}{<} + \datalabel{cmp1:in1}{a} + \datalabel{cmp1:in2}{b} + \nodesplit{if}{if} + \data{if}{cmp1} + \control{start}{if} + % branches + \nodebi{add1}{+} + \datalabel{add1:in1}{a} + \datalabel{add1:in2}{b} + \nodebi{sub1}{-} + \datalabel{sub1:in1}{a} + \datalabel{sub1:in2}{b} + \controllabel{if:succ1}{add1} + \controllabel{if:succ2}{sub1} + % merge + \nodebi{merge}{merge} + \control{add1}{merge} + \control{sub1}{merge} + % phi + \nodebi{phi1}{phi} + \datalabel{phi1:in1}{add1} + \datalabel{phi1:in2}{sub1} + % ret + \node{ret}{ret} + \data{ret}{phi1} + \control{merge}{ret} + \control{ret}{end} +\end{digraphenv} + +\end{document} + + + + + + + + + + + + + + + + +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/graal/com.oracle.max.graal.doc.initial/graphdrawing.tex Wed Jun 08 14:06:17 2011 +0200 @@ -0,0 +1,109 @@ + +% graph drawing +\newwrite\dotfile +\newcommand{\digraph}[3][scale=1]{ + \immediate\openout\dotfile=dot_temp_#2.dot + \immediate\write\dotfile{digraph #2 { margin=0; pad=0; concentrate=false; \string#3}} + \immediate\closeout\dotfile + \immediate\write18{bash -c "dot -Tpdf dot_temp_#2.dot > dot_temp_#2.pdf"} + \IfFileExists{dot_temp_#2.pdf} + % the pdf exists: include it + { \includegraphics[#1]{dot_temp_#2} } + % the pdf was not created - show a hint + { \fbox{ \begin{tabular}{l} + The file \texttt{dot_temp_#2.pdf} hasn't been created from + \texttt{dot_temp_#2.dot} yet. \\ + We attempted to create it with:\\ + `\texttt{dot -Tpdf dot_temp_#2.dot > dot_temp_#2.pdf}' \\ + but that seems not to have worked. You need to execute `\texttt{pdflatex}' with \\ + the `\texttt{-shell-escape} option. + \end{tabular}} + } +} + +\NewEnviron{digraphenv}[2]{\digraph[#1]{#2}{ nodesep="0.1"; ranksep="0.08 equally"; \BODY }} + +\newcommand{\control}[2]{#1:successors:s -> #2:predecessors:n [color=red];} +\newcommand{\controllabel}[2]{#1:s -> #2:predecessors:n [color=red];} +\newcommand{\data}[2]{#2:usages:s -> #1:inputs [color=black,dir=back];} +\newcommand{\datalabel}[2]{#2:usages:s -> #1:n [color=black,dir=back];} +\newcommand{\datalabeltext}[3]{#2:usages:s -> #1:n [color=black,dir=back,label="#3"];} + +\newcommand{\textnode}[2]{#1 [shape=plaintext, label="#2"]} +\newcommand{\genericnodestart}[1]{#1 [shape=plaintext, label=< <TABLE BORDER="0" CELLSPACING="0"><TR><TD CELLPADDING="0"><TABLE BORDER="0" CELLSPACING="2" CELLPADDING="0"><TR><TD WIDTH="15" HEIGHT="5" PORT="predecessors" BGCOLOR="rosybrown1"></TD></TR></TABLE></TD><TD COLSPAN="2" CELLPADDING="0" ALIGN="RIGHT"><TABLE BORDER="0" CELLSPACING="2" CELLPADDING="0"><TR>} +\newcommand{\genericnodeend}[0]{</TR></TABLE></TD><TD CELLPADDING="0"><TABLE BORDER="0" CELLSPACING="2" CELLPADDING="0"><TR><TD WIDTH="15" HEIGHT="5" PORT="usages" BGCOLOR="lightgrey"></TD></TR></TABLE></TD></TR></TABLE>>]} +\newcommand{\portinput}[1]{<TD WIDTH="15" HEIGHT="5" PORT="#1" BGCOLOR="lightgrey"></TD>} +\newcommand{\portsuccessor}[1]{<TD WIDTH="15" HEIGHT="5" PORT="#1" BGCOLOR="rosybrown1"></TD>} +\newcommand{\portempty}[0]{<TD WIDTH="15" HEIGHT="5"></TD>} +\newcommand{\genericnodelabel}[2]{</TR></TABLE></TD></TR><TR><TD BORDER="1" COLSPAN="3" BGCOLOR="#2"><FONT POINT-SIZE="12">#1</FONT></TD></TR><TR><TD COLSPAN="2" CELLPADDING="0" ALIGN="RIGHT"><TABLE BORDER="0" CELLSPACING="2" CELLPADDING="0"><TR>} + +\newcommand{\nodestart}[0]{start [shape=plaintext, rank=source, label=< <TABLE BORDER="0" CELLSPACING="0"><TR><TD COLSPAN="3"><TABLE BORDER="0"><TR><TD></TD> \genericnodelabel{start}{lightyellow} \portsuccessor{successors} \portempty \genericnodeend } + +\newcommand{\nodeend}[0]{\genericnodestart{end} \portempty \portinput{inputs} \genericnodelabel{end}{lightyellow} <TD></TD></TR></TABLE></TD><TD></TD></TR></TABLE>>]} + +\newcommand{\nodeconst}[2]{#1 [margin="0.05, 0.05", shape=plaintext, label=< <TABLE BORDER="0" CELLSPACING="0"><TR><TD BORDER="1" BGCOLOR="white"><FONT POINT-SIZE="12">#2</FONT></TD></TR><TR><TD WIDTH="15" HEIGHT="5" PORT="usages" BGCOLOR="lightgrey"></TD></TR></TABLE>>]} +\newcommand{\nodeframestate}[2]{#1 [margin="0.05, 0.05", shape=plaintext, label=< <TABLE BORDER="0" CELLSPACING="0"><TR><TD WIDTH="15" HEIGHT="5" PORT="predecessors" BGCOLOR="rosybrown1"></TD><TD WIDTH="15" HEIGHT="5"></TD><TD HEIGHT="5" PORT="inputs" BGCOLOR="lightgrey"></TD></TR><TR><TD BORDER="1" COLSPAN="3" BGCOLOR="lightblue"><FONT POINT-SIZE="12">#2</FONT></TD></TR></TABLE>>]} + + +\newcommand{\node}[2]{\genericnodestart{#1} \portempty \portinput{inputs} \genericnodelabel{#2}{white} \portsuccessor{successors} \portempty \genericnodeend } +\newcommand{\nodebi}[2]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \genericnodelabel{#2}{white} \portsuccessor{successors} \portempty \genericnodeend } +\newcommand{\nodetri}[2]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \portinput{in3} \genericnodelabel{#2}{white} \portsuccessor{successors} \portempty \portempty \genericnodeend } +\newcommand{\nodequad}[2]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \portinput{in3} \portinput{in4} \genericnodelabel{#2}{white} \portsuccessor{successors} \portempty \portempty \portempty \genericnodeend } +\newcommand{\nodesplit}[2]{\genericnodestart{#1} \portempty \portinput{inputs} \genericnodelabel{#2}{white} \portsuccessor{succ1} \portsuccessor{succ2} \genericnodeend } +\newcommand{\nodequadsplit}[2]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \portinput{in3} \portinput{in4} \genericnodelabel{#2}{white} \portsuccessor{succ1} \portsuccessor{succ2} \portempty \portempty \genericnodeend } +\newcommand{\nodetrisplit}[2]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \portinput{in3} \genericnodelabel{#2}{white} \portsuccessor{succ1} \portsuccessor{succ2} \portempty \genericnodeend } +\newcommand{\nodesplittri}[2]{\genericnodestart{#1} \portempty \portinput{inputs} \genericnodelabel{#2}{white} \portsuccessor{succ1} \portsuccessor{succ2} \portsuccessor{succ3} \genericnodeend } +\newcommand{\nodebisplit}[2]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \genericnodelabel{#2}{white} \portsuccessor{succ1} \portsuccessor{succ2} \portempty \genericnodeend } + +\newcommand{\nodeguard}[2]{\cnodebi{#1}{#2}{rosybrown1}} + +\newcommand{\cnode}[3]{\genericnodestart{#1} \portempty \portinput{inputs} \genericnodelabel{#2}{#3} \portsuccessor{successors} \portempty \genericnodeend } +\newcommand{\cnodebi}[3]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \genericnodelabel{#2}{#3} \portsuccessor{successors} \portempty \genericnodeend } +\newcommand{\cnodetri}[3]{\genericnodestart{#1} \portinput{in1} \portinput{in2} \portinput{in3} \genericnodelabel{#2}{#3} \portsuccessor{successors} \portempty \portempty \genericnodeend } +\newcommand{\cnodesplit}[3]{\genericnodestart{#1} \portempty \portinput{inputs} \genericnodelabel{#2}{#3} \portsuccessor{succ1} \portsuccessor{succ2} \genericnodeend } + +% this doesn't work: +%\newenvironment{graphfigure}[2]{\begin{figure}[h] \label{fig:#1} \centering \begin{digraphenv}{scale=0.5}{#1}}{\end{digraphenv} \caption{#2} \end{figure}} + +%%%%%%%%%%%%%% example: + +% \begin{digraphenv}{scale=0.5}{MyGraph} +% \node{start}{start} +% \node{end}{end} +% % input projections +% \node{a}{proj:a} +% \node{b}{proj:b} +% \data{a}{start} +% \data{b}{start} +% % if +% \nodebi{cmp1}{<} +% \datalabel{cmp1:in1}{a} +% \datalabel{cmp1:in2}{b} +% \nodesplit{if}{if} +% \data{if}{cmp1} +% \control{start}{if} +% % branches +% \nodebi{add1}{+} +% \datalabel{add1:in1}{a} +% \datalabel{add1:in2}{b} +% \nodebi{sub1}{-} +% \datalabel{sub1:in1}{a} +% \datalabel{sub1:in2}{b} +% \controllabel{if:succ1}{add1} +% \controllabel{if:succ2}{sub1} +% % merge +% \nodebi{merge}{merge} +% \control{add1}{merge} +% \control{sub1}{merge} +% % phi +% \nodebi{phi1}{phi} +% \datalabel{phi1:in1}{add1} +% \datalabel{phi1:in2}{sub1} +% % ret +% \node{ret}{ret} +% \data{ret}{phi1} +% \control{merge}{ret} +% \control{ret}{end} +% \end{digraphenv} + +%%%%%%%%%%%%%%%
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/graal/com.oracle.max.graal.doc.initial/svglov3.clo Wed Jun 08 14:06:17 2011 +0200 @@ -0,0 +1,101 @@ +% SVJour3 DOCUMENT CLASS OPTION SVGLOV3 -- for standardised journals +% +% This is an enhancement for the LaTeX +% SVJour3 document class for Springer journals +% +%% +%% +%% \CharacterTable +%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z +%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z +%% Digits \0\1\2\3\4\5\6\7\8\9 +%% Exclamation \! Double quote \" Hash (number) \# +%% Dollar \$ Percent \% Ampersand \& +%% Acute accent \' Left paren \( Right paren \) +%% Asterisk \* Plus \+ Comma \, +%% Minus \- Point \. Solidus \/ +%% Colon \: Semicolon \; Less than \< +%% Equals \= Greater than \> Question mark \? +%% Commercial at \@ Left bracket \[ Backslash \\ +%% Right bracket \] Circumflex \^ Underscore \_ +%% Grave accent \` Left brace \{ Vertical bar \| +%% Right brace \} Tilde \~} +\ProvidesFile{svglov3.clo} + [2006/02/03 v3.1 + style option for standardised journals] +\typeout{SVJour Class option: svglov3.clo for standardised journals} +\def\validfor{svjour3} +\ExecuteOptions{final,10pt,runningheads} +% No size changing allowed, hence a "copy" of size10.clo is included +\renewcommand\normalsize{% +\if@twocolumn + \@setfontsize\normalsize\@xpt{12.5pt}% +\else + \if@smallext + \@setfontsize\normalsize\@xpt\@xiipt + \else + \@setfontsize\normalsize{9.5pt}{11.5pt}% + \fi +\fi + \abovedisplayskip=3 mm plus6pt minus 4pt + \belowdisplayskip=3 mm plus6pt minus 4pt + \abovedisplayshortskip=0.0 mm plus6pt + \belowdisplayshortskip=2 mm plus4pt minus 4pt + \let\@listi\@listI} +\normalsize +\newcommand\small{% +\if@twocolumn + \@setfontsize\small{8.5pt}\@xpt +\else + \if@smallext + \@setfontsize\small\@viiipt{9.5pt}% + \else + \@setfontsize\small\@viiipt{9.25pt}% + \fi +\fi + \abovedisplayskip 8.5\p@ \@plus3\p@ \@minus4\p@ + \abovedisplayshortskip \z@ \@plus2\p@ + \belowdisplayshortskip 4\p@ \@plus2\p@ \@minus2\p@ + \def\@listi{\leftmargin\leftmargini + \parsep 0\p@ \@plus1\p@ \@minus\p@ + \topsep 4\p@ \@plus2\p@ \@minus4\p@ + \itemsep0\p@}% + \belowdisplayskip \abovedisplayskip +} +\let\footnotesize\small +\newcommand\scriptsize{\@setfontsize\scriptsize\@viipt\@viiipt} +\newcommand\tiny{\@setfontsize\tiny\@vpt\@vipt} +\if@twocolumn + \newcommand\large{\@setfontsize\large\@xiipt\@xivpt} + \newcommand\LARGE{\@setfontsize\LARGE{16pt}{18pt}} +\else + \newcommand\large{\@setfontsize\large\@xipt\@xiipt} + \newcommand\LARGE{\@setfontsize\LARGE{13pt}{15pt}} +\fi +\newcommand\Large{\@setfontsize\Large\@xivpt{16dd}} +\newcommand\huge{\@setfontsize\huge\@xxpt{25}} +\newcommand\Huge{\@setfontsize\Huge\@xxvpt{30}} +% +\def\runheadhook{\rlap{\smash{\lower6.5pt\hbox to\textwidth{\hrulefill}}}} +\if@twocolumn +\setlength{\textwidth}{17.4cm} +\setlength{\textheight}{234mm} +\AtEndOfClass{\setlength\columnsep{6mm}} +\else + \if@smallext + \setlength{\textwidth}{11.9cm} + \setlength{\textheight}{19.4cm} + \else + \setlength{\textwidth}{12.2cm} + \setlength{\textheight}{19.8cm} + \fi +\fi +% +\AtBeginDocument{% +\@ifundefined{@journalname} + {\typeout{Unknown journal: specify \string\journalname\string{% +<name of your journal>\string} in preambel^^J}}{}} +% +\endinput +%% +%% End of file `svglov3.clo'.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/graal/com.oracle.max.graal.doc.initial/svjour3.cls Wed Jun 08 14:06:17 2011 +0200 @@ -0,0 +1,1431 @@ +% SVJour3 DOCUMENT CLASS -- version 3.2 for LaTeX2e +% +% LaTeX document class for Springer journals +% +%% +%% +%% \CharacterTable +%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z +%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z +%% Digits \0\1\2\3\4\5\6\7\8\9 +%% Exclamation \! Double quote \" Hash (number) \# +%% Dollar \$ Percent \% Ampersand \& +%% Acute accent \' Left paren \( Right paren \) +%% Asterisk \* Plus \+ Comma \, +%% Minus \- Point \. Solidus \/ +%% Colon \: Semicolon \; Less than \< +%% Equals \= Greater than \> Question mark \? +%% Commercial at \@ Left bracket \[ Backslash \\ +%% Right bracket \] Circumflex \^ Underscore \_ +%% Grave accent \` Left brace \{ Vertical bar \| +%% Right brace \} Tilde \~} +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesClass{svjour3}[2007/05/08 v3.2 +^^JLaTeX document class for Springer journals] +\newcommand\@ptsize{} +\newif\if@restonecol +\newif\if@titlepage +\@titlepagefalse +\DeclareOption{a4paper} + {\setlength\paperheight {297mm}% + \setlength\paperwidth {210mm}} +\DeclareOption{10pt}{\renewcommand\@ptsize{0}} +\DeclareOption{twoside}{\@twosidetrue \@mparswitchtrue} +\DeclareOption{draft}{\setlength\overfullrule{5pt}} +\DeclareOption{final}{\setlength\overfullrule{0pt}} +\DeclareOption{fleqn}{\input{fleqn.clo}\AtBeginDocument{\mathindent\z@}% +\AtBeginDocument{\@ifpackageloaded{amsmath}{\@mathmargin\z@}{}}% +\PassOptionsToPackage{fleqn}{amsmath}} +%%% +\DeclareOption{onecolumn}{} +\DeclareOption{smallcondensed}{} +\DeclareOption{twocolumn}{\@twocolumntrue\ExecuteOptions{fleqn}} +\newif\if@smallext\@smallextfalse +\DeclareOption{smallextended}{\@smallexttrue} +\let\if@mathematic\iftrue +\let\if@numbook\iffalse +\DeclareOption{numbook}{\let\if@envcntsect\iftrue + \AtEndOfPackage{% + \renewcommand\thefigure{\thesection.\@arabic\c@figure}% + \renewcommand\thetable{\thesection.\@arabic\c@table}% + \renewcommand\theequation{\thesection.\@arabic\c@equation}% + \@addtoreset{figure}{section}% + \@addtoreset{table}{section}% + \@addtoreset{equation}{section}% + }% +} +\DeclareOption{openbib}{% + \AtEndOfPackage{% + \renewcommand\@openbib@code{% + \advance\leftmargin\bibindent + \itemindent -\bibindent + \listparindent \itemindent + \parsep \z@ + }% + \renewcommand\newblock{\par}}% +} +\DeclareOption{natbib}{% +\AtEndOfClass{\RequirePackage{natbib}% +% Changing some parameters of NATBIB +\setlength{\bibhang}{\parindent}% +%\setlength{\bibsep}{0mm}% +\let\bibfont=\small +\def\@biblabel#1{#1.}% +\newcommand{\etal}{et al.}% +\bibpunct{(}{)}{;}{a}{}{,}}} +% +\let\if@runhead\iffalse +\DeclareOption{runningheads}{\let\if@runhead\iftrue} +\let\if@smartrunh\iffalse +\DeclareOption{smartrunhead}{\let\if@smartrunh\iftrue} +\DeclareOption{nosmartrunhead}{\let\if@smartrunh\iffalse} +\let\if@envcntreset\iffalse +\DeclareOption{envcountreset}{\let\if@envcntreset\iftrue} +\let\if@envcntsame\iffalse +\DeclareOption{envcountsame}{\let\if@envcntsame\iftrue} +\let\if@envcntsect\iffalse +\DeclareOption{envcountsect}{\let\if@envcntsect\iftrue} +\let\if@referee\iffalse +\DeclareOption{referee}{\let\if@referee\iftrue} +\def\makereferee{\def\baselinestretch{2}} +\let\if@instindent\iffalse +\DeclareOption{instindent}{\let\if@instindent\iftrue} +\let\if@smartand\iffalse +\DeclareOption{smartand}{\let\if@smartand\iftrue} +\let\if@spthms\iftrue +\DeclareOption{nospthms}{\let\if@spthms\iffalse} +% +% language and babel dependencies +\DeclareOption{deutsch}{\def\switcht@@therlang{\switcht@deutsch}% +\gdef\svlanginfo{\typeout{Man spricht deutsch.}\global\let\svlanginfo\relax}} +\DeclareOption{francais}{\def\switcht@@therlang{\switcht@francais}% +\gdef\svlanginfo{\typeout{On parle francais.}\global\let\svlanginfo\relax}} +\let\switcht@@therlang\relax +\let\svlanginfo\relax +% +\AtBeginDocument{\@ifpackageloaded{babel}{% +\@ifundefined{extrasenglish}{}{\addto\extrasenglish{\switcht@albion}}% +\@ifundefined{extrasUKenglish}{}{\addto\extrasUKenglish{\switcht@albion}}% +\@ifundefined{extrasfrenchb}{}{\addto\extrasfrenchb{\switcht@francais}}% +\@ifundefined{extrasgerman}{}{\addto\extrasgerman{\switcht@deutsch}}% +\@ifundefined{extrasngerman}{}{\addto\extrasngerman{\switcht@deutsch}}% +}{\switcht@@therlang}% +} +% +\def\ClassInfoNoLine#1#2{% + \ClassInfo{#1}{#2\@gobble}% +} +\let\journalopt\@empty +\DeclareOption*{% +\InputIfFileExists{sv\CurrentOption.clo}{% +\global\let\journalopt\CurrentOption}{% +\ClassWarning{Springer-SVJour3}{Specified option or subpackage +"\CurrentOption" not found -}\OptionNotUsed}} +\ExecuteOptions{a4paper,twoside,10pt,instindent} +\ProcessOptions +% +\ifx\journalopt\@empty\relax +\ClassInfoNoLine{Springer-SVJour3}{extra/valid Springer sub-package (-> *.clo) +\MessageBreak not found in option list of \string\documentclass +\MessageBreak - autoactivating "global" style}{} +\input{svglov3.clo} +\else +\@ifundefined{validfor}{% +\ClassError{Springer-SVJour3}{Possible option clash for sub-package +\MessageBreak "sv\journalopt.clo" - option file not valid +\MessageBreak for this class}{Perhaps you used an option of the old +Springer class SVJour!} +}{} +\fi +% +\if@smartrunh\AtEndDocument{\islastpageeven\getlastpagenumber}\fi +% +\newcommand{\twocoltest}[2]{\if@twocolumn\def\@gtempa{#2}\else\def\@gtempa{#1}\fi +\@gtempa\makeatother} +\newcommand{\columncase}{\makeatletter\twocoltest} +% +\DeclareMathSymbol{\Gamma}{\mathalpha}{letters}{"00} +\DeclareMathSymbol{\Delta}{\mathalpha}{letters}{"01} +\DeclareMathSymbol{\Theta}{\mathalpha}{letters}{"02} +\DeclareMathSymbol{\Lambda}{\mathalpha}{letters}{"03} +\DeclareMathSymbol{\Xi}{\mathalpha}{letters}{"04} +\DeclareMathSymbol{\Pi}{\mathalpha}{letters}{"05} +\DeclareMathSymbol{\Sigma}{\mathalpha}{letters}{"06} +\DeclareMathSymbol{\Upsilon}{\mathalpha}{letters}{"07} +\DeclareMathSymbol{\Phi}{\mathalpha}{letters}{"08} +\DeclareMathSymbol{\Psi}{\mathalpha}{letters}{"09} +\DeclareMathSymbol{\Omega}{\mathalpha}{letters}{"0A} +% +\setlength\parindent{15\p@} +\setlength\smallskipamount{3\p@ \@plus 1\p@ \@minus 1\p@} +\setlength\medskipamount{6\p@ \@plus 2\p@ \@minus 2\p@} +\setlength\bigskipamount{12\p@ \@plus 4\p@ \@minus 4\p@} +\setlength\headheight{12\p@} +\setlength\headsep {14.50dd} +\setlength\topskip {10\p@} +\setlength\footskip{30\p@} +\setlength\maxdepth{.5\topskip} +% +\@settopoint\textwidth +\setlength\marginparsep {10\p@} +\setlength\marginparpush{5\p@} +\setlength\topmargin{-10pt} +\if@twocolumn + \setlength\oddsidemargin {-30\p@} + \setlength\evensidemargin{-30\p@} +\else + \setlength\oddsidemargin {\z@} + \setlength\evensidemargin{\z@} +\fi +\setlength\marginparwidth {48\p@} +\setlength\footnotesep{8\p@} +\setlength{\skip\footins}{9\p@ \@plus 4\p@ \@minus 2\p@} +\setlength\floatsep {12\p@ \@plus 2\p@ \@minus 2\p@} +\setlength\textfloatsep{20\p@ \@plus 2\p@ \@minus 4\p@} +\setlength\intextsep {20\p@ \@plus 2\p@ \@minus 2\p@} +\setlength\dblfloatsep {12\p@ \@plus 2\p@ \@minus 2\p@} +\setlength\dbltextfloatsep{20\p@ \@plus 2\p@ \@minus 4\p@} +\setlength\@fptop{0\p@} +\setlength\@fpsep{12\p@ \@plus 2\p@ \@minus 2\p@} +\setlength\@fpbot{0\p@ \@plus 1fil} +\setlength\@dblfptop{0\p@} +\setlength\@dblfpsep{12\p@ \@plus 2\p@ \@minus 2\p@} +\setlength\@dblfpbot{0\p@ \@plus 1fil} +\setlength\partopsep{2\p@ \@plus 1\p@ \@minus 1\p@} +\def\@listi{\leftmargin\leftmargini + \parsep \z@ + \topsep 6\p@ \@plus2\p@ \@minus4\p@ + \itemsep\parsep} +\let\@listI\@listi +\@listi +\def\@listii {\leftmargin\leftmarginii + \labelwidth\leftmarginii + \advance\labelwidth-\labelsep + \topsep \z@ + \parsep \topsep + \itemsep \parsep} +\def\@listiii{\leftmargin\leftmarginiii + \labelwidth\leftmarginiii + \advance\labelwidth-\labelsep + \topsep \z@ + \parsep \topsep + \itemsep \parsep} +\def\@listiv {\leftmargin\leftmarginiv + \labelwidth\leftmarginiv + \advance\labelwidth-\labelsep} +\def\@listv {\leftmargin\leftmarginv + \labelwidth\leftmarginv + \advance\labelwidth-\labelsep} +\def\@listvi {\leftmargin\leftmarginvi + \labelwidth\leftmarginvi + \advance\labelwidth-\labelsep} +% +\setlength\lineskip{1\p@} +\setlength\normallineskip{1\p@} +\renewcommand\baselinestretch{} +\setlength\parskip{0\p@ \@plus \p@} +\@lowpenalty 51 +\@medpenalty 151 +\@highpenalty 301 +\setcounter{topnumber}{4} +\renewcommand\topfraction{.9} +\setcounter{bottomnumber}{2} +\renewcommand\bottomfraction{.7} +\setcounter{totalnumber}{6} +\renewcommand\textfraction{.1} +\renewcommand\floatpagefraction{.85} +\setcounter{dbltopnumber}{3} +\renewcommand\dbltopfraction{.85} +\renewcommand\dblfloatpagefraction{.85} +\def\ps@headings{% + \let\@oddfoot\@empty\let\@evenfoot\@empty + \def\@evenhead{\small\csname runheadhook\endcsname + \rlap{\thepage}\hfil\leftmark\unskip}% + \def\@oddhead{\small\csname runheadhook\endcsname + \ignorespaces\rightmark\hfil\llap{\thepage}}% + \let\@mkboth\@gobbletwo + \let\sectionmark\@gobble + \let\subsectionmark\@gobble + } +% make indentations changeable +\def\setitemindent#1{\settowidth{\labelwidth}{#1}% + \leftmargini\labelwidth + \advance\leftmargini\labelsep + \def\@listi{\leftmargin\leftmargini + \labelwidth\leftmargini\advance\labelwidth by -\labelsep + \parsep=\parskip + \topsep=\medskipamount + \itemsep=\parskip \advance\itemsep by -\parsep}} +\def\setitemitemindent#1{\settowidth{\labelwidth}{#1}% + \leftmarginii\labelwidth + \advance\leftmarginii\labelsep +\def\@listii{\leftmargin\leftmarginii + \labelwidth\leftmarginii\advance\labelwidth by -\labelsep + \parsep=\parskip + \topsep=\z@ + \itemsep=\parskip \advance\itemsep by -\parsep}} +% labels of description +\def\descriptionlabel#1{\hspace\labelsep #1\hfil} +% adjusted environment "description" +% if an optional parameter (at the first two levels of lists) +% is present, its width is considered to be the widest mark +% throughout the current list. +\def\description{\@ifnextchar[{\@describe}{\list{}{\labelwidth\z@ + \itemindent-\leftmargin \let\makelabel\descriptionlabel}}} +\let\enddescription\endlist +% +\def\describelabel#1{#1\hfil} +\def\@describe[#1]{\relax\ifnum\@listdepth=0 +\setitemindent{#1}\else\ifnum\@listdepth=1 +\setitemitemindent{#1}\fi\fi +\list{--}{\let\makelabel\describelabel}} +% +\newdimen\logodepth +\logodepth=1.2cm +\newdimen\headerboxheight +\headerboxheight=163pt % 18 10.5dd-lines - 2\baselineskip +\if@twocolumn\else\advance\headerboxheight by-14.5mm\fi +\newdimen\betweenumberspace % dimension for space between +\betweenumberspace=3.33pt % number and text of titles. +\newdimen\aftertext % dimension for space after +\aftertext=5pt % text of title. +\newdimen\headlineindent % dimension for space between +\headlineindent=1.166cm % number and text of headings. +\if@mathematic + \def\runinend{} % \enspace} + \def\floatcounterend{\enspace} + \def\sectcounterend{} +\else + \def\runinend{.} + \def\floatcounterend{.\ } + \def\sectcounterend{.} +\fi +\def\email#1{\emailname: #1} +\def\keywords#1{\par\addvspace\medskipamount{\rightskip=0pt plus1cm +\def\and{\ifhmode\unskip\nobreak\fi\ $\cdot$ +}\noindent\keywordname\enspace\ignorespaces#1\par}} +% +\def\subclassname{{\bfseries Mathematics Subject Classification +(2000)}\enspace} +\def\subclass#1{\par\addvspace\medskipamount{\rightskip=0pt plus1cm +\def\and{\ifhmode\unskip\nobreak\fi\ $\cdot$ +}\noindent\subclassname\ignorespaces#1\par}} +% +\def\PACSname{\textbf{PACS}\enspace} +\def\PACS#1{\par\addvspace\medskipamount{\rightskip=0pt plus1cm +\def\and{\ifhmode\unskip\nobreak\fi\ $\cdot$ +}\noindent\PACSname\ignorespaces#1\par}} +% +\def\CRclassname{{\bfseries CR Subject Classification}\enspace} +\def\CRclass#1{\par\addvspace\medskipamount{\rightskip=0pt plus1cm +\def\and{\ifhmode\unskip\nobreak\fi\ $\cdot$ +}\noindent\CRclassname\ignorespaces#1\par}} +% +\def\ESMname{\textbf{Electronic Supplementary Material}\enspace} +\def\ESM#1{\par\addvspace\medskipamount +\noindent\ESMname\ignorespaces#1\par} +% +\newcounter{inst} +\newcounter{auth} +\def\authdepth{2} +\newdimen\instindent +\newbox\authrun +\newtoks\authorrunning +\newbox\titrun +\newtoks\titlerunning +\def\authorfont{\bfseries} + +\def\combirunning#1{\gdef\@combi{#1}} +\def\@combi{} +\newbox\combirun +% +\def\ps@last{\def\@evenhead{\small\rlap{\thepage}\hfil +\lastevenhead}} +\newcounter{lastpage} +\def\islastpageeven{\@ifundefined{lastpagenumber} +{\setcounter{lastpage}{0}}{\setcounter{lastpage}{\lastpagenumber}} +\ifnum\value{lastpage}>0 + \ifodd\value{lastpage}% + \else + \if@smartrunh + \thispagestyle{last}% + \fi + \fi +\fi} +\def\getlastpagenumber{\clearpage +\addtocounter{page}{-1}% + \immediate\write\@auxout{\string\gdef\string\lastpagenumber{\thepage}}% + \immediate\write\@auxout{\string\newlabel{LastPage}{{}{\thepage}}}% + \addtocounter{page}{1}} + +\def\journalname#1{\gdef\@journalname{#1}} + +\def\dedication#1{\gdef\@dedic{#1}} +\def\@dedic{} + +\let\@date\undefined +\def\notused{~} + +\def\institute#1{\gdef\@institute{#1}} + +\def\offprints#1{\begingroup +\def\protect{\noexpand\protect\noexpand}\xdef\@thanks{\@thanks +\protect\footnotetext[0]{\unskip\hskip-15pt{\itshape Send offprint requests +to\/}: \ignorespaces#1}}\endgroup\ignorespaces} + +%\def\mail#1{\gdef\@mail{#1}} +%\def\@mail{} + +\def\@thanks{} + +\def\@fnsymbol#1{\ifcase#1\or\star\or{\star\star}\or{\star\star\star}% + \or \dagger\or \ddagger\or + \mathchar "278\or \mathchar "27B\or \|\or **\or \dagger\dagger + \or \ddagger\ddagger \else\@ctrerr\fi\relax} +% +%\def\invthanks#1{\footnotetext[0]{\kern-\bibindent#1}} +% +\def\nothanksmarks{\def\thanks##1{\protected@xdef\@thanks{\@thanks + \protect\footnotetext[0]{\kern-\bibindent##1}}}} +% +\def\subtitle#1{\gdef\@subtitle{#1}} +\def\@subtitle{} + +\def\headnote#1{\gdef\@headnote{#1}} +\def\@headnote{} + +\def\papertype#1{\gdef\paper@type{\MakeUppercase{#1}}} +\def\paper@type{} + +\def\ch@ckobl#1#2{\@ifundefined{@#1} + {\typeout{SVJour3 warning: Missing +\expandafter\string\csname#1\endcsname}% + \csname #1\endcsname{#2}} + {}} +% +\def\ProcessRunnHead{% + \def\\{\unskip\ \ignorespaces}% + \def\thanks##1{\unskip{}}% + \instindent=\textwidth + \advance\instindent by-\headlineindent + \if!\the\titlerunning!\else + \edef\@title{\the\titlerunning}% + \fi + \global\setbox\titrun=\hbox{\small\rmfamily\unboldmath\ignorespaces\@title + \unskip}% + \ifdim\wd\titrun>\instindent + \typeout{^^JSVJour3 Warning: Title too long for running head.}% + \typeout{Please supply a shorter form with \string\titlerunning + \space prior to \string\maketitle}% + \global\setbox\titrun=\hbox{\small\rmfamily + Title Suppressed Due to Excessive Length}% + \fi + \xdef\@title{\copy\titrun}% +% + \if!\the\authorrunning! + \else + \setcounter{auth}{1}% + \edef\@author{\the\authorrunning}% + \fi + \ifnum\value{inst}>\authdepth + \def\stripauthor##1\and##2\endauthor{% + \protected@xdef\@author{##1\unskip\unskip\if!##2!\else\ et al.\fi}}% + \expandafter\stripauthor\@author\and\endauthor + \else + \gdef\and{\unskip, \ignorespaces}% + {\def\and{\noexpand\protect\noexpand\and}% + \protected@xdef\@author{\@author}} + \fi + \global\setbox\authrun=\hbox{\small\rmfamily\unboldmath\ignorespaces + \@author\unskip}% + \ifdim\wd\authrun>\instindent + \typeout{^^JSVJour3 Warning: Author name(s) too long for running head. + ^^JPlease supply a shorter form with \string\authorrunning + \space prior to \string\maketitle}% + \global\setbox\authrun=\hbox{\small\rmfamily Please give a shorter version + with: {\tt\string\authorrunning\space and + \string\titlerunning\space prior to \string\maketitle}}% + \fi + \xdef\@author{\copy\authrun}% + \markboth{\@author}{\@title}% +} +% +\let\orithanks=\thanks +\def\thanks#1{\ClassWarning{SVJour3}{\string\thanks\space may only be +used inside of \string\title, \string\author,\MessageBreak +and \string\date\space prior to \string\maketitle}} +% +\def\maketitle{\par\let\thanks=\orithanks +\ch@ckobl{journalname}{Noname} +\ch@ckobl{date}{the date of receipt and acceptance should be inserted +later} +\ch@ckobl{title}{A title should be given} +\ch@ckobl{author}{Name(s) and initial(s) of author(s) should be given} +\ch@ckobl{institute}{Address(es) of author(s) should be given} +\begingroup +% + \renewcommand\thefootnote{\@fnsymbol\c@footnote}% + \def\@makefnmark{$^{\@thefnmark}$}% + \renewcommand\@makefntext[1]{% + \noindent + \hb@xt@\bibindent{\hss\@makefnmark\enspace}##1\vrule height0pt + width0pt depth8pt} +% + \def\lastand{\ifnum\value{inst}=2\relax + \unskip{} \andname\ + \else + \unskip, \andname\ + \fi}% + \def\and{\stepcounter{auth}\relax + \if@smartand + \ifnum\value{auth}=\value{inst}% + \lastand + \else + \unskip, + \fi + \else + \unskip, + \fi}% + \thispagestyle{empty} + \ifnum \col@number=\@ne + \@maketitle + \else + \twocolumn[\@maketitle]% + \fi +% + \global\@topnum\z@ + \if!\@thanks!\else + \@thanks +\insert\footins{\vskip-3pt\hrule\@width\if@twocolumn\columnwidth +\else 38mm\fi\vskip3pt}% + \fi + {\def\thanks##1{\unskip{}}% + \def\iand{\\[5pt]\let\and=\nand}% + \def\nand{\ifhmode\unskip\nobreak\fi\ $\cdot$ }% + \let\and=\nand + \def\at{\\\let\and=\iand}% + \footnotetext[0]{\kern-\bibindent + \ignorespaces\@institute}\vspace{5dd}}% +%\if!\@mail!\else +% \footnotetext[0]{\kern-\bibindent\mailname\ +% \ignorespaces\@mail}% +%\fi +% + \if@runhead + \ProcessRunnHead + \fi +% + \endgroup + \setcounter{footnote}{0} + \global\let\thanks\relax + \global\let\maketitle\relax + \global\let\@maketitle\relax + \global\let\@thanks\@empty + \global\let\@author\@empty + \global\let\@date\@empty + \global\let\@title\@empty + \global\let\@subtitle\@empty + \global\let\title\relax + \global\let\author\relax + \global\let\date\relax + \global\let\and\relax} + +\def\makeheadbox{{% +\hbox to0pt{\vbox{\baselineskip=10dd\hrule\hbox +to\hsize{\vrule\kern3pt\vbox{\kern3pt +\hbox{\bfseries\@journalname\ manuscript No.} +\hbox{(will be inserted by the editor)} +\kern3pt}\hfil\kern3pt\vrule}\hrule}% +\hss}}} +% +\def\rubric{\setbox0=\hbox{\small\strut}\@tempdima=\ht0\advance +\@tempdima\dp0\advance\@tempdima2\fboxsep\vrule\@height\@tempdima +\@width\z@} +\newdimen\rubricwidth +% +\def\@maketitle{\newpage +\normalfont +\vbox to0pt{\if@twocolumn\vskip-39pt\else\vskip-49pt\fi +\nointerlineskip +\makeheadbox\vss}\nointerlineskip +\vbox to 0pt{\offinterlineskip\rubricwidth=\columnwidth +%%%%\vskip-12.5pt % -12.5pt +\if@twocolumn\else % one column journal + \divide\rubricwidth by144\multiply\rubricwidth by89 % perform golden section + \vskip-\topskip +\fi +\hrule\@height0.35mm\noindent +\advance\fboxsep by.25mm +\global\advance\rubricwidth by0pt +\rubric +\vss}\vskip19.5pt % war 9pt +% +\if@twocolumn\else + \gdef\footnoterule{% + \kern-3\p@ + \hrule\@width38mm % \columnwidth \rubricwidth + \kern2.6\p@} +\fi +% + \setbox\authrun=\vbox\bgroup + \if@twocolumn + \hrule\@height10.5mm\@width0\p@ + \else + \hrule\@height 2mm\@width0\p@ + \fi + \pretolerance=10000 + \rightskip=0pt plus 4cm + \nothanksmarks +% \if!\@headnote!\else +% \noindent +% {\LARGE\normalfont\itshape\ignorespaces\@headnote\par}\vskip 3.5mm +% \fi + {\LARGE\bfseries + \noindent\ignorespaces + \@title \par}\vskip 17pt\relax + \if!\@subtitle!\else + {\large\bfseries + \pretolerance=10000 + \rightskip=0pt plus 3cm + \vskip-12pt +% \noindent\ignorespaces\@subtitle \par}\vskip 11.24pt\relax + \noindent\ignorespaces\@subtitle \par}\vskip 17pt\relax + \fi + {\authorfont + \setbox0=\vbox{\setcounter{auth}{1}\def\and{\stepcounter{auth} }% + \hfuzz=2\textwidth\def\thanks##1{}\@author}% + \setcounter{footnote}{0}% + \global\value{inst}=\value{auth}% + \setcounter{auth}{1}% + \if@twocolumn + \rightskip43mm plus 4cm minus 3mm + \else % one column journal + \rightskip=\linewidth + \advance\rightskip by-\rubricwidth + \advance\rightskip by0pt plus 4cm minus 3mm + \fi +% +\def\and{\unskip\nobreak\enskip{\boldmath$\cdot$}\enskip\ignorespaces}% + \noindent\ignorespaces\@author\vskip7.23pt} +% + \small + \if!\@dedic!\else + \par + \normalsize\it + \addvspace\baselineskip + \noindent\@dedic + \fi + \egroup % end of header box + \@tempdima=\headerboxheight + \advance\@tempdima by-\ht\authrun + \unvbox\authrun + \ifdim\@tempdima>0pt + \vrule width0pt height\@tempdima\par + \fi + \noindent{\small\@date\if@twocolumn\vskip 7.2mm\else\vskip 5.2mm\fi} + \global\@minipagetrue + \global\everypar{\global\@minipagefalse\global\everypar{}}% +%\vskip22.47pt +} +% +\if@mathematic + \def\vec#1{\ensuremath{\mathchoice + {\mbox{\boldmath$\displaystyle\mathbf{#1}$}} + {\mbox{\boldmath$\textstyle\mathbf{#1}$}} + {\mbox{\boldmath$\scriptstyle\mathbf{#1}$}} + {\mbox{\boldmath$\scriptscriptstyle\mathbf{#1}$}}}} +\else + \def\vec#1{\ensuremath{\mathchoice + {\mbox{\boldmath$\displaystyle#1$}} + {\mbox{\boldmath$\textstyle#1$}} + {\mbox{\boldmath$\scriptstyle#1$}} + {\mbox{\boldmath$\scriptscriptstyle#1$}}}} +\fi +% +\def\tens#1{\ensuremath{\mathsf{#1}}} +% +\setcounter{secnumdepth}{3} +\newcounter {section} +\newcounter {subsection}[section] +\newcounter {subsubsection}[subsection] +\newcounter {paragraph}[subsubsection] +\newcounter {subparagraph}[paragraph] +\renewcommand\thesection {\@arabic\c@section} +\renewcommand\thesubsection {\thesection.\@arabic\c@subsection} +\renewcommand\thesubsubsection{\thesubsection.\@arabic\c@subsubsection} +\renewcommand\theparagraph {\thesubsubsection.\@arabic\c@paragraph} +\renewcommand\thesubparagraph {\theparagraph.\@arabic\c@subparagraph} +% +\def\@hangfrom#1{\setbox\@tempboxa\hbox{#1}% + \hangindent \z@\noindent\box\@tempboxa} +% +\def\@seccntformat#1{\csname the#1\endcsname\sectcounterend +\hskip\betweenumberspace} +% +% \newif\if@sectrule +% \if@twocolumn\else\let\@sectruletrue=\relax\fi +% \if@avier\let\@sectruletrue=\relax\fi +% \def\makesectrule{\if@sectrule\global\@sectrulefalse\null\vglue-\topskip +% \hrule\nobreak\parskip=5pt\relax\fi} +% % +% \let\makesectruleori=\makesectrule +% \def\restoresectrule{\global\let\makesectrule=\makesectruleori\global\@sectrulefalse} +% \def\nosectrule{\let\makesectrule=\restoresectrule} +% +\def\@startsection#1#2#3#4#5#6{% + \if@noskipsec \leavevmode \fi + \par + \@tempskipa #4\relax + \@afterindenttrue + \ifdim \@tempskipa <\z@ + \@tempskipa -\@tempskipa \@afterindentfalse + \fi + \if@nobreak + \everypar{}% + \else + \addpenalty\@secpenalty\addvspace\@tempskipa + \fi +% \ifnum#2=1\relax\@sectruletrue\fi + \@ifstar + {\@ssect{#3}{#4}{#5}{#6}}% + {\@dblarg{\@sect{#1}{#2}{#3}{#4}{#5}{#6}}}} +% +\def\@sect#1#2#3#4#5#6[#7]#8{% + \ifnum #2>\c@secnumdepth + \let\@svsec\@empty + \else + \refstepcounter{#1}% + \protected@edef\@svsec{\@seccntformat{#1}\relax}% + \fi + \@tempskipa #5\relax + \ifdim \@tempskipa>\z@ + \begingroup + #6{% \makesectrule + \@hangfrom{\hskip #3\relax\@svsec}% + \raggedright + \hyphenpenalty \@M% + \interlinepenalty \@M #8\@@par}% + \endgroup + \csname #1mark\endcsname{#7}% + \addcontentsline{toc}{#1}{% + \ifnum #2>\c@secnumdepth \else + \protect\numberline{\csname the#1\endcsname\sectcounterend}% + \fi + #7}% + \else + \def\@svsechd{% + #6{\hskip #3\relax + \@svsec #8\/\hskip\aftertext}% + \csname #1mark\endcsname{#7}% + \addcontentsline{toc}{#1}{% + \ifnum #2>\c@secnumdepth \else + \protect\numberline{\csname the#1\endcsname}% + \fi + #7}}% + \fi + \@xsect{#5}} +% +\def\@ssect#1#2#3#4#5{% + \@tempskipa #3\relax + \ifdim \@tempskipa>\z@ + \begingroup + #4{% \makesectrule + \@hangfrom{\hskip #1}% + \interlinepenalty \@M #5\@@par}% + \endgroup + \else + \def\@svsechd{#4{\hskip #1\relax #5}}% + \fi + \@xsect{#3}} + +% +% measures and setting of sections +% +\def\section{\@startsection{section}{1}{\z@}% + {-21dd plus-8pt minus-4pt}{10.5dd} + {\normalsize\bfseries\boldmath}} +\def\subsection{\@startsection{subsection}{2}{\z@}% + {-21dd plus-8pt minus-4pt}{10.5dd} + {\normalsize\upshape}} +\def\subsubsection{\@startsection{subsubsection}{3}{\z@}% + {-13dd plus-8pt minus-4pt}{10.5dd} + {\normalsize\itshape}} +\def\paragraph{\@startsection{paragraph}{4}{\z@}% + {-13pt plus-8pt minus-4pt}{\z@}{\normalsize\itshape}} + +\setlength\leftmargini {\parindent} +\leftmargin \leftmargini +\setlength\leftmarginii {\parindent} +\setlength\leftmarginiii {1.87em} +\setlength\leftmarginiv {1.7em} +\setlength\leftmarginv {.5em} +\setlength\leftmarginvi {.5em} +\setlength \labelsep {.5em} +\setlength \labelwidth{\leftmargini} +\addtolength\labelwidth{-\labelsep} +\@beginparpenalty -\@lowpenalty +\@endparpenalty -\@lowpenalty +\@itempenalty -\@lowpenalty +\renewcommand\theenumi{\@arabic\c@enumi} +\renewcommand\theenumii{\@alph\c@enumii} +\renewcommand\theenumiii{\@roman\c@enumiii} +\renewcommand\theenumiv{\@Alph\c@enumiv} +\newcommand\labelenumi{\theenumi.} +\newcommand\labelenumii{(\theenumii)} +\newcommand\labelenumiii{\theenumiii.} +\newcommand\labelenumiv{\theenumiv.} +\renewcommand\p@enumii{\theenumi} +\renewcommand\p@enumiii{\theenumi(\theenumii)} +\renewcommand\p@enumiv{\p@enumiii\theenumiii} +\newcommand\labelitemi{\normalfont\bfseries --} +\newcommand\labelitemii{\normalfont\bfseries --} +\newcommand\labelitemiii{$\m@th\bullet$} +\newcommand\labelitemiv{$\m@th\cdot$} + +\if@spthms +% definition of the "\spnewtheorem" command. +% +% Usage: +% +% \spnewtheorem{env_nam}{caption}[within]{cap_font}{body_font} +% or \spnewtheorem{env_nam}[numbered_like]{caption}{cap_font}{body_font} +% or \spnewtheorem*{env_nam}{caption}{cap_font}{body_font} +% +% New is "cap_font" and "body_font". It stands for +% fontdefinition of the caption and the text itself. +% +% "\spnewtheorem*" gives a theorem without number. +% +% A defined spnewthoerem environment is used as described +% by Lamport. +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\def\@thmcountersep{} +\def\@thmcounterend{} +\newcommand\nocaption{\noexpand\@gobble} +\newdimen\spthmsep \spthmsep=5pt + +\def\spnewtheorem{\@ifstar{\@sthm}{\@Sthm}} + +% definition of \spnewtheorem with number + +\def\@spnthm#1#2{% + \@ifnextchar[{\@spxnthm{#1}{#2}}{\@spynthm{#1}{#2}}} +\def\@Sthm#1{\@ifnextchar[{\@spothm{#1}}{\@spnthm{#1}}} + +\def\@spxnthm#1#2[#3]#4#5{\expandafter\@ifdefinable\csname #1\endcsname + {\@definecounter{#1}\@addtoreset{#1}{#3}% + \expandafter\xdef\csname the#1\endcsname{\expandafter\noexpand + \csname the#3\endcsname \noexpand\@thmcountersep \@thmcounter{#1}}% + \expandafter\xdef\csname #1name\endcsname{#2}% + \global\@namedef{#1}{\@spthm{#1}{\csname #1name\endcsname}{#4}{#5}}% + \global\@namedef{end#1}{\@endtheorem}}} + +\def\@spynthm#1#2#3#4{\expandafter\@ifdefinable\csname #1\endcsname + {\@definecounter{#1}% + \expandafter\xdef\csname the#1\endcsname{\@thmcounter{#1}}% + \expandafter\xdef\csname #1name\endcsname{#2}% + \global\@namedef{#1}{\@spthm{#1}{\csname #1name\endcsname}{#3}{#4}}% + \global\@namedef{end#1}{\@endtheorem}}} + +\def\@spothm#1[#2]#3#4#5{% + \@ifundefined{c@#2}{\@latexerr{No theorem environment `#2' defined}\@eha}% + {\expandafter\@ifdefinable\csname #1\endcsname + {\global\@namedef{the#1}{\@nameuse{the#2}}% + \expandafter\xdef\csname #1name\endcsname{#3}% + \global\@namedef{#1}{\@spthm{#2}{\csname #1name\endcsname}{#4}{#5}}% + \global\@namedef{end#1}{\@endtheorem}}}} + +\def\@spthm#1#2#3#4{\topsep 7\p@ \@plus2\p@ \@minus4\p@ +\labelsep=\spthmsep\refstepcounter{#1}% +\@ifnextchar[{\@spythm{#1}{#2}{#3}{#4}}{\@spxthm{#1}{#2}{#3}{#4}}} + +\def\@spxthm#1#2#3#4{\@spbegintheorem{#2}{\csname the#1\endcsname}{#3}{#4}% + \ignorespaces} + +\def\@spythm#1#2#3#4[#5]{\@spopargbegintheorem{#2}{\csname + the#1\endcsname}{#5}{#3}{#4}\ignorespaces} + +\def\normalthmheadings{\def\@spbegintheorem##1##2##3##4{\trivlist\normalfont + \item[\hskip\labelsep{##3##1\ ##2\@thmcounterend}]##4} +\def\@spopargbegintheorem##1##2##3##4##5{\trivlist + \item[\hskip\labelsep{##4##1\ ##2}]{##4(##3)\@thmcounterend\ }##5}} +\normalthmheadings + +\def\reversethmheadings{\def\@spbegintheorem##1##2##3##4{\trivlist\normalfont + \item[\hskip\labelsep{##3##2\ ##1\@thmcounterend}]##4} +\def\@spopargbegintheorem##1##2##3##4##5{\trivlist + \item[\hskip\labelsep{##4##2\ ##1}]{##4(##3)\@thmcounterend\ }##5}} + +% definition of \spnewtheorem* without number + +\def\@sthm#1#2{\@Ynthm{#1}{#2}} + +\def\@Ynthm#1#2#3#4{\expandafter\@ifdefinable\csname #1\endcsname + {\global\@namedef{#1}{\@Thm{\csname #1name\endcsname}{#3}{#4}}% + \expandafter\xdef\csname #1name\endcsname{#2}% + \global\@namedef{end#1}{\@endtheorem}}} + +\def\@Thm#1#2#3{\topsep 7\p@ \@plus2\p@ \@minus4\p@ +\@ifnextchar[{\@Ythm{#1}{#2}{#3}}{\@Xthm{#1}{#2}{#3}}} + +\def\@Xthm#1#2#3{\@Begintheorem{#1}{#2}{#3}\ignorespaces} + +\def\@Ythm#1#2#3[#4]{\@Opargbegintheorem{#1} + {#4}{#2}{#3}\ignorespaces} + +\def\@Begintheorem#1#2#3{#3\trivlist + \item[\hskip\labelsep{#2#1\@thmcounterend}]} + +\def\@Opargbegintheorem#1#2#3#4{#4\trivlist + \item[\hskip\labelsep{#3#1}]{#3(#2)\@thmcounterend\ }} + +% initialize theorem environment + +\if@envcntsect + \def\@thmcountersep{.} + \spnewtheorem{theorem}{Theorem}[section]{\bfseries}{\itshape} +\else + \spnewtheorem{theorem}{Theorem}{\bfseries}{\itshape} + \if@envcntreset + \@addtoreset{theorem}{section} + \else + \@addtoreset{theorem}{chapter} + \fi +\fi + +%definition of divers theorem environments +\spnewtheorem*{claim}{Claim}{\itshape}{\rmfamily} +\spnewtheorem*{proof}{Proof}{\itshape}{\rmfamily} +\if@envcntsame % all environments like "Theorem" - using its counter + \def\spn@wtheorem#1#2#3#4{\@spothm{#1}[theorem]{#2}{#3}{#4}} +\else % all environments with their own counter + \if@envcntsect % show section counter + \def\spn@wtheorem#1#2#3#4{\@spxnthm{#1}{#2}[section]{#3}{#4}} + \else % not numbered with section + \if@envcntreset + \def\spn@wtheorem#1#2#3#4{\@spynthm{#1}{#2}{#3}{#4} + \@addtoreset{#1}{section}} + \else + \let\spn@wtheorem=\@spynthm + \fi + \fi +\fi +% +\let\spdefaulttheorem=\spn@wtheorem +% +\spn@wtheorem{case}{Case}{\itshape}{\rmfamily} +\spn@wtheorem{conjecture}{Conjecture}{\itshape}{\rmfamily} +\spn@wtheorem{corollary}{Corollary}{\bfseries}{\itshape} +\spn@wtheorem{definition}{Definition}{\bfseries}{\rmfamily} +\spn@wtheorem{example}{Example}{\itshape}{\rmfamily} +\spn@wtheorem{exercise}{Exercise}{\bfseries}{\rmfamily} +\spn@wtheorem{lemma}{Lemma}{\bfseries}{\itshape} +\spn@wtheorem{note}{Note}{\itshape}{\rmfamily} +\spn@wtheorem{problem}{Problem}{\bfseries}{\rmfamily} +\spn@wtheorem{property}{Property}{\itshape}{\rmfamily} +\spn@wtheorem{proposition}{Proposition}{\bfseries}{\itshape} +\spn@wtheorem{question}{Question}{\itshape}{\rmfamily} +\spn@wtheorem{solution}{Solution}{\bfseries}{\rmfamily} +\spn@wtheorem{remark}{Remark}{\itshape}{\rmfamily} +% +\newenvironment{theopargself} + {\def\@spopargbegintheorem##1##2##3##4##5{\trivlist + \item[\hskip\labelsep{##4##1\ ##2}]{##4##3\@thmcounterend\ }##5} + \def\@Opargbegintheorem##1##2##3##4{##4\trivlist + \item[\hskip\labelsep{##3##1}]{##3##2\@thmcounterend\ }}}{} +\newenvironment{theopargself*} + {\def\@spopargbegintheorem##1##2##3##4##5{\trivlist + \item[\hskip\labelsep{##4##1\ ##2}]{\hspace*{-\labelsep}##4##3\@thmcounterend}##5} + \def\@Opargbegintheorem##1##2##3##4{##4\trivlist + \item[\hskip\labelsep{##3##1}]{\hspace*{-\labelsep}##3##2\@thmcounterend}}}{} +% +\fi + +\def\@takefromreset#1#2{% + \def\@tempa{#1}% + \let\@tempd\@elt + \def\@elt##1{% + \def\@tempb{##1}% + \ifx\@tempa\@tempb\else + \@addtoreset{##1}{#2}% + \fi}% + \expandafter\expandafter\let\expandafter\@tempc\csname cl@#2\endcsname + \expandafter\def\csname cl@#2\endcsname{}% + \@tempc + \let\@elt\@tempd} + +\def\squareforqed{\hbox{\rlap{$\sqcap$}$\sqcup$}} +\def\qed{\ifmmode\else\unskip\quad\fi\squareforqed} +\def\smartqed{\def\qed{\ifmmode\squareforqed\else{\unskip\nobreak\hfil +\penalty50\hskip1em\null\nobreak\hfil\squareforqed +\parfillskip=0pt\finalhyphendemerits=0\endgraf}\fi}} + +% Define `abstract' environment +\def\abstract{\topsep=0pt\partopsep=0pt\parsep=0pt\itemsep=0pt\relax +\trivlist\item[\hskip\labelsep +{\bfseries\abstractname}]\if!\abstractname!\hskip-\labelsep\fi} +\if@twocolumn +% \if@avier +% \def\endabstract{\endtrivlist\addvspace{5mm}\strich} +% \def\strich{\hrule\vskip1ptplus12pt} +% \else + \def\endabstract{\endtrivlist\addvspace{3mm}} +% \fi +\else +\fi +% +\newenvironment{verse} + {\let\\\@centercr + \list{}{\itemsep \z@ + \itemindent -1.5em% + \listparindent\itemindent + \rightmargin \leftmargin + \advance\leftmargin 1.5em}% + \item\relax} + {\endlist} +\newenvironment{quotation} + {\list{}{\listparindent 1.5em% + \itemindent \listparindent + \rightmargin \leftmargin + \parsep \z@ \@plus\p@}% + \item\relax} + {\endlist} +\newenvironment{quote} + {\list{}{\rightmargin\leftmargin}% + \item\relax} + {\endlist} +\newcommand\appendix{\par\small + \setcounter{section}{0}% + \setcounter{subsection}{0}% + \renewcommand\thesection{\@Alph\c@section}} +\setlength\arraycolsep{1.5\p@} +\setlength\tabcolsep{6\p@} +\setlength\arrayrulewidth{.4\p@} +\setlength\doublerulesep{2\p@} +\setlength\tabbingsep{\labelsep} +\skip\@mpfootins = \skip\footins +\setlength\fboxsep{3\p@} +\setlength\fboxrule{.4\p@} +\renewcommand\theequation{\@arabic\c@equation} +\newcounter{figure} +\renewcommand\thefigure{\@arabic\c@figure} +\def\fps@figure{tbp} +\def\ftype@figure{1} +\def\ext@figure{lof} +\def\fnum@figure{\figurename~\thefigure} +\newenvironment{figure} + {\@float{figure}} + {\end@float} +\newenvironment{figure*} + {\@dblfloat{figure}} + {\end@dblfloat} +\newcounter{table} +\renewcommand\thetable{\@arabic\c@table} +\def\fps@table{tbp} +\def\ftype@table{2} +\def\ext@table{lot} +\def\fnum@table{\tablename~\thetable} +\newenvironment{table} + {\@float{table}} + {\end@float} +\newenvironment{table*} + {\@dblfloat{table}} + {\end@dblfloat} +% +\def \@floatboxreset {% + \reset@font + \small + \@setnobreak + \@setminipage +} +% +\newcommand{\tableheadseprule}{\noalign{\hrule height.375mm}} +% +\newlength\abovecaptionskip +\newlength\belowcaptionskip +\setlength\abovecaptionskip{10\p@} +\setlength\belowcaptionskip{0\p@} +\newcommand\leftlegendglue{} + +\def\fig@type{figure} + +\newdimen\figcapgap\figcapgap=3pt +\newdimen\tabcapgap\tabcapgap=5.5pt + +\@ifundefined{floatlegendstyle}{\def\floatlegendstyle{\bfseries}}{} + +\long\def\@caption#1[#2]#3{\par\addcontentsline{\csname + ext@#1\endcsname}{#1}{\protect\numberline{\csname + the#1\endcsname}{\ignorespaces #2}}\begingroup + \@parboxrestore + \@makecaption{\csname fnum@#1\endcsname}{\ignorespaces #3}\par + \endgroup} + +\def\capstrut{\vrule\@width\z@\@height\topskip} + +\@ifundefined{captionstyle}{\def\captionstyle{\normalfont\small}}{} + +\long\def\@makecaption#1#2{% + \captionstyle + \ifx\@captype\fig@type + \vskip\figcapgap + \fi + \setbox\@tempboxa\hbox{{\floatlegendstyle #1\floatcounterend}% + \capstrut #2}% + \ifdim \wd\@tempboxa >\hsize + {\floatlegendstyle #1\floatcounterend}\capstrut #2\par + \else + \hbox to\hsize{\leftlegendglue\unhbox\@tempboxa\hfil}% + \fi + \ifx\@captype\fig@type\else + \vskip\tabcapgap + \fi} + +\newdimen\figgap\figgap=1cc +\long\def\@makesidecaption#1#2{% + \parbox[b]{\@tempdimb}{\captionstyle{\floatlegendstyle + #1\floatcounterend}#2}} +\def\sidecaption#1\caption{% +\setbox\@tempboxa=\hbox{#1\unskip}% +\if@twocolumn + \ifdim\hsize<\textwidth\else + \ifdim\wd\@tempboxa<\columnwidth + \typeout{Double column float fits into single column - + ^^Jyou'd better switch the environment. }% + \fi + \fi +\fi +\@tempdimb=\hsize +\advance\@tempdimb by-\figgap +\advance\@tempdimb by-\wd\@tempboxa +\ifdim\@tempdimb<3cm + \typeout{\string\sidecaption: No sufficient room for the legend; + using normal \string\caption. }% + \unhbox\@tempboxa + \let\@capcommand=\@caption +\else + \let\@capcommand=\@sidecaption + \leavevmode + \unhbox\@tempboxa + \hfill +\fi +\refstepcounter\@captype +\@dblarg{\@capcommand\@captype}} + +\long\def\@sidecaption#1[#2]#3{\addcontentsline{\csname + ext@#1\endcsname}{#1}{\protect\numberline{\csname + the#1\endcsname}{\ignorespaces #2}}\begingroup + \@parboxrestore + \@makesidecaption{\csname fnum@#1\endcsname}{\ignorespaces #3}\par + \endgroup} + +% Define `acknowledgement' environment +\def\acknowledgement{\par\addvspace{17pt}\small\rmfamily +\trivlist\if!\ackname!\item[]\else +\item[\hskip\labelsep +{\bfseries\ackname}]\fi} +\def\endacknowledgement{\endtrivlist\addvspace{6pt}} +\newenvironment{acknowledgements}{\begin{acknowledgement}} +{\end{acknowledgement}} +% Define `noteadd' environment +\def\noteadd{\par\addvspace{17pt}\small\rmfamily +\trivlist\item[\hskip\labelsep +{\itshape\noteaddname}]} +\def\endnoteadd{\endtrivlist\addvspace{6pt}} + +\DeclareOldFontCommand{\rm}{\normalfont\rmfamily}{\mathrm} +\DeclareOldFontCommand{\sf}{\normalfont\sffamily}{\mathsf} +\DeclareOldFontCommand{\tt}{\normalfont\ttfamily}{\mathtt} +\DeclareOldFontCommand{\bf}{\normalfont\bfseries}{\mathbf} +\DeclareOldFontCommand{\it}{\normalfont\itshape}{\mathit} +\DeclareOldFontCommand{\sl}{\normalfont\slshape}{\@nomath\sl} +\DeclareOldFontCommand{\sc}{\normalfont\scshape}{\@nomath\sc} +\DeclareRobustCommand*\cal{\@fontswitch\relax\mathcal} +\DeclareRobustCommand*\mit{\@fontswitch\relax\mathnormal} +\newcommand\@pnumwidth{1.55em} +\newcommand\@tocrmarg{2.55em} +\newcommand\@dotsep{4.5} +\setcounter{tocdepth}{1} +\newcommand\tableofcontents{% + \section*{\contentsname}% + \@starttoc{toc}% + \addtocontents{toc}{\begingroup\protect\small}% + \AtEndDocument{\addtocontents{toc}{\endgroup}}% + } +\newcommand*\l@part[2]{% + \ifnum \c@tocdepth >-2\relax + \addpenalty\@secpenalty + \addvspace{2.25em \@plus\p@}% + \begingroup + \setlength\@tempdima{3em}% + \parindent \z@ \rightskip \@pnumwidth + \parfillskip -\@pnumwidth + {\leavevmode + \large \bfseries #1\hfil \hb@xt@\@pnumwidth{\hss #2}}\par + \nobreak + \if@compatibility + \global\@nobreaktrue + \everypar{\global\@nobreakfalse\everypar{}}% + \fi + \endgroup + \fi} +\newcommand*\l@section{\@dottedtocline{1}{0pt}{1.5em}} +\newcommand*\l@subsection{\@dottedtocline{2}{1.5em}{2.3em}} +\newcommand*\l@subsubsection{\@dottedtocline{3}{3.8em}{3.2em}} +\newcommand*\l@paragraph{\@dottedtocline{4}{7.0em}{4.1em}} +\newcommand*\l@subparagraph{\@dottedtocline{5}{10em}{5em}} +\newcommand\listoffigures{% + \section*{\listfigurename + \@mkboth{\listfigurename}% + {\listfigurename}}% + \@starttoc{lof}% + } +\newcommand*\l@figure{\@dottedtocline{1}{1.5em}{2.3em}} +\newcommand\listoftables{% + \section*{\listtablename + \@mkboth{\listtablename}{\listtablename}}% + \@starttoc{lot}% + } +\let\l@table\l@figure +\newdimen\bibindent +\setlength\bibindent{\parindent} +\def\@biblabel#1{#1.} +\def\@lbibitem[#1]#2{\item[{[#1]}\hfill]\if@filesw + {\let\protect\noexpand + \immediate + \write\@auxout{\string\bibcite{#2}{#1}}}\fi\ignorespaces} +\newenvironment{thebibliography}[1] + {\section*{\refname + \@mkboth{\refname}{\refname}}\small + \list{\@biblabel{\@arabic\c@enumiv}}% + {\settowidth\labelwidth{\@biblabel{#1}}% + \leftmargin\labelwidth + \advance\leftmargin\labelsep + \@openbib@code + \usecounter{enumiv}% + \let\p@enumiv\@empty + \renewcommand\theenumiv{\@arabic\c@enumiv}}% + \sloppy\clubpenalty4000\widowpenalty4000% + \sfcode`\.\@m} + {\def\@noitemerr + {\@latex@warning{Empty `thebibliography' environment}}% + \endlist} +% +\newcount\@tempcntc +\def\@citex[#1]#2{\if@filesw\immediate\write\@auxout{\string\citation{#2}}\fi + \@tempcnta\z@\@tempcntb\m@ne\def\@citea{}\@cite{\@for\@citeb:=#2\do + {\@ifundefined + {b@\@citeb}{\@citeo\@tempcntb\m@ne\@citea\def\@citea{,}{\bfseries + ?}\@warning + {Citation `\@citeb' on page \thepage \space undefined}}% + {\setbox\z@\hbox{\global\@tempcntc0\csname b@\@citeb\endcsname\relax}% + \ifnum\@tempcntc=\z@ \@citeo\@tempcntb\m@ne + \@citea\def\@citea{,\hskip0.1em\ignorespaces}\hbox{\csname b@\@citeb\endcsname}% + \else + \advance\@tempcntb\@ne + \ifnum\@tempcntb=\@tempcntc + \else\advance\@tempcntb\m@ne\@citeo + \@tempcnta\@tempcntc\@tempcntb\@tempcntc\fi\fi}}\@citeo}{#1}} +\def\@citeo{\ifnum\@tempcnta>\@tempcntb\else + \@citea\def\@citea{,\hskip0.1em\ignorespaces}% + \ifnum\@tempcnta=\@tempcntb\the\@tempcnta\else + {\advance\@tempcnta\@ne\ifnum\@tempcnta=\@tempcntb \else \def\@citea{--}\fi + \advance\@tempcnta\m@ne\the\@tempcnta\@citea\the\@tempcntb}\fi\fi} +% +\newcommand\newblock{\hskip .11em\@plus.33em\@minus.07em} +\let\@openbib@code\@empty +\newenvironment{theindex} + {\if@twocolumn + \@restonecolfalse + \else + \@restonecoltrue + \fi + \columnseprule \z@ + \columnsep 35\p@ + \twocolumn[\section*{\indexname}]% + \@mkboth{\indexname}{\indexname}% + \thispagestyle{plain}\parindent\z@ + \parskip\z@ \@plus .3\p@\relax + \let\item\@idxitem} + {\if@restonecol\onecolumn\else\clearpage\fi} +\newcommand\@idxitem{\par\hangindent 40\p@} +\newcommand\subitem{\@idxitem \hspace*{20\p@}} +\newcommand\subsubitem{\@idxitem \hspace*{30\p@}} +\newcommand\indexspace{\par \vskip 10\p@ \@plus5\p@ \@minus3\p@\relax} + +\if@twocolumn + \renewcommand\footnoterule{% + \kern-3\p@ + \hrule\@width\columnwidth + \kern2.6\p@} +\else + \renewcommand\footnoterule{% + \kern-3\p@ + \hrule\@width.382\columnwidth + \kern2.6\p@} +\fi +\newcommand\@makefntext[1]{% + \noindent + \hb@xt@\bibindent{\hss\@makefnmark\enspace}#1} +% +\def\trans@english{\switcht@albion} +\def\trans@french{\switcht@francais} +\def\trans@german{\switcht@deutsch} +\newenvironment{translation}[1]{\if!#1!\else +\@ifundefined{selectlanguage}{\csname trans@#1\endcsname}{\selectlanguage{#1}}% +\fi}{} +% languages +% English section +\def\switcht@albion{%\typeout{English spoken.}% + \def\abstractname{Abstract}% + \def\ackname{Acknowledgements}% + \def\andname{and}% + \def\lastandname{, and}% + \def\appendixname{Appendix}% + \def\chaptername{Chapter}% + \def\claimname{Claim}% + \def\conjecturename{Conjecture}% + \def\contentsname{Contents}% + \def\corollaryname{Corollary}% + \def\definitionname{Definition}% + \def\emailname{E-mail}% + \def\examplename{Example}% + \def\exercisename{Exercise}% + \def\figurename{Fig.}% + \def\keywordname{{\bfseries Keywords}}% + \def\indexname{Index}% + \def\lemmaname{Lemma}% + \def\contriblistname{List of Contributors}% + \def\listfigurename{List of Figures}% + \def\listtablename{List of Tables}% + \def\mailname{{\itshape Correspondence to\/}:}% + \def\noteaddname{Note added in proof}% + \def\notename{Note}% + \def\partname{Part}% + \def\problemname{Problem}% + \def\proofname{Proof}% + \def\propertyname{Property}% + \def\questionname{Question}% + \def\refname{References}% + \def\remarkname{Remark}% + \def\seename{see}% + \def\solutionname{Solution}% + \def\tablename{Table}% + \def\theoremname{Theorem}% +}\switcht@albion % make English default +% +% French section +\def\switcht@francais{\svlanginfo +%\typeout{On parle francais.}% + \def\abstractname{R\'esum\'e\runinend}% + \def\ackname{Remerciements\runinend}% + \def\andname{et}% + \def\lastandname{ et}% + \def\appendixname{Appendice}% + \def\chaptername{Chapitre}% + \def\claimname{Pr\'etention}% + \def\conjecturename{Hypoth\`ese}% + \def\contentsname{Table des mati\`eres}% + \def\corollaryname{Corollaire}% + \def\definitionname{D\'efinition}% + \def\emailname{E-mail}% + \def\examplename{Exemple}% + \def\exercisename{Exercice}% + \def\figurename{Fig.}% + \def\keywordname{{\bfseries Mots-cl\'e\runinend}}% + \def\indexname{Index}% + \def\lemmaname{Lemme}% + \def\contriblistname{Liste des contributeurs}% + \def\listfigurename{Liste des figures}% + \def\listtablename{Liste des tables}% + \def\mailname{{\itshape Correspondence to\/}:}% + \def\noteaddname{Note ajout\'ee \`a l'\'epreuve}% + \def\notename{Remarque}% + \def\partname{Partie}% + \def\problemname{Probl\`eme}% + \def\proofname{Preuve}% + \def\propertyname{Caract\'eristique}% +%\def\propositionname{Proposition}% + \def\questionname{Question}% + \def\refname{Bibliographie}% + \def\remarkname{Remarque}% + \def\seename{voyez}% + \def\solutionname{Solution}% +%\def\subclassname{{\it Subject Classifications\/}:}% + \def\tablename{Tableau}% + \def\theoremname{Th\'eor\`eme}% +} +% +% German section +\def\switcht@deutsch{\svlanginfo +%\typeout{Man spricht deutsch.}% + \def\abstractname{Zusammenfassung\runinend}% + \def\ackname{Danksagung\runinend}% + \def\andname{und}% + \def\lastandname{ und}% + \def\appendixname{Anhang}% + \def\chaptername{Kapitel}% + \def\claimname{Behauptung}% + \def\conjecturename{Hypothese}% + \def\contentsname{Inhaltsverzeichnis}% + \def\corollaryname{Korollar}% +%\def\definitionname{Definition}% + \def\emailname{E-Mail}% + \def\examplename{Beispiel}% + \def\exercisename{\"Ubung}% + \def\figurename{Abb.}% + \def\keywordname{{\bfseries Schl\"usselw\"orter\runinend}}% + \def\indexname{Index}% +%\def\lemmaname{Lemma}% + \def\contriblistname{Mitarbeiter}% + \def\listfigurename{Abbildungsverzeichnis}% + \def\listtablename{Tabellenverzeichnis}% + \def\mailname{{\itshape Correspondence to\/}:}% + \def\noteaddname{Nachtrag}% + \def\notename{Anmerkung}% + \def\partname{Teil}% +%\def\problemname{Problem}% + \def\proofname{Beweis}% + \def\propertyname{Eigenschaft}% +%\def\propositionname{Proposition}% + \def\questionname{Frage}% + \def\refname{Literatur}% + \def\remarkname{Anmerkung}% + \def\seename{siehe}% + \def\solutionname{L\"osung}% +%\def\subclassname{{\it Subject Classifications\/}:}% + \def\tablename{Tabelle}% +%\def\theoremname{Theorem}% +} +\newcommand\today{} +\edef\today{\ifcase\month\or + January\or February\or March\or April\or May\or June\or + July\or August\or September\or October\or November\or December\fi + \space\number\day, \number\year} +\setlength\columnsep{1.5cc} +\setlength\columnseprule{0\p@} +% +\frenchspacing +\clubpenalty=10000 +\widowpenalty=10000 +\def\thisbottomragged{\def\@textbottom{\vskip\z@ plus.0001fil +\global\let\@textbottom\relax}} +\pagestyle{headings} +\pagenumbering{arabic} +\if@twocolumn + \twocolumn +\fi +%\if@avier +% \onecolumn +% \setlength{\textwidth}{156mm} +% \setlength{\textheight}{226mm} +%\fi +\if@referee + \makereferee +\fi +\flushbottom +\endinput +%% +%% End of file `svjour3.cls'.