# ml-levenberg-marquardt

Curve fitting method in javascript

## Usage no npm install needed!

``````<script type="module">
import mlLevenbergMarquardt from 'https://cdn.skypack.dev/ml-levenberg-marquardt';
</script>``````

# levenberg-marquardt

Curve fitting method in javascript.

## API Documentation

In order to get a general idea of the problem you could also check the Wikipedia article.

## Installation

`\$ npm i ml-levenberg-marquardt`

## Options

Next there is some options could change the behavior of the code.

### centralDifference

The jacobian matrix is approximated by finite difference; forward differences or central differences (one additional function evaluation). The option centralDifference select one of them, by default the jacobian is calculated by forward difference.

The jacobian matrix is approximated as mention above, the gradientDifference option is the step size (dp) to calculate de difference between the function with the current parameter state and the perturbation added. It could be a number (same step size for all parameters) or an array with different values for each parameter, if the gradientDifference is zero the derive will be zero, and the parameter will hold fixed

## Example

``````// import library
import LM from 'ml-levenberg-marquardt';
// const LM = require('ml-levenberg-marquardt').default;

// function that receives the parameters and returns
// a function with the independent variable as a parameter
function sinFunction([a, b]) {
return (t) => a * Math.sin(b * t);
}

// array of points to fit
let data = {
x: [
/* x1, x2, ... */
],
y: [
/* y1, y2, ... */
],
};

// array of initial parameter values
let initialValues = [
/* a, b, c, ... */
];

// Optionally, restrict parameters to minimum & maximum values
let minValues = [
/* a_min, b_min, c_min, ... */
];
let maxValues = [
/* a_max, b_max, c_max, ... */
];

const options = {
damping: 1.5,
initialValues: initialValues,
minValues: minValues,
maxValues: maxValues,