C# Class Segmenter.Model.Criterion.Criterion

The criterion of break. Defines the best mode of segmentation. Allows you to handle how long will the process do something.
Inheritance: IDefinable
Show file Open project: intervals-mining-lab/libiada-core Class Usage Examples

Protected Properties

Property Type Description
ThresholdToStop ThresholdVariator
alphabet FrequencyDictionary
chain ComplexChain
precisionOfDifference double

Public Methods

Method Description
Criterion ( ThresholdVariator threshold, double precision ) : System

Initializes a new instance of the Criterion class.
Distortion ( ) : double

Returns distortion between necessary and calculated value inside of criterion. For example between theoretical and practical values.
Distortion ( ComplexChain chain, FrequencyDictionary alphabet ) : double

Returns distortion between necessary and calculated value. For example between theoretical and practical values.
GetValue ( ) : double

The get value.
Renew ( ComplexChain chain, FrequencyDictionary alphabet ) : void

Updates data for computing a new value of the criterion.
State ( ComplexChain chain, FrequencyDictionary alphabet ) : bool

Returns the state of criterion. True, if everything is done, false - otherwise.

Method Details

Criterion() public method

Initializes a new instance of the Criterion class.
public Criterion ( ThresholdVariator threshold, double precision ) : System
threshold ThresholdVariator /// A rule for handling a threshold value. ///
precision double /// Additional value to. ///
return System

Distortion() public method

Returns distortion between necessary and calculated value inside of criterion. For example between theoretical and practical values.
public Distortion ( ) : double
return double

Distortion() public abstract method

Returns distortion between necessary and calculated value. For example between theoretical and practical values.
public abstract Distortion ( ComplexChain chain, FrequencyDictionary alphabet ) : double
chain ComplexChain /// The chain. ///
alphabet FrequencyDictionary /// The alphabet. ///
return double

GetValue() public method

The get value.
public GetValue ( ) : double
return double

Renew() public method

Updates data for computing a new value of the criterion.
public Renew ( ComplexChain chain, FrequencyDictionary alphabet ) : void
chain ComplexChain /// A new chain. ///
alphabet FrequencyDictionary /// A new alphabet. ///
return void

State() public abstract method

Returns the state of criterion. True, if everything is done, false - otherwise.
public abstract State ( ComplexChain chain, FrequencyDictionary alphabet ) : bool
chain ComplexChain /// The chain. ///
alphabet FrequencyDictionary /// Chains alphabet. ///
return bool

Property Details

ThresholdToStop protected property

The threshold to stop.
protected ThresholdVariator ThresholdToStop
return ThresholdVariator

alphabet protected property

The alphabet.
protected FrequencyDictionary alphabet
return FrequencyDictionary

chain protected property

The chain.
protected ComplexChain chain
return ComplexChain

precisionOfDifference protected property

The precision of difference.
protected double precisionOfDifference
return double