source: trunk/doc/namespaces.doxygen @ 2608

Last change on this file since 2608 was 2608, checked in by Peter, 10 years ago

delete trailing newlines

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.5 KB
RevLine 
[303]1// $Id: namespaces.doxygen 2608 2011-11-01 02:47:32Z peter $
2
[675]3/*
[2119]4  Copyright (C) 2005 Jari Häkkinen, Peter Johansson, Markus Ringnér
5  Copyright (C) 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
[2591]6  Copyright (C) 2010, 2011 Peter Johansson
[675]7
[1437]8  This file is part of the yat library, http://dev.thep.lu.se/yat
[675]9
10  The yat library is free software; you can redistribute it and/or
11  modify it under the terms of the GNU General Public License as
[1486]12  published by the Free Software Foundation; either version 3 of the
[675]13  License, or (at your option) any later version.
14
15  The yat library is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  General Public License for more details.
19
20  You should have received a copy of the GNU General Public License
[1487]21  along with yat. If not, see <http://www.gnu.org/licenses/>.
[675]22*/
23
[304]24///
25/// @namespace theplu
26///
[680]27/// All C++ projects at the Department of Theoretical Physics should
28/// ideally be defined within a common namespace. We use theplu for
29/// this common namespace.
30///
31/// @brief The Department of Theoretical Physics namespace as we
32/// define it.
33///
[303]34
[680]35///
36/// @namespace theplu::yat
[304]37///
[680]38/// All classes and functions are for the yat project is placed in sub
39/// namespaces of the yat namespace.
[367]40///
[680]41/// @brief yat project namespace.
[391]42///
[367]43
44///
[680]45/// @namespace theplu::yat::random
[304]46///
[2582]47/// The yat random number related functionality is placed within the
[680]48/// random namespace.
[304]49///
[680]50/// @brief Random number distributions.
51///
[304]52
53///
[680]54/// @namespace theplu::yat::classifier
55///
56/// All classes associated with usage of classifiers are defined
57/// within this namespace.
[304]58///
[680]59/// @brief Classifier related classes.
[304]60///
61
62///
[1497]63/// @namespace theplu::yat::normalizer
[1430]64///
65/// @brief Normalization of data
66///
67
68///
[2341]69/// @namespace theplu::yat::omic
70///
71/// @brief Classes and functions related to genomics and proteomics
72///
73
74///
[1430]75/// @namespace theplu::yat::regression
76///
77/// @brief Statistical modeling of data.
78///
79
80///
[680]81/// @namespace theplu::yat::statistics
[304]82///
[680]83/// All classes and functions related to statistical methods or
[1481]84/// functions are defined within this namespace. See
85/// \ref weighted_statistics<br>.
[680]86///
87/// @brief Statistical methods, classes, and functions.
88///
[304]89
[387]90///
[1430]91/// @namespace theplu::yat::utility
[387]92///
[1430]93/// Needed yat functionality that we don't know where to put usually
94/// ends up in the utility namespace until we figure out their proper
95/// namespace location.
[680]96///
[1430]97/// @brief Miscellaneous functionality.
98///
Note: See TracBrowser for help on using the repository browser.