punnets_base.h

a useful spiking neural networks simulator

/** 
 * @file  punnets_base.h
 * @brief Base class of Punnets
 *
 * @author Makino, Takaki <[e-mail]>
 * @date 2003-05-01
 * @version $Id: punnets_base.h,v 1.2 2003/05/08 07:24:56 t Exp $
 *
 * Copyright (C) 2003 Makino, Takaki.  All rights reserved.
 */

#ifndef __punnets_base_h
#define __punnets_base_h

#include "config_punnets.h"

/// \brief This namespace provides commonly available classes.
/// Users should use classes and functions in this namespace via
/// either punnets or punnets_nodebug namespace.

namespace punnets_common {

/////////////////////////////////////////////////////////////////////////
/// Real number type.
///
/// The type that represents a real number.

typedef double real;

/////////////////////////////////////////////////////////////////////////
/// Time representation type.
///
/// The type that represents a simulation time.
typedef double ntime_t;

} // namespace punnets_common

//////////////////////////////////////////////////////////////////////////
/// \brief This namespace provides some private classes used for punnets library.
/// Users should not use classes and functions in this namespace directly.

namespace punnets_private {
using namespace punnets_common;
}

//////////////////////////////////////////////////////////////////////////
/// This namespace provides Punnets library.
/// Importing this namespace, a user can access the classes of Punnets library.
/// Alternatively, if you need efficiency, you may import punnets_nodebug namespace.
/// For most of the available classes, refer to the punnets_common namespace.
///
/// This namespace imports punnets_common so that every definitions in the punnets_common namespace
/// can be transparently used in this namespace.

namespace punnets {
using namespace punnets_common;
}

//////////////////////////////////////////////////////////////////////////
/// This namespace provides Punnets library without debugging facility.
/// Importing this namespace, a user can access an efficient variant of the Punnets library.
/// It is recommended for a user to use ::punnets namespace, at least in the period of development.
/// For most of the available classes, refer to the punnets_common namespace.
///
/// This namespace imports punnets_common so that every definitions in the punnets_common namespace
/// can be transparently used in this namespace.

namespace punnets_nodebug {
using namespace punnets_common;
}

#endif // __punnets_base_h