Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielVandH authored Jul 19, 2024
1 parent e77c565 commit 6a01673
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The package provides four predicates. In the functions below, all the inputs sho
- `orient2(pa, pb, pc)`: Given three points `pa`, `pb`, and `pc` in two dimensions, returns a positive value if the points are in counter-clockwise order; a negative value if they occur in clockwise order; and zero if they are collinear. Equivalently, returns a positive value if `pc` is left of the oriented line from `pa` to `pb`; a negative value if `pc` is right of this line; and zero if they are collinear.
- `orient3(pa, pb, pc, pd)`: Given four points `pa`, `pb`, `pc`, and `pd` in three dimensions, define the oriented plane on which the triangle `(pa, pb, pc)` is positively oriented. Returns a positive value if `pd` is below this plane; a negative value if `pd` is above this plane; and zero if the points are coplanar.
- `incircle(pa, pb, pc, pd)`: Given four points `pa`, `pb`, `pc`, and `pd` in two dimensions, returns a positive value if `pd` is inside the circle through `pa`, `pb`, and `pc`; a negative value if `pd` is outside this circle; and zero if `pd` is on the circle.
- `insphere(pa, pb, pc, pd, pe)`: Given five points `pa`, `pb`, `pc`, `pd`, and `pe` in three dimensions, returns a positive value if `pe` inside on the sphere through `pa`, `pb`, `pc`, and `pd`; a negative value if `pe` is outside this sphere; and zero if `pe` is on the sphere.
- `insphere(pa, pb, pc, pd, pe)`: Given five points `pa`, `pb`, `pc`, `pd`, and `pe` in three dimensions, returns a positive value if `pe` inside of the sphere through `pa`, `pb`, `pc`, and `pd`; a negative value if `pe` is outside this sphere; and zero if `pe` is on the sphere.

We also define the functions `orient2p`, `orient3p`, `incirclep`, and `inspherep` which simply return the sign of the corresponding predicate. For example,
```julia-repl
Expand Down

2 comments on commit 6a01673

@DanielVandH
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/111359

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.0.0 -m "<description of version>" 6a016734cff917433faea482d9622a0500a3052f
git push origin v1.0.0

Please sign in to comment.