Skip to content

Commit

Permalink
Update usage.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mykelk authored Sep 22, 2024
1 parent 6480b07 commit 45596d9
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions docs/src/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ To use the `DividedRectangles` module, start your code with:
using DividedRectangles
```

## Core Functions

### `optimize`
The `optimize` function is the primary function of the `DividedRectangles` module. It implements the DIRECT algorithm to find the minimum of a given objective function within specified bounds.

To use the `optimize` function with a custom objective function::
Expand Down Expand Up @@ -38,4 +35,4 @@ println("Best design found: ", result)
- `min_radius`: (Optional) The minimum radius of hyper-rectangles (default: 1e-5).

**Returns:**
- The best design 𝑥 found by DIRECT.
- The best design `x` found by DIRECT.

0 comments on commit 45596d9

Please sign in to comment.