Skip to content

added missing ticks in docstring #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dpsanders merged 3 commits into from
Mar 4, 2021
Merged

added missing ticks in docstring #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d738893
added missing ticks in docstring
lucaferranti Feb 23, 2021
fa40726
added link to webpage in readme (fixes #151)
lucaferranti Mar 4, 2021
8f6f279
fix docstring for constraint-macro (fixes #154)
lucaferranti Mar 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# IntervalConstraintProgramming.jl

[![Build Status](https://travis-ci.org/JuliaIntervals/IntervalConstraintProgramming.jl.svg?branch=master)](https://travis-ci.org/dpsanders/IntervalConstraintProgramming.jl)
[![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaintervals.github.io/pages/packages/intervalconstraintprogramming/)

This Julia package allows us to specify a set of constraints on real-valued variables,
given by inequalities, and
Expand All @@ -12,9 +13,9 @@ The package is based on interval arithmetic using the
in particular multi-dimensional `IntervalBox`es (i.e. Cartesian products of one-dimensional intervals).

## Documentation
Documentation for the package is available [here](http://juliaintervals.github.io/IntervalConstraintProgramming.jl/latest/).
Documentation for the package is available [here](https://juliaintervals.github.io/pages/packages/intervalconstraintprogramming/).

The best way to learn how to use the package is to look at the example notebooks, available in a separate repository [here](https://github.com/JuliaIntervals/IntervalConstraintProgrammingNotebooks).
The best way to learn how to use the package is to look at the tutorial, available in the organisation webpage [here](https://juliaintervals.github.io/pages/tutorials/tutorialConstraintProgramming/).


## Author
Expand Down
7 changes: 5 additions & 2 deletions src/separator.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ External constants can be used as e.g. `\$a`:

```
a = 3
C = @constraint x^2 + y^2 <= \$a
C = @constraint x^2 + y^2 - \$a <= 0
```
"""
macro constraint(ex::Expr, variables = [])
Expand All @@ -190,10 +190,13 @@ end
"""
Create a separator without the use of macros using ModelingToolkit

e.g vars = @variables x y z
e.g
```
vars = @variables x y z
S = Separator(vars, x^2+y^2<1)
X= IntervalBox(-0.5..1.5, -0.5..1.5, -0.5..1.5)
S(X)
```
"""
function Separator(variables, ex::Operation)
expr, constraint = parse_comparison(ex)
Expand Down