Last updated

API / geotoolkit / controls / util / regression / RegressionBase / RegressionBase

Class: RegressionBase

regression.RegressionBase.RegressionBase

Base class of regression model

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new RegressionBase(options, customFunc)

new RegressionBase(options?, customFunc?)

Regression base

Parameters

Name Type Description
Optional optionsOptionssee setOptions and setData for details
Optional customFuncPredictFunctioncustom function to represent regression model

Overrides

EventDispatcher.constructor

Methods

dispose

dispose(): void

Dispose.

Returns

void

Inherited from

EventDispatcher.dispose


fit

fit(dataX, dataY, weights): void

fit the curve with given data set the subclass of RegressionBase need to support incremental fitting by default that means the model have to keep necessary intermediate values as properties which can be used to do incremental calculating when add new data point to model

Parameters

Name Type Description
dataXnumber[]data set x
dataYnumber[]data set y
weightsnumber[]of data point

Returns

void


getClassName

getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName


getCoefficients

getCoefficients(): number[]

get coefficients

Returns

number[]


getConfidenceInterval

getConfidenceInterval(x): number

get confidence interval for given x value

Parameters

Name Type Description
xnumbergiven value to determine the confidence interval

Returns

number

return confidence interval for x


getConfidenceProbability

getConfidenceProbability(): Probability

get probability for determine confidence interval

Returns

Probability

probability


getData

getData(): DataOut

get all data for training

Returns

DataOut


getDegreeOfFreedom

getDegreeOfFreedom(): number

get degree of freedom

Returns

number

return degree of freedom


getMean

getMean(axis): number

get mean value for data set x or y

Parameters

Name Type Description
axis"x" | "y"axis could be 'x' or 'y'

Returns

number

return mean value of data set


getModelType

getModelType(): string

Returns regression model type

Returns

string

Model type


getOptions

getOptions(): OptionsOut

get options

Returns

OptionsOut

options


getPredictionInterval

getPredictionInterval(x): number

get prediction interval for given x value

Parameters

Name Type Description
xnumbergiven value to determine the prediction interval

Returns

number

return prediction interval for x


getPredictionProbability

getPredictionProbability(): Probability

get probability for determine prediction interval

Returns

Probability

probability


getProperties

getProperties(): OptionsOut

get properties

Returns

OptionsOut

properties


getResiduals

getResiduals(): number[]

get array of residuals

Returns

number[]

residuals array of residuals


getRsquared

getRsquared(): number

get R squared value

Returns

number

return R squared value


getStatistics

getStatistics(): Statistics

get statistics of regression analysis

Returns

Statistics


getSumSquaredResidual

getSumSquaredResidual(): number

get sum squared of residual

Returns

number

return sum squared of residual


getTotalSumSquared

getTotalSumSquared(axis): number

get sum squared for data set x or y

Parameters

Name Type Description
axis"x" | "y"axis could be 'x' or 'y'

Returns

number

return sum squared value of data set


hasEventListener

hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

EventDispatcher.hasEventListener


inversePredict

inversePredict(dataY): number

predict x value with given y value

Parameters

Name Type Description
dataYnumbersingle value y

Returns

number

predictedDataX predicted x value

inversePredict(dataY): number[]

predict x values with given y value

Parameters

Name Type Description
dataYnumber[]data set of Y

Returns

number[]

predictedDataX predicted x values


isCustomizedCoef

isCustomizedCoef(): boolean

get customized coefficients flag

Returns

boolean

customizedCoef


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

EventDispatcher.isDisposed


isSilent

isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

Returns

boolean

Inherited from

EventDispatcher.isSilent


notify

notify<E>(type, source, args?): RegressionBase

Notify listeners

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEevent types
sourceRegressionBaseof the event
Optional argsEventMap[E]arguments of the event

Returns

RegressionBase

this

Overrides

EventDispatcher.notify


off

off<E>(type?, callback?): RegressionBase

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: RegressionBase, args: EventMap[E]) => voidfunction to be called

Returns

RegressionBase

this

Overrides

EventDispatcher.off


on

on<E>(type, callback): RegressionBase

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: RegressionBase, args: EventMap[E]) => voidto be called

Returns

RegressionBase

this

Overrides

EventDispatcher.on


predict

predict(dataX): number

predict y value with given x value

Parameters

Name Type Description
dataXnumbersingle value x

Returns

number

predictedDataY predicted y value

predict(dataX): number[]

predict y values with given x value

Parameters

Name Type Description
dataXnumber[]data set of X

Returns

number[]

predictedDataY predicted y values


resetModel

resetModel(): void

reset the model including all intermediate variables and training data

Returns

void


setConfidenceProbability

setConfidenceProbability(prob): RegressionBase

set probability for looking up t-table to determine confidence interval

Parameters

Name Type Description
probProbabilityprobability

Returns

RegressionBase

this


setOptions

setOptions(options): RegressionBase

set options

Parameters

Name Type Description
optionsOptionsoptions

Returns

RegressionBase

this


setPredictionProbability

setPredictionProbability(prob): RegressionBase

set probability for looking up t-table to determine prediction interval

Parameters

Name Type Description
probProbabilityprobability

Returns

RegressionBase

this


setProperties

setProperties(properties?): RegressionBase

Sets properties

Parameters

Name Type Description
Optional propertiesOptionsoptions

Returns

RegressionBase

this


setSilent

setSilent(bool): RegressionBase

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

RegressionBase

this

Inherited from

EventDispatcher.setSilent


getClassName

Static getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName