Skip to content

Commit

Permalink
Merge pull request #50 from COBREXA/mk-improve-doc
Browse files Browse the repository at this point in the history 
module doc cleaning
  • Loading branch information
@exaexa
exaexa authored Dec 1, 2024
2 parents c22d454 + fa62ccc commit 60507bb
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions src/ConstraintTrees.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,14 @@ demonstrations, but any other solver framework will do just as well.
The package is structured as follows:
- There is no representation for variables in the model; instead, values depend
on anonymous numbered variables, and, if suitable, special named values may
"implicitly" serve as representations for variables. This assumption erases
the distinction between a "simple" variable and a complex derived linear
combination, allowing more freedom in model construction.
on anonymous numbered variables that are mostly hidden in normal use. This
assumption erases the distinction between a "simple" variable and a complex
derived linear combination, allowing more freedom in model construction. If
required, named values may still "implicitly" serve as representations for
variables.
- Variables may be combined into [`LinearValue`](@ref)s and
[`QuadraticValue`](@ref)s, which are affine combinations and quadratic-affine
combinations (respecitively) of values of some selected variables.
combinations (respectively) of values of some selected variables.
- Values may be bounded to an interval or exact value using a
[`Constraint`](@ref)
- A collection of named [`Constraint`](@ref)s is called a
Expand All @@ -47,8 +48,8 @@ The package is structured as follows:
-- this forms the basis of the "tidy" algebra of constraints.
- A variable assignment, which is typically the "solution" for a given
constraint tree, can be combined with a [`ConstraintTree`](@ref) to create a
"value tree" via [`substitute_values`](@ref), which enables browsing of the
optimization results in the very same structure as the input
"value tree" via [`substitute_values`](@ref). Value trees enable browsing of
the optimization results in the very same structure as the input
[`ConstraintTree`](@ref).
You can follow the examples in documentation and the docstrings of package
Expand Down

2 comments on commit 60507bb

@exaexa
Copy link
Member Author

@exaexa exaexa commented on 60507bb Dec 1, 2024

Choose a reason for hiding this comment

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

@JuliaRegistrator register

@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/120469

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.5.0 -m "<description of version>" 60507bbd97e41717eb018bd1e2032098575b0cab
git push origin v1.5.0

Please sign in to comment.