Stimfit 0.12.7
Public Member Functions | Public Attributes
stf::storedFunc Struct Reference

Function used for least-squares fitting. More...

#include <stfmath.h>

Collaboration diagram for stf::storedFunc:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 storedFunc (const std::string &name_, const std::vector< parInfo > &pInfo_, const Func &func_, const Init &init_, const Jac &jac_, bool hasJac_=true, const Output &output_=defaultOutput)
 Constructor.
 ~storedFunc ()
 Destructor.

Public Attributes

std::string name
std::vector< parInfopInfo
Func func
Init init
Jac jac
bool hasJac
Output output

Detailed Description

Function used for least-squares fitting.

Objects of this class are used for fitting functions to data. The client supplies a function (func), its jacobian (jac), information about the function's parameters (pInfo) and a function to initialize the parameters (init).


Constructor & Destructor Documentation

stf::storedFunc::storedFunc ( const std::string &  name_,
const std::vector< parInfo > &  pInfo_,
const Func func_,
const Init init_,
const Jac jac_,
bool  hasJac_ = true,
const Output output_ = defaultOutput 
) [inline]

Constructor.

Parameters:
name_Plain function name.
pInfo_A vector containing information about the function parameters.
func_The function that will be fitted to the data.
jac_Jacobian of func_.
hasJac_true if a Jacobian is available.
init_A function for initialising the parameters.
output_Output of the fit.

Member Data Documentation

The function that will be fitted to the data.

True if the function has an analytic Jacobian.

A function for initialising the parameters.

Jacobian of func.

std::string stf::storedFunc::name

Function name.

Output of the fit.

A vector containing information about the function parameters.


The documentation for this struct was generated from the following file: