doc/first_page.doxygen.in

Code
Comments
Other
Rev Date Author Line
1438 26 Aug 08 peter 1 // @configure_input@
44 26 Feb 04 jari 2 // $Id$
44 26 Feb 04 jari 3
675 10 Oct 06 jari 4 /*
2119 12 Dec 09 peter 5   Copyright (C) 2003, 2004 Jari Häkkinen
4359 23 Aug 23 peter 6   Copyright (C) 2005, 2006 Jari Häkkinen, Peter Johansson
4359 23 Aug 23 peter 7   Copyright (C) 2007 Peter Johansson
4359 23 Aug 23 peter 8   Copyright (C) 2008 Jari Häkkinen, Peter Johansson
3562 04 Jan 17 peter 9   Copyright (C) 2010, 2013, 2014, 2017 Peter Johansson
675 10 Oct 06 jari 10
1437 25 Aug 08 peter 11   This file is part of the yat library, http://dev.thep.lu.se/yat
675 10 Oct 06 jari 12
675 10 Oct 06 jari 13   The yat library is free software; you can redistribute it and/or
675 10 Oct 06 jari 14   modify it under the terms of the GNU General Public License as
1486 09 Sep 08 jari 15   published by the Free Software Foundation; either version 3 of the
675 10 Oct 06 jari 16   License, or (at your option) any later version.
675 10 Oct 06 jari 17
675 10 Oct 06 jari 18   The yat library is distributed in the hope that it will be useful,
675 10 Oct 06 jari 19   but WITHOUT ANY WARRANTY; without even the implied warranty of
675 10 Oct 06 jari 20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
675 10 Oct 06 jari 21   General Public License for more details.
675 10 Oct 06 jari 22
675 10 Oct 06 jari 23   You should have received a copy of the GNU General Public License
1487 10 Sep 08 jari 24   along with yat. If not, see <http://www.gnu.org/licenses/>.
675 10 Oct 06 jari 25 */
675 10 Oct 06 jari 26
5 26 Feb 03 jari 27 /**
1556 09 Oct 08 jari 28    @mainpage @PACKAGE@
5 26 Feb 03 jari 29
1556 09 Oct 08 jari 30    \latexonly \textbf{Release @PACKAGE_VERSION@} \vspace{2ex}
1556 09 Oct 08 jari 31    \endlatexonly
764 22 Feb 07 peter 32
1556 09 Oct 08 jari 33    <p> This is the reference documentation for the yat C++
1556 09 Oct 08 jari 34    library. </p>
764 22 Feb 07 peter 35
764 22 Feb 07 peter 36
1556 09 Oct 08 jari 37    <h2>Library highlights</h2>
764 22 Feb 07 peter 38
1556 09 Oct 08 jari 39    <p>
1556 09 Oct 08 jari 40    <ul>
920 30 Sep 07 peter 41
1556 09 Oct 08 jari 42    <li><a href="http://www.gnu.org/software/gsl/">Gnu Scientific
1556 09 Oct 08 jari 43    Library, GSL</a> connectivity - The internal implementation of the
1556 09 Oct 08 jari 44    package is designed for GSL use.</li>
1556 09 Oct 08 jari 45
1556 09 Oct 08 jari 46    <li>Supervised classifier classes including support vector machines.</li>
1556 09 Oct 08 jari 47
1556 09 Oct 08 jari 48    <li>Statistics classes.</li>
1556 09 Oct 08 jari 49
1556 09 Oct 08 jari 50    <li>Missing values - Most functionality come in two versions: one
1556 09 Oct 08 jari 51    optimized for speed and one weighted version allowing missing
1556 09 Oct 08 jari 52    values.</li>
1556 09 Oct 08 jari 53
1556 09 Oct 08 jari 54    <li>Random number generation - sampling from several different
1556 09 Oct 08 jari 55    distributions.</li>
1556 09 Oct 08 jari 56
3165 15 Jan 14 peter 57    <li> Wrapper classes for <a
3561 04 Jan 17 peter 58    href="http://www.htslib.org//">htslib</a> allowing
3165 15 Jan 14 peter 59    handling BAM reads with <a
3165 15 Jan 14 peter 60    href="http://www.sgi.com/tech/stl/table_of_contents.html">Standard
3165 15 Jan 14 peter 61    Template Library</a> such as standard algorithms and containers.
3165 15 Jan 14 peter 62
1556 09 Oct 08 jari 63    </ul>
1556 09 Oct 08 jari 64    </p>
1556 09 Oct 08 jari 65
1556 09 Oct 08 jari 66    \htmlonly <p> The library is divided into several <a
3183 25 Mar 14 peter 67    href="namespaces.html">namespaces</a>. At the top there are tabs to
1556 09 Oct 08 jari 68    the documentation of the <a href="annotated.html">classes</a>. You
1556 09 Oct 08 jari 69    will find the non-member operators and functions through the <a
1556 09 Oct 08 jari 70    href="namespacemembers.html">namespace members</a> tab above. </p>
1556 09 Oct 08 jari 71    \endhtmlonly
1556 09 Oct 08 jari 72
1556 09 Oct 08 jari 73
1556 09 Oct 08 jari 74    <h2>Future development</h2>
1556 09 Oct 08 jari 75
3067 25 Jul 13 peter 76    <p> The yat project uses trac as issue tracking system. Forthcoming
1556 09 Oct 08 jari 77    releases are scheduled in the <a
2306 04 Aug 10 peter 78    href="@PACKAGE_URL@/roadmap">yat road map</a>. Future
1556 09 Oct 08 jari 79    development can be monitored through the list of <a
3067 25 Jul 13 peter 80    href="@PACKAGE_URL@/query">known issues</a>. You can
3067 25 Jul 13 peter 81    report bugs and suggest enhancements by sending an email to <a
3067 25 Jul 13 peter 82    href="mailto:@PACKAGE_BUGREPORT@/"> @PACKAGE_BUGREPORT@ </a>. </p>
1556 09 Oct 08 jari 83
1556 09 Oct 08 jari 84
1556 09 Oct 08 jari 85    <h2>Download</h2>
1556 09 Oct 08 jari 86
1556 09 Oct 08 jari 87    <p> You can <a
2306 04 Aug 10 peter 88    href="http://sourceforge.net/projects/libyat/files/">download
2306 04 Aug 10 peter 89    yat</a> at the project web site. </p>
1556 09 Oct 08 jari 90
1556 09 Oct 08 jari 91
1556 09 Oct 08 jari 92    <h2>License</h2>
1556 09 Oct 08 jari 93
1556 09 Oct 08 jari 94    <p> The yat library is an open source project and available for
1556 09 Oct 08 jari 95    free under the <a href="http://www.gnu.org/copyleft/gpl.html"> GNU
1556 09 Oct 08 jari 96    General Public License version 3</a>. </p>
1556 09 Oct 08 jari 97
316 17 May 05 peter 98 */