implement 2D map and basic operations #3

imrn99 · 2024-02-09T08:49:53Z

implement 2D map and basic operations

Implementation of 2D combinatorial maps.

To-Do before merging:

2-map editing interfaces
first implementation for orbits / i-cells computation
Complete in-code documentation
(optional) Add basic testing: as doc examples

Scope

Code: addition to honeycomb-core

Type of change

New feature(s)

Other

...

Necessary follow-up

Needs documentation: in user guide, mostly
Needs testing
Other: Implement proper I/O and conversion code to mesh structures

Mentions

...

this part of the code is very likely to be refactored when real algorithms will be implemented

cedricchevalier19

I think identifiers should be custom types. It can help to know what kind of indirections are stored.

We can change implementation from simple aliasing to more opaque type.

honeycomb-core/src/cmap/embed.rs

honeycomb-core/src/cmap/map.rs

most methods are done, with the exception of sewing operations as they require clear choices on their behavior (e.g. their influence over geometric space)

imrn99 · 2024-02-09T14:50:44Z

I think identifiers should be custom types. It can help to know what kind of indirections are stored.

We can change implementation from simple aliasing to more opaque type.

I replaced usize with custom ID types & updated methods accordingly in 971cf6a

Side effect: when the custom types are set as usize, many warnings pop up because of now useless type conversions. Overall, this still is better this way since it will help differentiate Dart and DartIdentifier in the long run.

there are two known issue of this implementation detailed in the doc: - beta I is a partial permutation => computed cell might be incomplete - return a vec => highly inefficient

implementation of various methods & verification in those methods require beta0 for efficiency purposes

need to complete the reverse operation in case of inconsistent orientation

- split i-sew/unsew into specialized methods - new getters/setters for i-cells identifiers

cedricchevalier19

Good work but try to keep PR smaller next time!

honeycomb-core/src/twomap.rs

this removes the need for a definition in each method using the macro

for better consistency & more additions to API

set TwoMap.vertices as private as a consequence

imrn99 added 6 commits February 8, 2024 11:18

chore: create cmap module & template files

04154f3

feat: dart structure & useful trait/method impl

7bba33b

doc: complete missing part for the Dart impl block

12dba7d

feat: basic embedding structures

067ef98

this part of the code is very likely to be refactored when real algorithms will be implemented

feat: 2D map structure & basic reading interfaces

7ab44ea

fix: missing import in doc example

04754b8

cedricchevalier19 reviewed Feb 9, 2024

View reviewed changes

honeycomb-core/src/cmap/embed.rs Outdated Show resolved Hide resolved

honeycomb-core/src/cmap/map.rs Outdated Show resolved Hide resolved

imrn99 added 5 commits February 9, 2024 11:44

feat: implement more methods

25b7454

most methods are done, with the exception of sewing operations as they require clear choices on their behavior (e.g. their influence over geometric space)

doc: complete missing doc in impl TwoMap block

630ec9a

feat: add cell-specific identifier types

dd9a75a

refactor: replace usize in structs by custom ID types

971cf6a

fix: update doc example to fit new ID types

c749d2c

imrn99 added 17 commits February 9, 2024 16:17

doc: update method documentation to match new sig

06a8738

feat: add I-cell computation in 2-map

26fa286

there are two known issue of this implementation detailed in the doc: - beta I is a partial permutation => computed cell might be incomplete - return a vec => highly inefficient

feat: add topological operations to i-sew implementation

e42b95b

feat: add geometrical ops for 1-sew/unsew

607a200

doc: add module level & TwoMap doc

7630799

feat: add beta0 encoding to the TwoMap structure

b8498ec

implementation of various methods & verification in those methods require beta0 for efficiency purposes

doc: improve map module doc

44123ce

feat: implement new structure to handle darts & associated data

7899fc9

refactor: introduce DartData structure to TwoMap

111022c

feat: add face support

09fffa8

fix: correct i-cell computation with beta0 usage

8ebaff6

fix: complete 1-sew geometrical operations

805b466

fix: remove deadcode & change CellIdentifiers type

3159a21

feat: add 2-sew geometrical operations

1e332a4

need to complete the reverse operation in case of inconsistent orientation

refactor: improve various TwoMap methods/API

3690c27

- split i-sew/unsew into specialized methods - new getters/setters for i-cells identifiers

feat: add geometrical operations for 2-unsew

d69c2f9

doc: update map module

77d7aa5

imrn99 added 11 commits February 15, 2024 15:40

chore: update re-exports & remove dead-code ref in doc example

7ef8280

doc: update dart module documentation

4ef564d

doc: update embed module documentation

c1a52e4

refactor: flatten module structure

1b4b77f

refactor: rename TwoMap methods to fit Rust API Guidelines

d9277ea

feat: add face_id support directly to the build_face method

62bd694

refactor: make vertices attribute public & change TwoMap constructor

e4c9b2a

doc: add illustration for the main TwoMap example

1de4252

doc: add map creation section of the TwoMap example

9e49bbc

doc: complete TwoMap example up to step (c)

997fd35

doc: finish TwoMap example

93c0c5f

imrn99 requested a review from cedricchevalier19 February 16, 2024 13:27

cedricchevalier19 approved these changes Feb 16, 2024

View reviewed changes

honeycomb-core/src/twomap.rs Outdated Show resolved Hide resolved

honeycomb-core/src/twomap.rs Outdated Show resolved Hide resolved

honeycomb-core/src/twomap.rs Outdated Show resolved Hide resolved

imrn99 added 8 commits February 18, 2024 16:31

refactor: change stretch macro to allow in-module definition

5c131c4

this removes the need for a definition in each method using the macro

doc: remove useless lines about removed generic argument

6438356

refactor: rename getter methods of vertex/face id

e5a33cb

for better consistency & more additions to API

refactor: rename set_vertx/face methods for consistency

11b3d5e

feat: add getter for Vertex2 & Face of the map

ba35f3f

refactor: add API for vertex manipulation

41be619

set TwoMap.vertices as private as a consequence

doc: update documentation of new methods

e4fc325

doc: update TwoMap example to use new methods

f0cd8ec

imrn99 merged commit 619a7e2 into master Feb 19, 2024
1 check passed

imrn99 deleted the 2-map branch February 19, 2024 07:25

imrn99 mentioned this pull request Feb 19, 2024

update user guide #5

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

implement 2D map and basic operations #3

implement 2D map and basic operations #3

imrn99 commented Feb 9, 2024 •

edited

Loading

cedricchevalier19 left a comment

imrn99 commented Feb 9, 2024

cedricchevalier19 left a comment

implement 2D map and basic operations #3

implement 2D map and basic operations #3

Conversation

imrn99 commented Feb 9, 2024 • edited Loading

implement 2D map and basic operations

Scope

Type of change

Other

Necessary follow-up

Mentions

cedricchevalier19 left a comment

Choose a reason for hiding this comment

imrn99 commented Feb 9, 2024

cedricchevalier19 left a comment

Choose a reason for hiding this comment

imrn99 commented Feb 9, 2024 •

edited

Loading