FitState

hep.dataforge.stat.fit.FitState

```
public class FitState
```
This class combine the information required to fit data. The key elements are Table, Model and initial ParamSet. Additionally, one can provide covariance matrix, prior probability, fit history etc. To simplify construction of FitState use FitState.Builder

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FitState.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`FitState.Builder`

Constructor Summary

Constructors
Constructor and Description

FitState()

FitState()

FitState()
clone constructor

Constructors
Constructor and Description
`FitState()`
`FitState()`
`FitState()` clone constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FitState.Builder`	`builder()`
`FitState.Builder`	`edit()` Creates new FitState object based on this one and returns its Builder.
`double`	`getChi2()`
`double`	`getChi2()` Априорная вероятность не учитывается
`NamedMatrix`	`getCorrelationMatrix()`
`NamedMatrix`	`getCovariance()` Возвращается всегда полная матрица, включающая даже параметры, которые не фитировались. Для параметров, для которых нет матрицы в явном виде возвращаются только диоганальные элементы.
`NavigableValuesSource`	`getData()`
`int`	`getDataSize()`
`double`	`getDis()` Возвращает расстояния от i-той точки до спектра с параметрами pars. расстояние в общем случае идет со знаком и для одномерного случая описыватьеся как спектр-данные.
`double`	`getDisDeriv()` Производная от расстояния по параметру "name". Совпадает с производной исходной функции в одномерном случае На этом этапе обабатывается `NotDefinedException`. В случае обращения, производная вычисляется внутренним калькулятором.
`double`	`getDispersion()` Дисперсия i-той точки. В одномерном случае квадрат ошибки. Значения параметров передаются на всякий случай, если вдруг придется делать зависимость веса от параметров.
`java.util.Optional<hep.dataforge.stat.fit.IntervalEstimate>`	`getIntervalEstimate()`
`LogLikelihood`	`getLogLike()`
`double`	`getLogProb()` Учитывается вероятность, заданная в модели и априорная вероятность
`double`	`getLogProbDeriv()` Учитывается вероятность, заданная в модели и априорная вероятность
`Model`	`getModel()`
`int`	`getModelDim()`
`ParamSet`	`getParameters()`
`ParametricValue`	`getPrior()`
`boolean`	`hasCovariance()` Shows if state has defined covariance. Otherwise singular covariance is used
`boolean`	`modelProvidesDerivs()` Возвращает информацию о том, возвращает ли МОДЕЛЬ производные. FitDataSource при этом может возвращать производные в любом случае.
`boolean`	`providesValidAnalyticalDerivs()`

- Constructor Detail
  - FitState
```
public FitState()
```
  - FitState
```
public FitState()
```
  - FitState
```
public FitState()
```
    clone constructor
- Method Detail
  - builder
```
public static FitState.Builder builder()
```
  - edit
```
public FitState.Builder edit()
```
    Creates new FitState object based on this one and returns its Builder.
    
    Returns:
  - getChi2
```
public double getChi2()
```
  - getCorrelationMatrix
```
public NamedMatrix getCorrelationMatrix()
```
  - getCovariance
```
public NamedMatrix getCovariance()
```
    Возвращается всегда полная матрица, включающая даже параметры, которые не фитировались. Для параметров, для которых нет матрицы в явном виде возвращаются только диоганальные элементы.
    
    Returns:
    
    the covariance
  - hasCovariance
```
public boolean hasCovariance()
```
    Shows if state has defined covariance. Otherwise singular covariance is used
    
    Returns:
  - getIntervalEstimate
```
public java.util.Optional<hep.dataforge.stat.fit.IntervalEstimate> getIntervalEstimate()
```
  - getParameters
```
public ParamSet getParameters()
```
  - getChi2
```
public double getChi2()
```
    Априорная вероятность не учитывается
    
    Returns:
    
    a double.
  - getDis
```
public double getDis()
```
    Возвращает расстояния от i-той точки до спектра с параметрами pars. расстояние в общем случае идет со знаком и для одномерного случая описыватьеся как спектр-данные.
    
    Returns:
    
    a double.
  - getDisDeriv
```
public double getDisDeriv()
```
    Производная от расстояния по параметру "name". Совпадает с производной исходной функции в одномерном случае На этом этапе обабатывается NotDefinedException. В случае обращения, производная вычисляется внутренним калькулятором.
    
    Returns:
    
    a double.
  - getDispersion
```
public double getDispersion()
```
    Дисперсия i-той точки. В одномерном случае квадрат ошибки. Значения параметров передаются на всякий случай, если вдруг придется делать зависимость веса от параметров.
    
    Returns:
    
    a double.
  - getLogProb
```
public double getLogProb()
```
    Учитывается вероятность, заданная в модели и априорная вероятность
    
    Returns:
    
    a double.
  - getLogProbDeriv
```
public double getLogProbDeriv()
```
    Учитывается вероятность, заданная в модели и априорная вероятность
    
    Returns:
    
    a double.
  - providesValidAnalyticalDerivs
```
public boolean providesValidAnalyticalDerivs()
```
  - modelProvidesDerivs
```
public boolean modelProvidesDerivs()
```
    Возвращает информацию о том, возвращает ли МОДЕЛЬ производные. FitDataSource при этом может возвращать производные в любом случае.
    
    Returns:
    
    a boolean.
  - getLogLike
```
public LogLikelihood getLogLike()
```
  - getPrior
```
public ParametricValue getPrior()
```
  - getModel
```
public Model getModel()
```
  - getModelDim
```
public int getModelDim()
```
  - getData
```
public NavigableValuesSource getData()
```
  - getDataSize
```
public int getDataSize()
```

Class FitState

Nested Class Summary

Constructor Summary

Method Summary

Constructor Detail

FitState

FitState

FitState

Method Detail

builder

edit

getChi2

getCorrelationMatrix

getCovariance

hasCovariance

getIntervalEstimate

getParameters

getChi2

getDis

getDisDeriv

getDispersion

getLogProb

getLogProbDeriv

providesValidAnalyticalDerivs

modelProvidesDerivs

getLogLike

getPrior

getModel

getModelDim

getData

getDataSize