Package csb :: Package statmech :: Module ensembles :: Class FermiEnsemble

Class FermiEnsemble

         object --+        
                  |        
StatisticalEnsemble --+    
                      |    
      BoltzmannEnsemble --+
                          |
                         FermiEnsemble

Nested Classes
Inherited from `StatisticalEnsemble`: `__metaclass__`

Instance Methods

__init__(self, beta=1.0, e_max=0.0)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

energy(self, raw_energies)
Transforms the raw energies as if they were observed in this statistical ensemble

source code

Inherited from StatisticalEnsemble: __call__, gradient, log_prob

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables
Inherited from `BoltzmannEnsemble`: `__abstractmethods__`

Properties

e_max
Maximum energy

Inherited from BoltzmannEnsemble: beta

Inherited from object: __class__

Method Details

init(self, beta=1.0, e_max=0.0)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

energy(self, raw_energies)

source code

Transforms the raw energies as if they were observed in this statistical ensemble

Overrides: StatisticalEnsemble.energy: (inherited documentation)

Property Details

e_max

Maximum energy

Get Method:: unreachable.e_max(self) - Maximum energy
Set Method:: unreachable.e_max(self, value)

Class FermiEnsemble

__init__(self, beta=1.0, e_max=0.0) (Constructor)

energy(self, raw_energies)

e_max

init(self, beta=1.0, e_max=0.0)
(Constructor)