# ml-direct

> Direct - DIviding RECTangles optimization algorithm

Latest version **1.0.0** (published 2024-03-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install ml-direct
pnpm add ml-direct
yarn add ml-direct
bun add ml-direct
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2024-03-07 |
| First published | 2020-10-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 35.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Wargner Moreno |
| Maintainers | mljs-bot |

## Links

- npm: https://www.npmjs.com/package/ml-direct
- Repository: https://github.com/mljs/direct
- Homepage: https://github.com/mljs/direct#readme
- Issues: https://github.com/mljs/direct/issues
- npm.io page: https://npm.io/package/ml-direct

## Dependencies (2)

- [ml-matrix](https://npm.io/package/ml-matrix.md) ^6.11.0
- [ml-spectra-processing](https://npm.io/package/ml-spectra-processing.md) ^14.2.0

## Recent versions

- 1.0.0 (latest) — 2024-03-07
- 0.1.3 — 2023-03-24
- 0.1.1 — 2022-09-22
- 0.1.0 — 2020-11-06
- 0.0.1 — 2020-10-31

## README

# ml-direct

[![NPM version][npm-image]][npm-url]
[![build status][ci-image]][ci-url]
[![npm download][download-image]][download-url]

# Direct - DIviding RECTangles algorithm.

The algorithm is intended to minimize real valued multivariate scalar fields over a hyper-rectangular region of N, theoretically the only prerequisite to achieve convergence is that the function must be continuous in the domain or at least continuous over a neighborhood of the global minimum.

## Advanced example

```js
import direct from 'ml-direct';

const options = {
  iterations: 50,
};

const lowerBoundaries = [-1, -1.5];
const upperBoundaries = [2, 6];

const predicted = direct(griewank, lowerBoundaries, upperBoundaries, options);

function griewank(x) {
  let d = x.length;
  let s = 0;
  let p = 1;
  for (let i = 0; i < d; i++) {
    s += Math.pow(x[i], 2) / Math.sqrt(4000);
    p *= Math.cos(x[i] / Math.sqrt(i + 1));
  }
  let result = s - p + 1;
  return result;
}

// predicted.minFunctionValue = 0;
// predicted.optima[0] = [0, 0]; This are the points where the function has minimum value
```

<p align="center">
  <img src="image/griewandContourplotDirect.png">
</p>

<p align="center">
  A tool for global optimization of real valued functions .
</p>

## Installation

`$ npm i ml-direct`

## Usage

```js
import direct from 'ml-direct';

const options = {
  iterations: 25,
};

// for x we explore values between -5 and 4
// for y we explore values between -2 and 3

const lowerBoundaries = [-5, -2];
const upperBoundaries = [4, 3];

const quadratic = function (parameters) {
  let [x, y] = parameters;
  return Math.pow(x, 2) + Math.pow(y, 2);
};

const predicted = direct(quadratic, lowerBoundaries, upperBoundaries, options);

// predicted.minFunctionValue = 0;
// predicted.optima[0] = [0, 0];
```

## [API Documentation](https://mljs.github.io/direct/)

## References

- Jones, D. R., Perttunen, C. D., & Stuckman, B. E. (1993). Lipschitzian optimization without the Lipschitz constant. Journal of optimization Theory and Applications, 79(1), 157-181.

- Björkman, M., & Holmström, K. (1999). Global optimization using the DIRECT algorithm in Matlab.

- Preparata, F. P., & Shamos, M. I. (2012). Computational geometry: an introduction. Springer Science & Business Media.

## License

[MIT](./LICENSE)

[npm-image]: https://img.shields.io/npm/v/ml-direct.svg
[npm-url]: https://www.npmjs.com/package/ml-direct
[ci-image]: https://github.com/mljs/direct/workflows/Node.js%20CI/badge.svg?branch=main
[ci-url]: https://github.com/mljs/direct/actions?query=workflow%3A%22Node.js+CI%22
[download-image]: https://img.shields.io/npm/dm/ml-direct.svg
[download-url]: https://www.npmjs.com/package/ml-direct

---
_Source: https://npm.io/package/ml-direct · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._