source: trunk/doc/first_page.doxygen.in @ 3561

Last change on this file since 3561 was 3561, checked in by Peter, 5 years ago

Merged release 0.13.1 into trunk

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