Brent's method for univariate function optimization.
Project description
# brent-search
[![PyPIl](https://img.shields.io/pypi/l/brent-search.svg?style=flat-square)](https://pypi.python.org/pypi/brent-search/)
[![PyPIv](https://img.shields.io/pypi/v/brent-search.svg?style=flat-square)](https://pypi.python.org/pypi/brent-search/)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/brent-search/badges/version.svg)](https://anaconda.org/conda-forge/brent-search)
[![Documentation Status](https://readthedocs.org/projects/brent-search/badge/?style=flat-square&version=latest)](http://brent-search.readthedocs.io/en/latest/?badge=latest)
Brent's method for univariate function optimization.
## Example
```python
from brent_search import brent
def func(x, s):
return (x - s)**2 - 0.8
r = brent(lambda x: func(x, 0), -10, 10)
print(r)
```
The output should be
```
(0.0, -0.8, 6)
```
## Install
The recommended way of installing it is via
[conda](http://conda.pydata.org/docs/index.html)
```bash
conda install -c conda-forge brent-search
```
An alternative way would be via pip
```bash
pip install brent-search
```
## Running the tests
After installation, you can test it
```
python -c "import brent_search; brent_search.test()"
```
as long as you have [pytest](http://docs.pytest.org/en/latest/).
## Authors
* **Danilo Horta** - [https://github.com/Horta](https://github.com/Horta)
## License
This project is licensed under the MIT License - see the
[LICENSE](LICENSE) file for details
## Links
- [brent-search-feedstock](https://github.com/conda-forge/brent-search-feedstock)
[![PyPIl](https://img.shields.io/pypi/l/brent-search.svg?style=flat-square)](https://pypi.python.org/pypi/brent-search/)
[![PyPIv](https://img.shields.io/pypi/v/brent-search.svg?style=flat-square)](https://pypi.python.org/pypi/brent-search/)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/brent-search/badges/version.svg)](https://anaconda.org/conda-forge/brent-search)
[![Documentation Status](https://readthedocs.org/projects/brent-search/badge/?style=flat-square&version=latest)](http://brent-search.readthedocs.io/en/latest/?badge=latest)
Brent's method for univariate function optimization.
## Example
```python
from brent_search import brent
def func(x, s):
return (x - s)**2 - 0.8
r = brent(lambda x: func(x, 0), -10, 10)
print(r)
```
The output should be
```
(0.0, -0.8, 6)
```
## Install
The recommended way of installing it is via
[conda](http://conda.pydata.org/docs/index.html)
```bash
conda install -c conda-forge brent-search
```
An alternative way would be via pip
```bash
pip install brent-search
```
## Running the tests
After installation, you can test it
```
python -c "import brent_search; brent_search.test()"
```
as long as you have [pytest](http://docs.pytest.org/en/latest/).
## Authors
* **Danilo Horta** - [https://github.com/Horta](https://github.com/Horta)
## License
This project is licensed under the MIT License - see the
[LICENSE](LICENSE) file for details
## Links
- [brent-search-feedstock](https://github.com/conda-forge/brent-search-feedstock)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
brent-search-1.0.16.tar.gz
(7.3 kB
view hashes)