BaseSurface

Surface base class which can be subclassed for relevant cases

 

__init__(self, data, dimension): 

LLM Docstring

Store the core surface data and its dimension.

  • data: Any

    the surface’s backing data (interpreted by the subclass)

  • dimension: int | None

    the dimensionality of the surface’s input space

 

evaluate(self, points, **kwargs): 

Evaluates the function at the points based off of “data”

  • points: Any
  • :returns: _

 

check_dimension(self, gridpoints, target=None, raise_exception=True): 

LLM Docstring

Check that a set of grid points matches the surface’s expected dimension, optionally raising on a mismatch.

  • gridpoints: np.ndarray

    the points to check

  • target: int | None

    the expected dimension (defaults to the surface’s)

  • raise_exception: bool

    raise (rather than return False) on a mismatch

  • :returns: bool

    whether the dimension matches

 

__call__(self, gridpoints, **kwargs): 
  • gridpoints: np.ndarray
  • kwargs: Any
  • :returns: _

Feedback

Examples

Templates

Documentation