source: trunk/doc/namespaces.doxygen @ 680

Last change on this file since 680 was 680, checked in by Jari Häkkinen, 15 years ago

Addresses #153. Introduced yat namespace. Removed alignment namespace. Clean up of code.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.3 KB
Line 
1// $Id: namespaces.doxygen 680 2006-10-11 17:49:03Z jari $
2
3/*
4  Copyright (C) The authors contributing to this file.
5
6  This file is part of the yat library, http://lev.thep.lu.se/trac/yat
7
8  The yat library is free software; you can redistribute it and/or
9  modify it under the terms of the GNU General Public License as
10  published by the Free Software Foundation; either version 2 of the
11  License, or (at your option) any later version.
12
13  The yat library is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  General Public License for more details.
17
18  You should have received a copy of the GNU General Public License
19  along with this program; if not, write to the Free Software
20  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
21  02111-1307, USA.
22*/
23
24///
25/// @namespace theplu
26///
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///
34
35///
36/// @namespace theplu::yat
37///
38/// All classes and functions are for the yat project is placed in sub
39/// namespaces of the yat namespace.
40///
41/// @brief yat project namespace.
42///
43
44///
45/// @namespace theplu::yat::random
46///
47/// The yat random number related functionality is placed with the
48/// random namespace.
49///
50/// @brief Random number distributions.
51///
52
53///
54/// @namespace theplu::yat::utility
55///
56/// Needed yat functionality that we don't know where to put usually
57/// ends up in the utility namespace until we figure out their proper
58/// namespace location.
59///
60/// @brief Miscellaneous functionality.
61///
62
63///
64/// @namespace theplu::yat::classifier
65///
66/// All classes associated with usage of classifiers are defined
67/// within this namespace.
68///
69/// @brief Classifier related classes.
70///
71
72///
73/// @namespace theplu::yat::statistics
74///
75/// All classes and functions related to statistical methods or
76/// functions are defined within this namespace. See <a
77/// href="Statistics/index.html">Weighted Statistics document</a><br>.
78///
79/// @brief Statistical methods, classes, and functions.
80///
81
82///
83/// @namespace theplu::yat::regression
84///
85/// @brief Statistical modeling of data.
86///
87
Note: See TracBrowser for help on using the repository browser.