SearchSpace class - simulated_annealing library

Constructors

SearchSpace.fixed(List<FixedInterval> intervals, {String name = ''}): Constructs an object of type SearchSpace.
SearchSpace.parametric(List<Interval> intervals, {List<int> order = const <int>[], String name = ''})

Properties

dimensions → int: The number of intervals that were used to define the SearchSpace.
final
hasCustomOrder → bool: Returns true if order does not compare equal to normalOrder.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
intervalNames → UnmodifiableListView<String>: Return the interval names.
latefinal
levels ↔ List<int>: Returns a list of integers containing the number of grid points for each interval.
getter/setter pair
name → String: The search space name.
final
normalOrder → UnmodifiableListView<int>: Normal order.
latefinal
order → List<int>: Order in which intervals are evaluated in the methods next and perturb.
latefinal
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
size → UnmodifiableListView<num>: Returns a list containing the interval size along each space dimension.
latefinal

Methods

contains(List<num> position) → bool: Returns true if the point position belongs to the search space this.
next() → List<num>: Returns a random vector of length dimension. Each vector coordinate is generated by drawing a sample from the corresponding interval.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
perturb(List<num> position, List<num> deltaPosition) → List<num>: Returns a random vector of length dimensions sampled from the interval obtained by intersecting this with the generalized rectangle centred at position with edge lengths (position - deltaPosition, position + deltaPosition).
sample({int sampleSize = 2000}) → List<List<num>>: Returns a list containing sampleSize points randomly sampled from the entire search space.
sampleCloseTo(List<num> position, List<num> deltaPosition, {int sampleSize = 600}) → List<List<num>>: Returns a list containing sampleSize points randomly sampled from the vicinity of position.
toString() → String: A string representation of this object.
override
validOrder() → List<int>: Validates the parameter order before it is used for the first time.

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

box({num xMin = 0, num xMax = 1, num yMin = 0, num yMax = 1, num zMin = 0, num zMax = 1}) → SearchSpace: Returns a search space with a box geometry.
cone({num rhoMin = 0, num rhoMax = 2, num phiMin = 0, num phiMax = 2 * pi, num zMin = 0, num zMax = 2}) → SearchSpace
cylinder({num rhoMin = 0, num rhoMax = 1, num phiMin = 0, num phiMax = 2 * pi, num zMin = 0, num zMax = 1}) → SearchSpace: Returns a search space with cylindrical geometry.
cylinderCartesian({num rho = 1, num zMin = 0, num zMax = 1, List<num> centre = const <double>[0.0, 0.0, 0, 0]}) → SearchSpace: Returns a three dimensional SearchSpace with a cylindrical geometry defined in terms of Cartesian coordiantes [x, y, z].
disk({num rhoMin = 0, num rhoMax = 1, num phiMin = 0, num phiMax = 2 * pi}) → SearchSpace: Returns a two dimensional search space with disk geometry.
diskCartesian(num radius) → SearchSpace: Returns a two dimensional SearchSpace with a disk geometry defined in terms of Cartesion coordinates [x, y].
rectangle({num xMin = 0, num xMax = 2, num yMin = 0, num yMax = 1}) → SearchSpace: Returns a search space with rectangular geometry.
sphere({num rMin = 0, num rMax = 1, num thetaMin = 0, num thetaMax = pi, num phiMin = 0, num phiMax = 2 * pi}) → SearchSpace: Returns a three-dimensional search space with spherical geometry.
sphereCartesian({num radius = 1.0, List<num> centre = const <double>[0.0, 0.0, 0, 0]}) → SearchSpace: Returns a three-dimensional search space with spherical geometry.
triangle({num xMin = 0, num xMax = 10, num yMin = -150, num yMax = 150}) → SearchSpace: Returns a two-dimensional search space with triangular geometry.