Modigliani  2.0
A stochastic simulator for axons, neurons, and networks
Classes | Typedefs | Functions
modigliani_base Namespace Reference

Base types, constants and classes for Modigliani. More...

Classes

class  DMatrix
 A straight-forward double matrix class. More...
 
class  Histogram
 Histogram class. More...
 
class  Multidim_array
 Multidimensional array. More...
 
class  Obj
 Master class for all objects. More...
 
class  Sequential_statistics
 Sequential_statistics class. More...
 
class  Timing
 a stopwatch like measurement object. More...
 

Typedefs

typedef std::vector< Size > HistogramBins
 Histogram bins, implemented as a vector.
 

Functions

Real ComputePLogP (Real prob)
 Computes $p\times log(p)$. More...
 
Real Limit01 (Real value)
 Limit a value between [0,1].
 
Real Round (Real value)
 Rounds a value to the nearest integer. More...
 
Real LogGammaFunction (Real arg)
 Compute the logarithm of the Gamma function. More...
 
int IsNAN (const Real value)
 Checks for NaN. More...
 
int IsInf (const Real value)
 Checks infinity. More...
 
std::istream & operator>> (std::istream &is, modigliani_base::DMatrix &m)
 
std::ostream & operator<< (std::ostream &str, const Histogram &self)
 
std::ostream & operator<< (std::ostream &str, const Sequential_statistics &self)
 

Detailed Description

Base types, constants and classes for Modigliani.

Function Documentation

Real modigliani_base::ComputePLogP ( Real  prob)

Computes $p\times log(p)$.

Parameters
probp value
Returns
$p\times log(p)$
int modigliani_base::IsInf ( const Real  value)

Checks infinity.

Parameters
valueThe value to check
Returns
1 for +infinity, -1 for -infinity, 0 otherwise
int modigliani_base::IsNAN ( const Real  value)

Checks for NaN.

Parameters
valueThe value to check
Returns
0 if NaN, rounded value otherwise
Real modigliani_base::LogGammaFunction ( Real  arg)

Compute the logarithm of the Gamma function.

Taken from function 'gammln' Numerical Recipes in C (Press et al.)

Parameters
argFunction argument
Returns
Result
std::ostream& modigliani_base::operator<< ( std::ostream &  str,
const Sequential_statistics &  self 
)
Parameters
strostream to output into
self
Returns
ostream
std::ostream& modigliani_base::operator<< ( std::ostream &  str,
const Histogram &  self 
)
Parameters
strostream to output into
self
Returns
ostream
std::istream& modigliani_base::operator>> ( std::istream &  is,
modigliani_base::DMatrix m 
)
Parameters
isostream to output into
mThe matrix
Returns
ostream
Real modigliani_base::Round ( Real  value)

Rounds a value to the nearest integer.

Parameters
valueValue to round
Returns
Rounded value