feat: inline comparison operators #1257

liangyiliang · 2023-01-23T20:23:51Z

Description

Resolves #1168 .

We added the support for inline comparison operators. In particular,

a > b is the syntax sugar for greaterThan(a, b)
a == b is the syntax sugar for equal(a, b)
a < b is the syntax sugar for lessThan(a, b)

This applies to both constraints and objectives.

Implementation strategy and design decisions

We modified the parser so that constraints and objective declarations now look like

<constr> ::= ensure <body> <staged layout>+
   <obj> ::= encourage <body> <staged layout>+

  <body> ::= <identifier> ( <expr_list> )  // Function Call
           | <expr> <op> <expr>            // Inline Comparison

    <op> ::= ==     // Equal
           | <      // Less Than
           | >      // Greater Than

In other words, the of a constraint or objective now can either be a Function Call or an Inline Comparison.

In the Style compiler where we handle constraints and objectives, we proceed as before when we encounter a Function Call. When we encounter an Inline Comparison, on the other hand, we handle it as if it is a Function Call, with the corresponding function name (lessThan, greaterThan, or equal) and the two operands as parameters to the function.

Tests have been added to the parser and compiler.

The docs site has been updated to include this syntactic sugar. Furthermore, we modified the tree-venn and tree-tree example to utilize this syntactic sugar.

Examples with steps to reproduce them

See examples tree-venn and tree-tree with applications of this syntactic sugar.

Checklist

I have commented my code, particularly in hard-to-understand areas
My changes generate no new ESLint warnings
I have reviewed any generated registry diagram changes

github-actions · 2023-01-23T20:27:15Z

± Registry diff

📊 Performance

Key

Note that each bar component rounds up to the nearest 100ms, so each full bar is an overestimate by up to 400ms.

     0s   1s   2s   3s   4s   5s   6s   7s   8s   9s
     |    |    |    |    |    |    |    |    |    |
name ▝▀▀▀▀▀▀▀▀▀▀▀▚▄▄▄▄▄▄▄▄▄▞▀▀▀▀▀▀▀▀▀▀▀▀▚▄▄▄▄▄▄▄▄▄▖
      compilation labelling optimization rendering

Data

                                        0s   1s   2s   3s   4s   5s   6s   7s   8s
                                        |    |    |    |    |    |    |    |    |
3d-projection-fake-3d-linear-algebra    ▝▞▖
allShapes-allShapes                     ▝▚▚▄▖
arrowheads-arrowheads                   ▝▚▚
caffeine-structural-formula             ▝▀▀▀▚▀▖
center-shrink-circle-animation          ▝▞▖
circle-example-euclidean                ▝▀▚▀▀▀▖
collinear-euclidean                     ▝▀▞▖
congruent-triangles-euclidean           ▝▀▀▚▚
continuousmap-continuousmap             ▝▚▚
cubic-bezier-cubic-bezier               ▝▚▀▀▚
glutamine-molecules-basic               ▝▀▚▚
half-adder-distinctive-shape            ▝▀▞▚
hypergraph-hypergraph                   ▝▀▀▀▞▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▚
incenter-triangle-euclidean             ▝▀▀▞▖
lagrange-bases-lagrange-bases           ▝▚▚
midsegment-triangles-euclidean          ▝▀▞▖
mobius-mobius                           ▝▞▖
non-convex-non-convex                   ▝▀▞▖
one-water-molecule-atoms-and-bonds      ▝▞▖
parallel-lines-euclidean                ▝▀▞▖
persistent-homology-persistent-homology ▝▀▀▚▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▄
points-around-line-shape-distance       ▝▀▚▚
points-around-polyline-shape-distance   ▝▀▀▞▖
points-around-star-shape-distance       ▝▀▀▀▚▚
siggraph-teaser-euclidean-teaser        ▝▀▚▚
small-graph-disjoint-rect-line-horiz    ▝▀▀▞▖
small-graph-disjoint-rects              ▝▚▚
small-graph-disjoint-rects-large-canvas ▝▞▖
small-graph-disjoint-rects-small-canvas ▝▚▚
tree-tree                               ▝▀▄▚
tree-venn                               ▝▀▚▚
tree-venn-3d                            ▝▀▞▄▖
two-vectors-perp-vectors-dashed         ▝▚▚
vector-wedge-exterior-algebra           ▝▞▖
wet-floor-atoms-and-bonds               ▝▀▚▀▀▖
word-cloud-example-word-cloud           ▝▀▚▚
wos-laplace-estimator-walk-on-spheres   ▝▀▀▞▖
wos-nested-estimator-walk-on-spheres    ▝▀▀▚▀▀▀▀▀▀▀▀▖
wos-offcenter-estimator-walk-on-spheres ▝▀▚▀▀▀▀▖
wos-poisson-estimator-walk-on-spheres   ▝▀▚▀▀▖

