interaction toy.couple#

Describes the entry toy.couple at version 0.1.0, registered by mime.testing.toys._entries.ToyCouple.

At a glance#

  • interaction toy.couple, version 0.1.0, namespace toy

  • Derivative: exact

  • Validity: none declared

What it models, and when not to use it#

No hand-written part: this entry’s source has not been written (the docs walk counts it).

Settings#

Setting

Type

Default

Dimension

Role

Default’s kind

max_iterations

int

50

none

none declared

none: required

solve_together

bool

false

none

none declared

none: required

tolerance

float

1e-12

none

none declared

none: required

Each role and default’s kind is the entry’s setting_roles (mime.registry.SettingRole); a setting that declares none is required.

Roles, reads and deliveries#

Roles, bound by keyword when the entry is attached: body (body), medium (medium).

Reads, values and deliveries that its plan adds for a particular construction are not in these tables: they list what the class declares, and plan is code the build runs when the entry is attached.

Nodes it builds#

Builds no node of its own.

Gradient status#

The derivative through this entry is exact, the derivative of what it computes.

Validity#

none declared

References#

none declared

Other declarations#

Class variable

Type

Value

holds_off

ClassVar[str | None]

null

id_roles

ClassVar[tuple[str, ...] | None]

null

moving

ClassVar[bool]

false