manual.tex

% This is part of the stat-toolkit documentation
% Copyright (C) 2012,2013 Krzysztof Stachowiak
% See the file FDL for copying conditions.

\documentclass{report}

\begin{document}

\title{The statistical toolkit documentation/manual}
\author{Krzysztof Stachowiak}
\date{\today}

\maketitle

\tableofcontents

\section*{License note}
This is part of the stat-toolkit documentation.\\
Copyright (C) 2012,2013 Krzysztof Stachowiak\\
See the file FDL for copying conditions.

\chapter{Libraries}

% Things that should be found in a library section:
% - Summary
%   - The namespaces and the classes
%   - The interface of the relevant classes

\section{Overview}
The libraries, which in this suite take a form of autonomous and atomic C++
header files are the foundation of the entire system. In many cases they are
uniquely tied to one of the command line tools, but others are shared between
the programs. Regardles of the particular use in the suite they are designed to
be as generic as possible and enable potiential use outside of the toolkit.
Therefore their interdependencies are minimized so that in many cases a
particular header file may be simply copied and pasted in another
project\footnote{Note however, that most of them still depends on some of the boost
libraries, so the point is not that they are lightweight, but that they may be
used separately.}.

\input{aggr_lib.tex}
\input{groupby_lib.tex}
\input{histogram_lib.tex}

\chapter{Command Line Interface tools}

% Things that should be found in a cli tool section:
% - List of all options with short descriptions
% - Summary
%   - The explanation of all the concepts (refer to the underlying libraries
%		where possible).
% - Examples

\input{histogram_cli.tex}
\input{aggr_cli.tex}
\input{groupby_cli.tex}
\input{pivot_cli.tex}


\end{document}