Package adaa.analytics.rules.logic.representation.rule

Class SurvivalRule

java.lang.Object

adaa.analytics.rules.logic.representation.rule.Rule

adaa.analytics.rules.logic.representation.rule.SurvivalRule

All Implemented Interfaces:

Serializable, Cloneable

public class SurvivalRule
extends Rule

Class representing a survival rule.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected KaplanMeierEstimator	estimator	Kaplan-Meier estimator in a rule consequence.
static final String	SURVIVAL_TIME_ROLE	Name of the attribute role representing survival time.

Fields inherited from class adaa.analytics.rules.logic.representation.rule.Rule

consequence, coveredNegatives, coveredPositives, inducedConditionsCount, premise, pvalue, ruleOrderNum, stats, weight, weighted_n, weighted_N, weighted_p, weighted_P

Constructor Summary

Constructors

Constructor	Description
SurvivalRule(CompoundCondition premise, ElementaryCondition consequence)	Creates a survival rule with a given premise (consequence is ignored).
SurvivalRule(Rule r, KaplanMeierEstimator estimator)	Creates a survival rule from rule with empty consequence and survival function estimate.

Method Summary

Modifier and Type	Method	Description
Covering	covers(IExampleSet set)	Applies the rule on a specified example set.
void	covers(IExampleSet set, ContingencyTable ct)	Applies the rule on a specified example set.
void	covers(IExampleSet set, ContingencyTable ct, Set<Integer> positives, Set<Integer> negatives)	Applies the rule on a specified example set.
Covering	covers(IExampleSet set, Set<Integer> ids)	Applies the rule on a part of a specified example set.
KaplanMeierEstimator	getEstimator()	Gets estimator.
void	setEstimator(KaplanMeierEstimator v)	Sets estimator.
String	toString()	Generates a text representation of the rule.
void	updateWeightAndPValue(IExampleSet trainSet, ContingencyTable ct, IQualityMeasure votingMeasure)	Calculates Rule.weight and Rule.pvalue.

Methods inherited from class adaa.analytics.rules.logic.representation.rule.Rule

clone, copyFrom, coversUnlabelled, equals, getConsequence, getCoveredNegatives, getCoveredPositives, getCoveringInformation, getInducedConditionsCount, getPremise, getPValue, getRuleOrderNum, getStat, getTableHeader, getWeight, getWeighted_n, getWeighted_N, getWeighted_p, getWeighted_P, printStats, putStat, setConsequence, setCoveredNegatives, setCoveredPositives, setCoveringInformation, setInducedContitionsCount, setPremise, setPValue, setRuleOrderNum, setWeight, setWeighted_n, setWeighted_N, setWeighted_p, setWeighted_P, toTable

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

SURVIVAL_TIME_ROLE

public static final String SURVIVAL_TIME_ROLE

Name of the attribute role representing survival time.

See Also:

• Constant Field Values

estimator

protected KaplanMeierEstimator estimator

Kaplan-Meier estimator in a rule consequence.

Constructor Details

SurvivalRule

public SurvivalRule(CompoundCondition premise,
 ElementaryCondition consequence)

Creates a survival rule with a given premise (consequence is ignored).

Parameters:

premise - Rule premise.

consequence - Ignored.

SurvivalRule

public SurvivalRule(Rule r,
 KaplanMeierEstimator estimator)

Creates a survival rule from rule with empty consequence and survival function estimate.

Parameters:

r - Reference rule.

estimator - Survival function estimate.

Method Details

getEstimator

public KaplanMeierEstimator getEstimator()

Gets estimator.

setEstimator

public void setEstimator(KaplanMeierEstimator v)

Sets estimator.

updateWeightAndPValue

public void updateWeightAndPValue(IExampleSet trainSet,
 ContingencyTable ct,
 IQualityMeasure votingMeasure)

Calculates Rule.weight and Rule.pvalue.

Specified by:

updateWeightAndPValue in class Rule

Parameters:

trainSet - Training set.

ct - Contingency table.

votingMeasure - Measure used as weight.

covers

public Covering covers(IExampleSet set,
 Set<Integer> ids)

Applies the rule on a part of a specified example set.

Specified by:

covers in class Rule

Parameters:

set - Example set.

ids - Set of identifiers to be examined.

Returns:

Information about covering.

covers

public void covers(IExampleSet set,
 @NotNull
 ContingencyTable ct)

Description copied from class: Rule

Applies the rule on a specified example set.

Overrides:

covers in class Rule

Parameters:

set - Example set.

ct - Output contingency table.

covers

public void covers(IExampleSet set,
 @NotNull
 ContingencyTable ct,
 @NotNull
 Set<Integer> positives,
 @NotNull
 Set<Integer> negatives)

Description copied from class: Rule

Applies the rule on a specified example set.

Overrides:

covers in class Rule

Parameters:

set - Example set.

ct - Output contingency table.

positives - Output collection of covered positive ids.

negatives - Output collection of covered negative ids.

covers

public Covering covers(IExampleSet set)

Applies the rule on a specified example set.

Specified by:

covers in class Rule

Parameters:

set - Example set.

Returns:

Information about covering.

toString

public String toString()

Description copied from class: Rule

Generates a text representation of the rule.

Overrides:

toString in class Rule

Returns:

Text representation.