%===========================================================================%
%                                                                           %
% This file is part of the documentation for the SYMPHONY MILP Solver.      %
%                                                                           %
% SYMPHONY was jointly developed by Ted Ralphs (tkralphs@lehigh.edu) and    %
% Laci Ladanyi (ladanyi@us.ibm.com).                                        %
%                                                                           %
% (c) Copyright 2000-2006 Ted Ralphs. All Rights Reserved.                  %
%                                                                           %
% SYMPHONY is licensed under the Common Public License. Please see          %
% accompanying file for terms.                                              %
%                                                                           %
%===========================================================================%

\documentclass[twoside,11pt]{book}

\oddsidemargin 0in
\evensidemargin 0in
\topmargin 0in
\textwidth 6.5in
\newlength{\headwidth}
\setlength{\headwidth}{\textwidth}
\addtolength{\headwidth}{-4.4444pt}
\textheight 8.7in
\setcounter{secnumdepth}{3}

\catcode`\@=11\relax   %allow @ in macro names

\if@twoside         % If two-sided printing.
\def\ps@headings{\let\@mkboth\markboth
\def\@oddfoot{}\def\@evenfoot{}%       No feet.
\def\@evenhead{
\begin{tabular}{@{}c@{}}
\hspace*{\headwidth} \\[-3ex]
\rm \thepage  \hfill  \sl \leftmark \\
\hline
\end{tabular}
} % Left heading.
\def\@oddhead{
%{\flushleft \sl \rightmark}
%\vspace*{-1ex}
%{\flushright \rm \thepage}
%\vspace*{-1ex}
%{\flushleft \underline{\hspace*{\headwidth}}}
\begin{tabular}{@{}c@{}}
\hspace*{\headwidth} \\[-3ex]
\sl \rightmark \hfill \rm \thepage \\
\hline
\end{tabular}
} % Right heading.
\def\sectionmark##1{\markboth {\uppercase{\ifnum \c@secnumdepth >\z@
    \thesection\hskip 1em\relax \fi ##1}}{}}%
\def\subsectionmark##1{\markright {\ifnum \c@secnumdepth >\@ne
          \thesubsection\hskip 1em\relax \fi ##1}}}%
\else               % If one-sided printing.
\def\ps@headings{\let\@mkboth\markboth
\def\@oddfoot{}\def\@evenfoot{}%     No feet.
\def\@oddhead{
\begin{tabular}{@{}c@{}}
\hspace*{\headwidth} \\[-3ex]
\sl \rightmark \hfill \rm \thepage \\
\hline
\end{tabular}
} % Heading.
\def\sectionmark##1{\markright {\uppercase{\ifnum \c@secnumdepth >\z@
    \thesection\hskip 1em\relax \fi ##1}}}}
\fi

\catcode`\@=12\relax   %disable @ in macro names

\pagestyle{headings}

\markright{\bf \thesection}{}

\usepackage{epsfig, html}
\usepackage{amsmath}
\usepackage{amssymb}
\usepackage{fullpage}
\usepackage{easyeqn}
\usepackage{fancyvrb}
\usepackage{listings}
\usepackage{url}
\usepackage{splitidx}
\usepackage[usenames]{color}

\makeindex
\newindex[Index of C API Functions]{f}
\newindex[Index of User Callback API Functions]{cf}
\newindex[Index of Parameters]{p}
\def\GP{{Global Pramaters}}
\def\DP{{Draw Graph Pramaters}}
\def\MP{{Master Module Pramaters}}
\def\TP{{Tree Manager Pramaters}}
\def\LPP{{LP Pramaters}}
\def\CP{{Cut Pool Pramaters}}
\def\CGP{{Cut Generator Pramaters}}
\def\VER{{5.1.1}}
\lstloadlanguages{C++}