cloudflare-pages · 2023-01-23T20:29:22Z

Deploying with Cloudflare Pages

Latest commit:	`49781b2`
Status:	✅ Deploy successful!
Preview URL:	https://761ec6e1.penrose-72l.pages.dev
Branch Preview URL:	https://inline-constraint.penrose-72l.pages.dev

View logs

codecov · 2023-01-24T17:11:47Z

Codecov Report

Merging #1257 (49781b2) into main (e1944ab) will decrease coverage by 0.02%.
The diff coverage is 65.00%.

@@            Coverage Diff             @@
##             main    #1257      +/-   ##
==========================================
- Coverage   63.44%   63.43%   -0.02%     
==========================================
  Files          61       61              
  Lines        7176     7212      +36     
  Branches     1667     1680      +13     
==========================================
+ Hits         4553     4575      +22     
- Misses       2540     2553      +13     
- Partials       83       84       +1

Impacted Files	Coverage Δ
packages/core/src/utils/Util.ts	`48.57% <0.00%> (-1.28%)`	⬇️
packages/core/src/compiler/Style.ts	`68.51% <100.00%> (+0.51%)`	⬆️
packages/core/src/index.ts	`43.54% <0.00%> (-1.83%)`	⬇️
packages/core/src/contrib/Constraints.ts	`82.88% <0.00%> (ø)`

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

wodeni

