source: trunk/doc/namespaces.doxygen @ 3133

Last change on this file since 3133 was 3130, checked in by Peter, 8 years ago

merge release 0.11 into trunk

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.5 KB
Line 
1// $Id: namespaces.doxygen 3130 2013-11-18 07:38:59Z peter $
2
3/*
4  Copyright (C) 2005 Jari Häkkinen, Peter Johansson, Markus Ringnér
5  Copyright (C) 2006, 2007, 2008 Jari Häkkinen, Peter Johansson
6  Copyright (C) 2010, 2011 Peter Johansson
7  Copyright (C) 2013 Jari Häkkinen
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/// @namespace theplu
27///
28/// All C++ projects at the Department of Theoretical Physics should
29/// ideally be defined within a common namespace. We use theplu for
30/// this common namespace.
31///
32/// @brief The Department of Theoretical Physics namespace as we
33/// define it.
34///
35
36///
37/// @namespace theplu::yat
38///
39/// All classes and functions are for the yat project is placed in sub
40/// namespaces of the yat namespace.
41///
42/// @brief yat project namespace.
43///
44
45///
46/// @namespace theplu::yat::random
47///
48/// The yat random number related functionality is placed within the
49/// random namespace.
50///
51/// @brief Random number distributions.
52///
53
54///
55/// @namespace theplu::yat::classifier
56///
57/// All classes associated with usage of classifiers are defined
58/// within this namespace.
59///
60/// @brief Classifier related classes.
61///
62
63///
64/// @namespace theplu::yat::normalizer
65///
66/// @brief Normalization of data
67///
68
69///
70/// @namespace theplu::yat::omic
71///
72/// @brief Classes and functions related to genomics and proteomics
73///
74
75///
76/// @namespace theplu::yat::regression
77///
78/// @brief Statistical modeling of data.
79///
80
81///
82/// @namespace theplu::yat::statistics
83///
84/// All classes and functions related to statistical methods or
85/// functions are defined within this namespace. See
86/// \ref weighted_statistics.
87///
88/// @brief Statistical methods, classes, and functions.
89///
90
91///
92/// @namespace theplu::yat::utility
93///
94/// Needed yat functionality that we don't know where to put usually
95/// ends up in the utility namespace until we figure out their proper
96/// namespace location.
97///
98/// @brief Miscellaneous functionality.
99///
Note: See TracBrowser for help on using the repository browser.