source: trunk/doc/namespaces.doxygen @ 763

Last change on this file since 763 was 691, checked in by Peter, 15 years ago

added description on microarray namespace

  • 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 691 2006-10-17 12:12:20Z peter $
2
[675]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
[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///
[691]45/// @namespace theplu::yat::microarray
46///
47/// All classes associated with microarray analysis are defined
48/// within this namespace.
49///
50/// @brief microarray related classes.
51///
52
53///
[680]54/// @namespace theplu::yat::random
[304]55///
[680]56/// The yat random number related functionality is placed with the
57/// random namespace.
[304]58///
[680]59/// @brief Random number distributions.
60///
[304]61
62///
[680]63/// @namespace theplu::yat::utility
[304]64///
[680]65/// Needed yat functionality that we don't know where to put usually
66/// ends up in the utility namespace until we figure out their proper
67/// namespace location.
[304]68///
[680]69/// @brief Miscellaneous functionality.
70///
[304]71
72///
[680]73/// @namespace theplu::yat::classifier
74///
75/// All classes associated with usage of classifiers are defined
76/// within this namespace.
[304]77///
[680]78/// @brief Classifier related classes.
[304]79///
80
81///
[680]82/// @namespace theplu::yat::statistics
[304]83///
[680]84/// All classes and functions related to statistical methods or
85/// functions are defined within this namespace. See <a
86/// href="Statistics/index.html">Weighted Statistics document</a><br>.
87///
88/// @brief Statistical methods, classes, and functions.
89///
[304]90
[387]91///
[680]92/// @namespace theplu::yat::regression
[387]93///
[680]94/// @brief Statistical modeling of data.
95///
[304]96
Note: See TracBrowser for help on using the repository browser.