source: trunk/doc/first_page.doxygen.in

// @configure_input@
// $Id: first_page.doxygen.in 3562 2017-01-04 01:16:07Z peter $

/*
  Copyright (C) 2003, 2004 Jari Häkkinen
  Copyright (C) 2005, 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
  Copyright (C) 2010, 2013, 2014, 2017 Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 3 of the
  License, or (at your option) any later version.

  The yat library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with yat. If not, see <http://www.gnu.org/licenses/>.
*/

/**
   @mainpage @PACKAGE@

   \latexonly \textbf{Release @PACKAGE_VERSION@} \vspace{2ex}
   \endlatexonly

   <p> This is the reference documentation for the yat C++
   library. </p>


   <h2>Library highlights</h2>

   <p>
   <ul>

   <li><a href="http://www.gnu.org/software/gsl/">Gnu Scientific
   Library, GSL</a> connectivity - The internal implementation of the
   package is designed for GSL use.</li>

   <li>Supervised classifier classes including support vector machines.</li>

   <li>Statistics classes.</li>

   <li>Missing values - Most functionality come in two versions: one
   optimized for speed and one weighted version allowing missing
   values.</li>

   <li>Random number generation - sampling from several different
   distributions.</li>

   <li> Wrapper classes for <a
   href="http://www.htslib.org//">htslib</a> allowing
   handling BAM reads with <a
   href="http://www.sgi.com/tech/stl/table_of_contents.html">Standard
   Template Library</a> such as standard algorithms and containers.

   </ul>
   </p>

   \htmlonly <p> The library is divided into several <a
   href="namespaces.html">namespaces</a>. At the top there are tabs to
   the documentation of the <a href="annotated.html">classes</a>. You
   will find the non-member operators and functions through the <a
   href="namespacemembers.html">namespace members</a> tab above. </p>
   \endhtmlonly


   <h2>Future development</h2>

   <p> The yat project uses trac as issue tracking system. Forthcoming
   releases are scheduled in the <a
   href="@PACKAGE_URL@/roadmap">yat road map</a>. Future
   development can be monitored through the list of <a
   href="@PACKAGE_URL@/query">known issues</a>. You can
   report bugs and suggest enhancements by sending an email to <a
   href="mailto:@PACKAGE_BUGREPORT@/"> @PACKAGE_BUGREPORT@ </a>. </p>


   <h2>Download</h2>

   <p> You can <a
   href="http://sourceforge.net/projects/libyat/files/">download
   yat</a> at the project web site. </p>


   <h2>License</h2>

   <p> The yat library is an open source project and available for
   free under the <a href="http://www.gnu.org/copyleft/gpl.html"> GNU
   General Public License version 3</a>. </p>

*/