source: trunk/doc/namespaces.doxygen @ 1797

// $Id: namespaces.doxygen 1797 2009-02-12 18:07:10Z peter $

/*
  Copyright (C) 2005 Jari Häkkinen, Peter Johansson, Markus Ringnér
  Copyright (C) 2006, 2007, 2008 Jari Häkkinen, Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 3 of the
  License, or (at your option) any later version.

  The yat library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with yat. If not, see <http://www.gnu.org/licenses/>.
*/

/// 
/// @namespace theplu
///
/// All C++ projects at the Department of Theoretical Physics should
/// ideally be defined within a common namespace. We use theplu for
/// this common namespace.
///
/// @brief The Department of Theoretical Physics namespace as we
/// define it.
///

/// 
/// @namespace theplu::yat
///
/// All classes and functions are for the yat project is placed in sub
/// namespaces of the yat namespace.
///
/// @brief yat project namespace.
///

///
/// @namespace theplu::yat::random
///
/// The yat random number related functionality is placed with the
/// random namespace.
///
/// @brief Random number distributions.
///

/// 
/// @namespace theplu::yat::classifier
///
/// All classes associated with usage of classifiers are defined
/// within this namespace.
/// 
/// @brief Classifier related classes.
///

///
/// @namespace theplu::yat::normalizer 
///
/// @brief Normalization of data
///

///
/// @namespace theplu::yat::regression 
///
/// @brief Statistical modeling of data.
///

///
/// @namespace theplu::yat::statistics
///
/// All classes and functions related to statistical methods or
/// functions are defined within this namespace. See 
/// \ref weighted_statistics<br>.
///
/// @brief Statistical methods, classes, and functions.
///

///
/// @namespace theplu::yat::utility
///
/// Needed yat functionality that we don't know where to put usually
/// ends up in the utility namespace until we figure out their proper
/// namespace location.
///
/// @brief Miscellaneous functionality.
///