Bindings.LevMar

A low level binding to the C levmar (Levenberg-Marquardt) library.

Documentation

c'LM_VERSION :: String

The version of the C levmar library.

Maximum sizes of arrays.

c'LM_OPTS_SZ :: Num a => a

The maximum size of the options array.

c'LM_INFO_SZ :: Num a => a

The size of the info array.

Errors.

c'LM_ERROR :: Num a => a

c'LM_ERROR_LAPACK_ERROR :: Num a => a

c'LM_ERROR_NO_JACOBIAN :: Num a => a

c'LM_ERROR_NO_BOX_CONSTRAINTS :: Num a => a

c'LM_ERROR_FAILED_BOX_CHECK :: Num a => a

c'LM_ERROR_MEMORY_ALLOCATION_FAILURE :: Num a => a

c'LM_ERROR_CONSTRAINT_MATRIX_ROWS_GT_COLS :: Num a => a

c'LM_ERROR_CONSTRAINT_MATRIX_NOT_FULL_ROW_RANK :: Num a => a

c'LM_ERROR_TOO_FEW_MEASUREMENTS :: Num a => a

c'LM_ERROR_SINGULAR_MATRIX :: Num a => a

c'LM_ERROR_SUM_OF_SQUARES_NOT_FINITE :: Num a => a

Default values for minimization options.

c'LM_INIT_MU :: Fractional a => a

c'LM_STOP_THRESH :: Fractional a => a

c'LM_DIFF_DELTA :: Fractional a => a

Handy type synonyms

type Parameters = Ptr

type Measurements = Ptr

type Options = Ptr

type LowerBounds = Ptr

type UpperBounds = Ptr

type ConstraintsMatrix = Ptr

type ConstraintsVector = Ptr

type Weights = Ptr

type Info = Ptr

type Work = Ptr

type Covar = Ptr

type AData = Ptr ()

type NrOfParameters = CInt

type NrOfMeasurements = CInt

type NrOfConstraints = CInt

type MaxIterations = CInt

Model & Jacobian.

type Model r = Parameters r -> Measurements r -> NrOfParameters -> NrOfMeasurements -> AData -> IO ()

Functional relation describing measurements.

type Jacobian a = Model a

withModel :: Model a -> (FunPtr (Model a) -> IO b) -> IO b

withJacobian :: Jacobian a -> (FunPtr (Jacobian a) -> IO b) -> IO b

Types of the Levenberg-Marquardt algorithms.

type LevMarDer r = FunPtr (Model r) -> FunPtr (Jacobian r) -> Parameters r -> Measurements r -> NrOfParameters -> NrOfMeasurements -> MaxIterations -> Options r -> Info r -> Work r -> Covar r -> AData -> IO CInt

type LevMarDif r = FunPtr (Model r) -> Parameters r -> Measurements r -> NrOfParameters -> NrOfMeasurements -> MaxIterations -> Options r -> Info r -> Work r -> Covar r -> AData -> IO CInt

type LevMarBCDer r = FunPtr (Model r) -> FunPtr (Jacobian r) -> Parameters r -> Measurements r -> NrOfParameters -> NrOfMeasurements -> LowerBounds r -> UpperBounds r -> MaxIterations -> Options r -> Info r -> Work r -> Covar r -> AData -> IO CInt

type LevMarBCDif r = FunPtr (Model r) -> Parameters r -> Measurements r -> NrOfParameters -> NrOfMeasurements -> LowerBounds r -> UpperBounds r -> MaxIterations -> Options r -> Info r -> Work r -> Covar r -> AData -> IO CInt

type LevMarLecDer r = FunPtr (Model r) -> FunPtr (Jacobian r) -> Parameters r -> Measurements r -> NrOfParameters -> NrOfMeasurements -> ConstraintsMatrix r -> ConstraintsVector r -> NrOfConstraints -> MaxIterations -> Options r -> Info r -> Work r -> Covar r -> AData -> IO CInt

type LevMarLecDif r = FunPtr (Model r) -> Parameters r -> Measurements r -> NrOfParameters -> NrOfMeasurements -> ConstraintsMatrix r -> ConstraintsVector r -> NrOfConstraints -> MaxIterations -> Options r -> Info r -> Work r -> Covar r -> AData -> IO CInt

type LevMarBLecDer r = FunPtr (Model r) -> FunPtr (Jacobian r) -> Parameters r -> Measurements r -> NrOfParameters -> NrOfMeasurements -> LowerBounds r -> UpperBounds r -> ConstraintsMatrix r -> ConstraintsVector r -> NrOfConstraints -> Weights r -> MaxIterations -> Options r -> Info r -> Work r -> Covar r -> AData -> IO CInt

type LevMarBLecDif r = FunPtr (Model r) -> Parameters r -> Measurements r -> NrOfParameters -> NrOfMeasurements -> LowerBounds r -> UpperBounds r -> ConstraintsMatrix r -> ConstraintsVector r -> NrOfConstraints -> Weights r -> MaxIterations -> Options r -> Info r -> Work r -> Covar r -> AData -> IO CInt

Levenberg-Marquardt algorithms.

c'dlevmar_der :: LevMarDer Double

c'slevmar_der :: LevMarDer Float

c'dlevmar_dif :: LevMarDif Double

c'slevmar_dif :: LevMarDif Float

c'dlevmar_bc_der :: LevMarBCDer Double

c'slevmar_bc_der :: LevMarBCDer Float

c'dlevmar_bc_dif :: LevMarBCDif Double

c'slevmar_bc_dif :: LevMarBCDif Float

c'dlevmar_lec_der :: LevMarLecDer Double

c'slevmar_lec_der :: LevMarLecDer Float

c'dlevmar_lec_dif :: LevMarLecDif Double

c'slevmar_lec_dif :: LevMarLecDif Float

c'dlevmar_blec_der :: LevMarBLecDer Double

c'slevmar_blec_der :: LevMarBLecDer Float

c'dlevmar_blec_dif :: LevMarBLecDif Double

c'slevmar_blec_dif :: LevMarBLecDif Float

Jacobian verification

type Errors = Ptr

type LevMarChkJac r = FunPtr (Model r) -> FunPtr (Jacobian r) -> Parameters r -> NrOfParameters -> NrOfMeasurements -> AData -> Errors r -> IO ()

c'dlevmar_chkjac :: LevMarChkJac Double

c'slevmar_chkjac :: LevMarChkJac Float

Utils

type BestFitParameterIx = CInt

type LevMarStddev r = Covar r -> NrOfParameters -> BestFitParameterIx -> IO r

Standard deviation.

type LevMarCorCoef r = Covar r -> NrOfParameters -> BestFitParameterIx -> BestFitParameterIx -> IO r

Pearson's correlation coefficient for best-fit parameters.

type LevMarR2 r = FunPtr (Model r) -> Parameters r -> Measurements r -> NrOfParameters -> NrOfMeasurements -> AData -> Result r -> IO CInt

Coefficient of determination (R2).

type Result = Ptr

c'dlevmar_stddev :: LevMarStddev Double

c'slevmar_stddev :: LevMarStddev Float

c'dlevmar_corcoef :: LevMarCorCoef Double

c'slevmar_corcoef :: LevMarCorCoef Float

c'dlevmar_R2 :: LevMarR2 Double

c'slevmar_R2 :: LevMarR2 Float