Looks good! This will actually improve the editing experience for Style dramatically for me (and I'm sure many others!). Just had a minor comment about parser tests below. Also I'll try and push some refactoring on the geometry domain

packages/core/src/parser/StyleParser.test.ts

wodeni · 2023-01-25T00:04:12Z

Refactored all lessThan and equal in euclidean.sty to use the new inline operators! Local tests seemed to work very well. ~~Some variations might need tweaks for gallery, which I'll do after CI reports the diffs.~~

wodeni · 2023-01-25T01:24:21Z

BTW it'd be good to open issues about (1) chaining and (2) other logical operators (eg ||, >= etc). This PR technically doesn't resolve all the things in #1168, but I somewhat prefer closing issues sooner and open more specific followups for the health of the repo.

Co-authored-by: Wode "Nimo" Ni <wn2155@columbia.edu>

samestep · 2023-01-25T16:29:24Z

Looks super cool, thanks! Looking at the code now... quick question though, why does the tree-venn example change?

liangyiliang · 2023-01-25T16:32:27Z

why does the tree-venn example change?

We changed smallerThan(x.icon, y.icon) with x.icon.r < y.icon.r, equivalent to lessThan(x.icon.r, y.icon.r).

smallerThan has a default nonzero padding of 0.4. lessThan's default padding is 0.

packages/core/src/__tests__/overall.test.ts

packages/core/src/compiler/Style.ts

samestep · 2023-01-25T16:34:50Z

We changed smallerThan(x.icon, y.icon) with x.icon.r < y.icon.r, equivalent to lessThan(x.icon.r, y.icon.r).

smallerThan has a default nonzero padding of 0.4. lessThan's default padding is 0.

Gotcha; but why does that change the colors?

samestep · 2023-01-25T16:35:48Z

I guess the reason I'm asking is that I feel like the colors in the variation as of this PR don't look great; if that example does have to change, could you modify the variation to get nicer colors?

liangyiliang · 2023-01-25T16:39:30Z

Gotcha; but why does that change the colors?

I think the overall energy function changed, which means a different optimization ...

But in reality now that I think about it, I shouldn't really touch smallerThan - since I think the idea of having a padding makes sense ... I will revert the change to tree-venn

samestep

Great, thanks Leo!

joshsunshine

Looks great!

Added failing test cases

4875626

liangyiliang changed the title ~~Added failing test cases~~ feat: inline comparison operators Jan 23, 2023

liangyiliang added 2 commits January 23, 2023 17:44

Parser does not work

d07784f

Fixed parser

72abf09

liangyiliang added 7 commits January 24, 2023 12:22

Fixed bad operator handling in parser

7355187

Refractor

50465ab

Added test

8aa277f

docs

24f6e10

Modified example

08dc886

Fixed example

f9a43e2

Incorporated changes to README

3d3df16

liangyiliang marked this pull request as ready for review January 24, 2023 22:02

liangyiliang requested review from samestep, wodeni and joshsunshine January 24, 2023 22:02

wodeni approved these changes Jan 24, 2023

View reviewed changes

packages/core/src/parser/StyleParser.test.ts Show resolved Hide resolved

refactor: euclidean sty program to use inline ops

3d7fa8c

Update packages/core/src/parser/StyleParser.test.ts

9a01224

Co-authored-by: Wode "Nimo" Ni <wn2155@columbia.edu>

samestep approved these changes Jan 25, 2023

View reviewed changes

packages/core/src/__tests__/overall.test.ts Outdated Show resolved Hide resolved

packages/core/src/compiler/Style.ts Outdated Show resolved Hide resolved

packages/core/src/compiler/Style.ts Show resolved Hide resolved

Reverted README diagram

ad44c74

liangyiliang added 2 commits January 25, 2023 11:45

Reverted faulty test

b96f0df

Refactor

49781b2

samestep approved these changes Jan 25, 2023

View reviewed changes

joshsunshine approved these changes Jan 25, 2023

View reviewed changes

liangyiliang merged commit b3c7c2f into main Jan 25, 2023

liangyiliang deleted the inline-constraint branch February 24, 2023 21:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: inline comparison operators #1257

feat: inline comparison operators #1257

liangyiliang commented Jan 23, 2023 •

edited

github-actions bot commented Jan 23, 2023 •

edited

cloudflare-pages bot commented Jan 23, 2023 •

edited

codecov bot commented Jan 24, 2023 •

edited

wodeni left a comment

wodeni commented Jan 25, 2023 •

edited

wodeni commented Jan 25, 2023

samestep commented Jan 25, 2023

liangyiliang commented Jan 25, 2023 •

edited

samestep commented Jan 25, 2023

samestep commented Jan 25, 2023

liangyiliang commented Jan 25, 2023

samestep left a comment

joshsunshine left a comment

feat: inline comparison operators #1257

feat: inline comparison operators #1257

Conversation

liangyiliang commented Jan 23, 2023 • edited

Description

Implementation strategy and design decisions

Examples with steps to reproduce them

Checklist

github-actions bot commented Jan 23, 2023 • edited

± Registry diff

📊 Performance

Key

Data

cloudflare-pages bot commented Jan 23, 2023 • edited

Deploying with Cloudflare Pages

codecov bot commented Jan 24, 2023 • edited

Codecov Report

wodeni left a comment

Choose a reason for hiding this comment

wodeni commented Jan 25, 2023 • edited

wodeni commented Jan 25, 2023

samestep commented Jan 25, 2023

liangyiliang commented Jan 25, 2023 • edited

samestep commented Jan 25, 2023

samestep commented Jan 25, 2023

liangyiliang commented Jan 25, 2023

samestep left a comment

Choose a reason for hiding this comment

joshsunshine left a comment

Choose a reason for hiding this comment

liangyiliang commented Jan 23, 2023 •

edited

github-actions bot commented Jan 23, 2023 •

edited

cloudflare-pages bot commented Jan 23, 2023 •

edited

codecov bot commented Jan 24, 2023 •

edited

wodeni commented Jan 25, 2023 •

edited

liangyiliang commented Jan 25, 2023 •

edited