EnergyField class Null safety

Class representing the system energy and the domain over which it is defined (the search space).

  • The function energy must be defined for each point belonging to the search space.

Constructors

EnergyField(Energy energy, SearchSpace searchSpace)
Constructs an object of type EnergyField. [...]
EnergyField.of(EnergyField energyField)
factory

Properties

dimension int
Returns the search space dimension.
read-only
energy Energy
Function representing the system energy.
final
hashCode int
The hash code for this object. [...]
read-only, inherited
minPosition List<num>
Returns the field position with the smallest energy encountered.
read-only
minValue num
Returns the smallest energy value encountered.
read-only
position List<num>
Returns the current field position.
read-only
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
size List<num>
Returns the size of the energy field domain (the search space).
read-only
value num
Returns the current value of the energy at location position.
read-only

Methods

next({List<int> grid = const []}) num
Returns the energy at a randomly selected point in the search space. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
perturb(List<num> position, List<num> deltaPosition, {List<int> grid = const []}) num
Returns the energy at a point selected randomly from the region (position - deltaPosition, position + deltaPosition). [...]
sample({int sampleSize = 100, List<int> grid = const []}) Future<List<num>>
Returns a list of energy values sampled from the entire search space.
sampleNeighbourhood(List<num> position, List<num> deltaPosition, {List<int> grid = const [], int sampleSize = 100, bool selectUphillMoves = false}) Future<List<num>>
Returns a list of energy values sampled from a neighbourhood around position using perturbation magnitudes deltaPosition. [...]
tEnd(num gamma, {required List<int> grid, required List<num> deltaPosition, int sampleSize = 200, num kB = 1.0}) Future<num>
Returns the temperature at which the expectation value of the acceptance probability of up-hill transitions approaches gamma. [...]
toString() String
A string representation of this object. [...]
override
tStart(num gamma, {required List<int> grid, required List<num> deltaPosition, int sampleSize = 200, num kB = 1.0}) Future<num>
Returns the temperature at which the expectation value of the acceptance probability of up-hill transitions approaches gamma. [...]

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited