RastriginFunction#
- class RastriginFunction(n_dim: int = 2, A: float = 10, angle: float = 6.283185307179586, objective: str = 'minimize', modifiers: List[BaseModifier] | None = None, memory: bool = False, collect_data: bool = True, callbacks: Callable | List[Callable] | None = None, catch_errors: Dict[type, float] | None = None)[source]#
Rastrigin N-dimensional test function.
A highly multimodal function with many local minima arranged in a regular lattice pattern. It is commonly used to test the ability of optimization algorithms to escape local optima.
The function is defined as:
\[f(\vec{x}) = An + \sum_{i=1}^{n} [x_i^2 - A\cos(\omega x_i)]\]where \(A = 10\) and \(\omega = 2\pi\) by default.
The global minimum is \(f(\vec{0}) = 0\).
- Parameters:
n_dim (int) – Number of dimensions.
A (float, default=10) – Amplitude of the cosine modulation.
angle (float, default=2*pi) – Angular frequency parameter.
metric (str, default="score") – Either “loss” (minimize) or “score” (maximize).
modifiers (list of BaseModifier, optional) – List of modifiers to apply to function evaluations.
Examples
>>> from surfaces.test_functions import RastriginFunction >>> func = RastriginFunction(n_dim=2) >>> result = func({"x0": 0.0, "x1": 0.0}) >>> abs(result) < 1e-10 True
- __call__(params: Dict[str, Any] | ndarray | list | tuple | None = None, **kwargs)[source]#
Evaluate the objective function.
- Args:
params: Parameter values as dict, array, list, or tuple **kwargs: Parameters as keyword arguments (only with dict input)
- Returns:
The objective function value
- batch(X: ArrayLike) ArrayLike[source]#
Evaluate multiple parameter sets in a single call.
- Parameters:
X (ArrayLike) – 2D array of shape (n_points, n_dim) where each row is a parameter set.
- Returns:
1D array of shape (n_points,) with evaluation results.
- Return type:
ArrayLike
- Raises:
NotImplementedError – If the function does not implement _batch_objective.
ValueError – If X has wrong number of dimensions or wrong n_dim.
- pure(params: Dict[str, Any] | ndarray | list | tuple | None = None, **kwargs)[source]#
Evaluate the function without modifiers.
Returns the true (deterministic) function value, bypassing any configured modifiers. Does not update search_data, n_evaluations, or callbacks. Ignores memory caching.