amazon-braket / amazon-braket-sdk-python

A Python SDK for interacting with quantum devices on Amazon Braket
https://aws.amazon.com/braket/
Apache License 2.0
294 stars 118 forks source link

Create polygon.py #988

Closed AbdullahKazi500 closed 1 month ago

AbdullahKazi500 commented 1 month ago

Issue #, if available: FIXES #969 Description of changes: ArbitraryPolygonCanvas Provides support for canvases defined by arbitrary polygons, allowing more flexibility in defining the spatial constraints for atom arrangements. Methods: init(self, vertices: List[Tuple[float, float]]): Initializes the canvas with a list of vertices defining the polygon. is_within(self, point: Tuple[float, float]) -> bool: Checks if a given point is within the polygon.

Class Methods Update: from_decorated_bravais_lattice: Updated to accept a canvas parameter that can be either a RectangularCanvas or an ArbitraryPolygonCanvas. Functionality: Uses lattice vectors and decoration points to generate atom arrangements within the given canvas. For ArbitraryPolygonCanvas, it utilizes the polygon bounds and is_within method to ensure points are within the arbitrary polygon. from_honeycomb_lattice: Updated to accept a canvas parameter that can be either a RectangularCanvas or an ArbitraryPolygonCanvas. Functionality: Uses specific lattice vectors and decoration points for a honeycomb lattice structure within the given canvas. from_bravais_lattice: Updated to accept a canvas parameter that can be either a RectangularCanvas or an ArbitraryPolygonCanvas. Functionality: Uses provided lattice vectors to generate atom arrangements within the given canvas.

Example Initialization: Provided example usage for both RectangularCanvas and ArbitraryPolygonCanvas with the AtomArrangement class. Demonstrates how to create an AtomArrangement using a honeycomb lattice within an arbitrary polygon canvas. Validation: Prints the number of atoms arranged within the defined canvas to validate functionality. Testing done: no

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

Tests

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

peterkomar-aws commented 1 month ago

Please consolidate the work to this PR: https://github.com/amazon-braket/amazon-braket-sdk-python/pull/989