Package csb :: Package statistics :: Package samplers :: Package mc :: Class MDRENSSwapParameterInfo
[frames] | no frames]

Class MDRENSSwapParameterInfo

source code

               object --+        
                        |        
AbstractSwapParameterInfo --+    
                            |    
          RESwapParameterInfo --+
                                |
                               MDRENSSwapParameterInfo
Known Subclasses:

Holds parameters for a MDRENS swap.

Nested Classes

Inherited from AbstractSwapParameterInfo: __metaclass__

Instance Methods
 
__init__(self, sampler1, sampler2, timestep, traj_length, gradient, mass_matrix=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code

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

Class Variables

Inherited from AbstractSwapParameterInfo: __abstractmethods__

Properties
  gradient
Gradient which governs the equations of motion.
  mass_matrix
  timestep
Integration timestep.
  traj_length
Trajectory length in number of integration steps.

Inherited from AbstractSwapParameterInfo: sampler1, sampler2

Inherited from object: __class__

Method Details

__init__(self, sampler1, sampler2, timestep, traj_length, gradient, mass_matrix=None)
(Constructor)

source code 

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

Parameters:
  • sampler1 (AbstractSingleChainMC) - First sampler
  • sampler2 (AbstractSingleChainMC) - Second sampler
  • timestep (float) - Integration timestep
  • mass_matrix (n-dimensional matrix of type InvertibleMatrix with n being the dimension of the configuration space, that is, the dimension of the position / momentum vectors) - Mass matrix
  • traj_length (int) - Trajectory length in number of timesteps
  • gradient (AbstractGradient) - Gradient which determines the dynamics during a trajectory
Overrides: object.__init__
(inherited documentation)

Property Details

gradient

Gradient which governs the equations of motion.

Get Method:
unreachable.gradient(self) - Gradient which governs the equations of motion.

mass_matrix

Get Method:
unreachable.mass_matrix(self)
Set Method:
unreachable.mass_matrix(self, value)

timestep

Integration timestep.

Get Method:
unreachable.timestep(self) - Integration timestep.
Set Method:
unreachable.timestep(self, value)

traj_length

Trajectory length in number of integration steps.

Get Method:
unreachable.traj_length(self) - Trajectory length in number of integration steps.
Set Method:
unreachable.traj_length(self, value)