# builders.domain.renderability

Domain specification

Domain

Only show finetuned characteristics Simplify signatures

# Renderable

A domain must inherit this class if it can be rendered with any kind of visualization.

# render Renderable

render(
  self,
  memory: Optional[Memory[D.T_state]] = None,
  **kwargs: Any
) -> Any

Compute a visual render of the given memory (state or history), or the internal one if omitted.

By default, Renderable.render() provides some boilerplate code and internally calls Renderable._render_from(). The boilerplate code automatically passes the _memory attribute instead of the memory parameter whenever the latter is None. It also autocasts itself to be used at the proper characteristics level by each solver.

# Parameters

memory: The memory to consider (if None, the internal memory attribute _memory is used instead).

# Returns

A render (e.g. image) or nothing (if the function handles the display directly).

# _render_from Renderable

_render_from(
  self,
  memory: Memory[D.T_state],
  **kwargs: Any
) -> Any

Compute a visual render of the given memory (state or history).

This is a helper function called by default from Renderable._render(), the difference being that the memory parameter is mandatory here.

# Parameters

memory: The memory to consider.

# Returns

A render (e.g. image) or nothing (if the function handles the display directly).