Skip to content

add register class methods #403

Description

@sgrava

Add class methods to Register to create special registers:

Description

Register.circle, Register.rectangular and Register.triangular are the simplest primitives to start.
All methods:

  • should accept a spacing (or a better name) kwarg that sets the minimum pairwise distance (Default to 1.0).
  • return coordinates, centered around the origin (0,0).

Naming

Methods that tile a repeating unit cell (rectangular, triangular, hexagonal, heavy_hexagonal) use the adjectival form, matching the equivalent DataGraph methods. Methods that describe the register's overall outline (circle, line, square) keep the noun form.

Context

These methods should cover already available methods in DataGraph, but specialized here to just return a register with coordinates.
Next step will be to remove positions stored in those graph methods, achieving pure graph output.
Users that were using such methods just for positions will need to be informed about this change.

Acceptance criteria

all methods should

  • test simple layout with explicit coords
  • test minimum distance is given by spacing

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    coreFor core development related to infrastructure or architecture of the library.

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions