Skip to content

Commit

Permalink
Update doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
@emmt
emmt committed Oct 17, 2023
1 parent 8c2398b commit 54054b2
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ package:
equality constraints, and linear inequality constraints.

All these algorithms are trust region methods where the variables are updated
according to an affine or quadratic local approximation interpolating the
according to an affine or a quadratic local approximation interpolating the
objective function at a given number of points (set by keyword `npt` by some of
the algorithms). No derivatives of the objective function are needed. These
algorithms are well suited to problems with a non-analytic objective function
Expand Down Expand Up @@ -130,19 +130,19 @@ end
The keywords allowed by the different algorithms are summarized by the
following table.

| Keyword | Description | Algorithms |
|:-------------|:---------------------------------------|:-----------------------------|
| `rhobeg` | Initial trust region radius | all |
| `rhoend` | Final trust region radius | all |
| `ftarget` | Target objective function value | all |
| `maxfun` | Maximum number of function evaluations | all |
| `iprint` | Verbosity level | all |
| `npt` | Number of points in local model | `bobyqa`, `lincoa`, `newuoa` |
| `xl` | Lower bound | `bobyqa`, `cobyla`, `lincoa` |
| `xu` | Upper bound | `bobyqa`, `cobyla`, `lincoa` |
| `nlconstr` | Non-linear constraints | `cobyla` |
| `eqconstr` | Linear equality constraints | `cobyla`, `lincoa` |
| `ineqconstr` | Linear inequality constraints | `cobyla`, `lincoa` |
| Keyword | Description | Algorithms |
|:-----------------|:---------------------------------------|:-----------------------------|
| `rhobeg` | Initial trust region radius | all |
| `rhoend` | Final trust region radius | all |
| `ftarget` | Target objective function value | all |
| `maxfun` | Maximum number of function evaluations | all |
| `iprint` | Verbosity level | all |
| `npt` | Number of points in local model | `bobyqa`, `lincoa`, `newuoa` |
| `xl` | Lower bound | `bobyqa`, `cobyla`, `lincoa` |
| `xu` | Upper bound | `bobyqa`, `cobyla`, `lincoa` |
| `nonlinear_ineq` | Non-linear inequality constraints | `cobyla` |
| `linear_eq` | Linear equality constraints | `cobyla`, `lincoa` |
| `linear_ineq` | Linear inequality constraints | `cobyla`, `lincoa` |

Assuming `n = length(x)` is the number of variables, then:

Expand Down Expand Up @@ -174,11 +174,11 @@ Assuming `n = length(x)` is the number of variables, then:
elementwise lower and upper bounds for the variables. Feasible variables are
such that `xl ≤ x ≤ xu` (elementwise).

- `nonlinear_ineq` (default `0`) may be specified with the number `m` of
- `nonlinear_ineq` (default `nothing`) may be specified with the number `m` of
non-linear inequality constraints expressed `c(x) ≤ 0`. If the caller is
interested in the values of `c(x)` at the returned solution the keyword may
be set with a vector of `m` double precision floating-point values
to store `c(x)`. This keyword only exists for `cobyla`.
interested in the values of `c(x)` at the returned solution, the keyword may
be set with a vector of `m` double precision floating-point values to store
`c(x)`. This keyword only exists for `cobyla`.

- `linear_eq` (default `nothing`) may be specified as a tuple `(Aₑ,bₑ)` to
represent linear equality constraints. Feasible variables are such that `Aₑ⋅x
Expand Down

14 comments on commit 54054b2

@emmt
Copy link
Collaborator Author

@emmt emmt commented on 54054b2 Oct 17, 2023

Choose a reason for hiding this comment

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

@JuliaRegistrator register branch=main

@amontoison
Copy link
Member

Choose a reason for hiding this comment

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

@JuliaRegistrator register branch=main

@amontoison
Copy link
Member

Choose a reason for hiding this comment

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

@JuliaRegistrator register branch=main

@amontoison
Copy link
Member

Choose a reason for hiding this comment

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

@emmt I found the culprit. We need to install Julia registrator again on this repository.

@emmt
Copy link
Collaborator Author

@emmt emmt commented on 54054b2 Oct 17, 2023

Choose a reason for hiding this comment

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

Sorry I forgot about this. I have just installed it for the transferred repository.

Let us try again...

@emmt
Copy link
Collaborator Author

@emmt emmt commented on 54054b2 Oct 17, 2023

Choose a reason for hiding this comment

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

@JuliaRegistrator register branch=main

@amontoison
Copy link
Member

Choose a reason for hiding this comment

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

@zaikunzhang Can you also add CirrusCI on this repository?

@zaikunzhang
Copy link
Member

Choose a reason for hiding this comment

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

Done. Thanks. @amontoison

@amontoison
Copy link
Member

Choose a reason for hiding this comment

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

@JuliaRegistrator register branch=main

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Error while trying to register: Register Failed
@amontoison, it looks like you are not a publicly listed member/owner in the parent organization (libprima).
If you are a member/owner, you will need to change your membership to public. See GitHub Help

@zaikunzhang
Copy link
Member

Choose a reason for hiding this comment

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

@JuliaRegistrator register branch=main

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Error while trying to register: Register Failed
@zaikunzhang, it looks like you are not a publicly listed member/owner in the parent organization (libprima).
If you are a member/owner, you will need to change your membership to public. See GitHub Help

@amontoison
Copy link
Member

Choose a reason for hiding this comment

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

@JuliaRegistrator register branch=main

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

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 v0.1.1 -m "<description of version>" 54054b2b32c391e3ab780fcde107ad91257e43f5
git push origin v0.1.1

Also, note the warning: This looks like a new registration that registers version 0.1.1.
Ideally, you should register an initial release with 0.0.1, 0.1.0 or 1.0.0 version numbers
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

Please sign in to comment.