\newcommand{\be}{\begin{enumerate}}
\newcommand{\ee}{\end{enumerate}}
\newcommand{\bc}{\begin{center}}
\newcommand{\ec}{\end{center}}
\newcommand{\bt}{\begin{tabular}}
\newcommand{\et}{\end{tabular}}
\newcommand{\bd}{\begin{description}}
\newcommand{\ed}{\end{description}}
\newcommand{\bi}{\begin{itemize}}
\newcommand{\ei}{\end{itemize}}
\newcommand{\bv}{\begin{verbatim}}
\newcommand{\ev}{\end{verbatim}}
\newcommand{\functiondef}[1]{\subsubsection{#1}}
\newcommand{\firstfuncdef}[1]{\subsubsection{#1}}
\newcommand{\code}[1]{{\color{Brown}\texttt{#1}}}
%begin{latexonly}
\renewcommand{\functiondef}[1]{\newpage \item[\Large $\triangleright$] 
{\color{red}{\bf
\Large #1}}}
\renewcommand{\firstfuncdef}[1]{\item[\Large $\triangleright$] 
{\color{red}{\bf 
\Large #1}}}
%end{latexonly}
\newcommand{\describe}{\item[{\color{cyan}Description:}] \hfill}
\newcommand{\args}{\item[{\color{Brown}Arguments:}] \hfill}
\newcommand{\returns}{\item[{\color{green}Return values:}] \hfill}
\newcommand{\postp}{\item[Post-processing:] \hfill}
\newcommand{\nopostp}{\item[Post-processing:] None \hfill}

\newcommand{\BB}{{\sc SYMPHONY}}
\newcommand{\TM}{{\sc TreeManager}}
\newcommand{\LP}{{\sc LP}}
\newcommand{\ra}{$\rightarrow$}
\newcommand{\vmin}{\mathop{\text{vmin}}}
\newcommand{\Z}{\mathbb{Z}}
\newcommand{\Q}{\mathbb{Q}}
\renewcommand{\Re}{\mathbb{R}}
\newcommand{\ptt}[1]{{\tt {\color{BrickRed} #1}}} 
\newcommand{\bs}{{$\backslash$}}

\usepackage[latex2html,dvipdfm,colorlinks]{hyperref}
\hypersetup{
  linkcolor=blue,
}

%\htmladdtonavigation{\htmladdnormallink 
%       {\htmladdimg{contents_motif.gif}}{man.html}}

\setlength{\parindent}{0in}
\setlength{\parskip}{0.1in}


\begin{document}

%
%\ \\
%\vspace*{.5in}

\frontmatter
\begin{rawhtml} <H1 ALIGN="CENTER"> 
\end{rawhtml}
\title{\huge {\bf \BB\ \VER\  User's Manual} \thanks{This research was partially
supported by NSF Grants DMS-9527124, DMI-0534862, and DMI-0522796, as well as
Texas ATP Grant 97-3604-010. A revised version of Chapters
\ref{SYMPHONY-design} of this manual now appears
in the Springer-Verlag book {\em Computational Combinatorial Optimization}
edited by M. J\"unger and D. Naddef, see \url{
http://link.springer.de/link/service/series/0558/tocs/t2241.htm}}
%begin{latexonly}
\vskip 1.7in
\LARGE 
\vskip .2in
T.K. Ralphs\thanks{Department of Industrial and
Systems Engineering, Lehigh University, Bethlehem, PA 18017, {\tt 
\htmladdnormallink{tkralphs@lehigh.edu}{mailto:tkralphs@lehigh.edu}}, 
{\tt \url{http://www.lehigh.edu/\~tkr2}}} \\
M. G\"uzelsoy\thanks{Department of Industrial and
Systems Engineering, Lehigh University, Bethlehem, PA 18017, {\tt
  \htmladdnormallink{megb@lehigh.edu}{mailto:megb@lehigh.edu}}, {\tt \url{http://coral.ie.lehigh.edu/\~menal}}} \\
%\vskip .5in
%Interactive Graph Drawing \\
%Software By \\
%\vskip .2in
%M. Es\"o\thanks{Department of Mathematical Sciences, 
%IBM T.J. Watson Research Center, Yorktown Heights,
%NY 10598}
%\vskip .5in
%end{latexonly}
}
\maketitle
\begin{rawhtml} </H1> 
\end{rawhtml}
\begin{htmlonly}
\begin{center}
{\LARGE 
\vskip 2.2in
\begin{rawhtml} <P ALIGN="CENTER"> <STRONG> <FONT SIZE="4">
\end{rawhtml}
\vskip .2in
T.K. Ralphs \\
M. G\"uzelsoy \\
\begin{rawhtml} </P> </FONT> </STRONG> 
\end{rawhtml}
%\vskip .5in
%\begin{rawhtml} <P ALIGN="CENTER"> <STRONG> <FONT SIZE="4">
%\end{rawhtml}
%Interactive Graph Drawing \\
%Software By \\
%\vskip .2in
%M. Es\"o}
%\begin{rawhtml} </P> </FONT> </STRONG> 
%\end{rawhtml}
\begin{rawhtml} <P ALIGN="CENTER"> <STRONG> <FONT SIZE="3">
PDF version available <A
HREF="https://projects.coin-or.org/SYMPHONY">here</A>
</FONT></STRONG></P>
\end{rawhtml}
\begin{rawhtml} </P> </FONT> </STRONG> 
\end{rawhtml}
\begin{rawhtml} <P ALIGN="CENTER"> <STRONG> <FONT SIZE="3">
A revised version of Chapter 4
of this manual now appears in the Springer-Verlag book
<br> <i><a
href="http://link.springer.de/link/service/series/0558/tocs/t2241.htm">
Computational Combinatorial Optimization </i></a> edited by M. Juenger and
D. Naddef.  </FONT></STRONG></P>
\end{rawhtml}

\end{center}
\end{htmlonly}

\newpage

\thispagestyle{empty}

\ \\
%begin{latexonly}
\vspace*{3in}
%end{latexonly}
\begin{rawhtml} <P ALIGN="CENTER"> <STRONG> 
\end{rawhtml}
\begin{center}
{\copyright 2000-2006 Ted Ralphs}
\end{center}
\begin{rawhtml} </P> </STRONG> 
\end{rawhtml}
\begin{rawhtml} <HR>
\end{rawhtml}

\newpage

\thispagestyle{empty}

%begin{latexonly}
\vspace*{1in}
%end{latexonly}
\begin{rawhtml} <P ALIGN="CENTER"> <STRONG> 
\end{rawhtml}
\begin{center}
\textbf{\large Acknowledgments}
\end{center}
\begin{rawhtml} </P> </STRONG> 
\end{rawhtml}
\begin{rawhtml} <P> <FONT SIZE="2"> 
\end{rawhtml}
First and foremost, many thanks are due to Laci Lad\'anyi who worked with me
on the development of an early precursor of SYMPHONY called COMPSys and who
taught me much of what I then knew about programming. Many thanks are due also
to Marta Es\"o, who wrote an early draft of this manual for what was then
COMPSys. This release would not have been possible without the help of Menal
G\"uzelsoy, who has been instrumental in the development of SYMPHONY since
version 4.0. I would also like to thank Matthew Galati and Ondrej Medek, who
contributed to the development of SYMPHONY over the years. Finally, my sincere
appreciation goes to Leslie Trotter, William Cook, Cornell University, Rice
University, Lehigh University, the National Science Foundation, and the state
of Texas, all of whom have supported the development of SYMPHONY.
\begin{rawhtml} </P> </FONT> 
\end{rawhtml}

%begin{latexonly}
\newpage

\thispagestyle{empty}

%end{latexonly}
\newpage

\tableofcontents

\newpage

\mainmatter

%\setcounter{page}{1}

\chapter{Introduction}
\input{man-intro}

\chapter{Installing SYMPHONY}
\label{getting_started}
\input{man-start}

\chapter{Using SYMPHONY}
\label{API-overview}
\input{man-API}

\chapter{Technical Details}
\label{SYMPHONY-design}
\input{man-design}

\chapter{Developing Custom Applications}
\label{SYMPHONY-development}
\input{man-SYMPHONY}

\chapter{Reference}
\label{SYMPHONY-reference}

\section{Callable Library C API}
\label{callable-library}
\input{man-callable}

\section{User Callback API}
\label{API}
\sloppy
\input{man-tm}

\newpage

\input{man-lp}

\newpage

\input{man-cg}

\newpage

\input{man-cp}

\newpage

\input{man-dg}

\newpage

\section{Run-time Parameters}
\label{params}
\input{man-param}

%\newpage

%\section{Bibliography}

\backmatter

\cleardoublepage
\phantomsection
\addcontentsline{toc}{chapter}{Bibliography}
\bibliographystyle{plain}
\bibliography{/home/menal/PAPERS/BIB/bib}

%\input{biblio}

%\newpage
%\section{Constant Names}

%\input{man-consts}


\cleardoublepage
\phantomsection
%\refstepcounter{chapter}
\addcontentsline{toc}{chapter}{Index}
\printindex*
\end{document}
