diff --git a/doc/javadoc/allclasses-frame.html b/doc/javadoc/allclasses-frame.html
new file mode 100644
index 0000000..5f6718d
--- /dev/null
+++ b/doc/javadoc/allclasses-frame.html
@@ -0,0 +1,47 @@
+
+
+
+
+
+All Classes
+All Classes
+
+
+
diff --git a/doc/javadoc/allclasses-noframe.html b/doc/javadoc/allclasses-noframe.html
new file mode 100644
index 0000000..c767d8c
--- /dev/null
+++ b/doc/javadoc/allclasses-noframe.html
@@ -0,0 +1,47 @@
+
+
+
+
+
+All Classes
+All Classes
+
+
+
diff --git a/doc/javadoc/constant-values.html b/doc/javadoc/constant-values.html
new file mode 100644
index 0000000..d0bf379
--- /dev/null
+++ b/doc/javadoc/constant-values.html
@@ -0,0 +1,122 @@
+
+
+
+
+
+Constant Field Values
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/javadoc/de/mrapp/apriori/Apriori.Builder.html b/doc/javadoc/de/mrapp/apriori/Apriori.Builder.html
new file mode 100644
index 0000000..0475502
--- /dev/null
+++ b/doc/javadoc/de/mrapp/apriori/Apriori.Builder.html
@@ -0,0 +1,451 @@
+
+
+
+
+
+Apriori.Builder
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.Apriori.Builder<ItemType>
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+Builder Creates a new builder, which allows to configure and create instances of the class
Apriori.
+
+Builder Creates a new builder, which allows to configure and create instances of the class
Apriori.
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+minSupport
+@NotNull
+public final @NotNull Apriori.Builder <ItemType > minSupport(double minSupport)
+Sets the minimum support, which must at least be reached by an item set to be considered
+ frequent.
+
+Parameters: minSupport - The support, which should be set, as a Double value. The
+ support must at least be 0 and at maximum 1Returns: The builder, this method has been called upon, as an instance of the class Apriori.Builder
+
+
+
+
+
+
+
+
+maxSupport
+@NotNull
+public final @NotNull Apriori.Builder <ItemType > maxSupport(double maxSupport)
+Sets the minimum support, which should initially be used, when trying to find a specific
+ number of frequent item sets.
+
+Parameters: maxSupport - The support, which should be set, as a Double value. The
+ support must be at least the minimum supportReturns: The builder, this method has been called upon, as an instance of the class Apriori.Builder
+
+
+
+
+
+
+
+
+supportDelta
+@NotNull
+public final @NotNull Apriori.Builder <ItemType > supportDelta(double supportDelta)
+Sets the value, the minimum support should be decreased by after each iteration, when
+ trying to find a specific number of frequent item sets.
+
+Parameters: supportDelta - The value, which should be set, as a Double value. The value
+ must be greater than 0 and less than the maximum supportReturns: The builder, this method has been called upon, as an instance of the class Apriori.Builder
+
+
+
+
+
+
+
+
+frequentItemSetCount
+@NotNull
+public final @NotNull Apriori.Builder <ItemType > frequentItemSetCount(int frequentItemSetCount)
+Sets the number of of frequent item sets, the Apriori algorithm should try to find.
+
+Parameters: frequentItemSetCount - The number of frequent item sets, which should be set, as an
+ Integer value or 0, if the Apriori algorithm should
+ not try to find a specific number of frequent item setsReturns: The builder, this method has been called upon, as an instance of the class Apriori.Builder
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Apriori.Configuration
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.Apriori.Configuration
+
+
+
+
+
+
+
+All Implemented Interfaces:
+java.io.Serializable, java.lang.Cloneable
+
+
+Enclosing class:
+Apriori <ItemType extends Item >
+public static class Apriori.Configuration
+extends java.lang.Object
+implements java.io.Serializable, java.lang.Cloneable
+An configuration of the Apriori algorithm.
+
+See Also: Serialized Form
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Modifier
+Constructor and Description
+
+
+protected Configuration Creates a new configuration of the Apriori algorithm with default values.
+
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+Apriori.Configuration clone
+
+booleanequals
+
+doublegetConfidenceDelta Returns the value, the minimum confidence should be decreased by after each iteration,
+ when trying to generate a specific number of association rules.
+
+
+intgetFrequentItemSetCount Returns the number of frequent item sets, the Apriori algorithm should try to find.
+
+
+doublegetMaxConfidence Returns the minimum confidence, which should initially be used, when trying to generate a
+ specific number of association rules.
+
+
+doublegetMaxSupport Returns the minimum support, which should initially be used, when trying to find a
+ specific number of frequent item sets.
+
+
+doublegetMinConfidence Returns the minimum confidence, which must at least be reached by association rules.
+
+
+doublegetMinSupport Returns the minimum support, which must at least be reached by an item set to be
+ considered frequent.
+
+
+intgetRuleCount Returns the number of association rules, the Apriori algorithm should try to generate.
+
+
+doublegetSupportDelta Returns the value, the minimum support should be decreased by after each iteration, when
+ trying to find a specific number of frequent item sets.
+
+
+inthashCode
+
+booleanisGeneratingRules Returns, whether association rules should be generated, or not.
+
+
+protected voidsetConfidenceDelta Sets the value, the minimum confidence should be decreased by after each iteration, when
+ trying to generate a specific number of association rules.
+
+
+protected voidsetFrequentItemSetCount Sets the number of of frequent item sets, the Apriori algorithm should try to find.
+
+
+protected voidsetGenerateRules Sets, whether association rules should be generated, or not.
+
+
+protected voidsetMaxConfidence Sets the minimum confidence, which should initially be used, when trying to generate a
+ specific number of association rules.
+
+
+protected voidsetMaxSupport Sets the minimum support, which should initially be used, when trying to find a specific
+ number of frequent item sets.
+
+
+protected voidsetMinConfidence Sets the minimum confidence, which must at least be reached by association rules.
+
+
+protected voidsetMinSupport Sets the minimum support, which must at least be reached by an item set to be considered
+ frequent.
+
+
+protected voidsetRuleCount Sets the number of association rule, the Apriori algorithm should try to generate.
+
+
+protected voidsetSupportDelta Sets the value, the minimum support should be decreased by after each iteration, when
+ trying to find a specific number of frequent item sets.
+
+
+java.lang.StringtoString
+
+
+
+
+
+Methods inherited from class java.lang.Object
+finalize, getClass, notify, notifyAll, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+getMinSupport
+public double getMinSupport()
+Returns the minimum support, which must at least be reached by an item set to be
+ considered frequent.
+
+Returns: The minimum support, which must at least be reached by an item set to be
+ considered frequent, as a Double value
+
+
+
+
+
+
+
+
+setMinSupport
+protected void setMinSupport(double minSupport)
+Sets the minimum support, which must at least be reached by an item set to be considered
+ frequent.
+
+Parameters: minSupport - The support, which should be set, as a Double value. The
+ support must at least be 0 and at maximum the maximum support
+
+
+
+
+
+
+
+getMaxSupport
+public double getMaxSupport()
+Returns the minimum support, which should initially be used, when trying to find a
+ specific number of frequent item sets.
+
+Returns: The minimum support, which should initially be used, when trying to find a
+ specific number of frequent item sets, as a Double value
+
+
+
+
+
+
+
+
+setMaxSupport
+protected void setMaxSupport(double maxSupport)
+Sets the minimum support, which should initially be used, when trying to find a specific
+ number of frequent item sets.
+
+Parameters: maxSupport - The support, which should be set, as a Double value. The
+ support must be at least the minimum support
+
+
+
+
+
+
+
+getSupportDelta
+public double getSupportDelta()
+Returns the value, the minimum support should be decreased by after each iteration, when
+ trying to find a specific number of frequent item sets.
+
+Returns: The value, the minimum support should be decreased by after each iteration, when
+ trying to find a specific number of frequent item sets, as a Double value
+
+
+
+
+
+
+
+
+setSupportDelta
+protected void setSupportDelta(double supportDelta)
+Sets the value, the minimum support should be decreased by after each iteration, when
+ trying to find a specific number of frequent item sets.
+
+Parameters: supportDelta - The value, which should be set, as a Double value. The value
+ must be greater than 0
+
+
+
+
+
+
+
+getFrequentItemSetCount
+public int getFrequentItemSetCount()
+Returns the number of frequent item sets, the Apriori algorithm should try to find.
+
+Returns: The number of frequent item sets, the Apriori algorithm should try to find, as an
+ Integer value
+
+
+
+
+
+
+
+
+setFrequentItemSetCount
+protected void setFrequentItemSetCount(int frequentItemSetCount)
+Sets the number of of frequent item sets, the Apriori algorithm should try to find.
+
+Parameters: frequentItemSetCount - The number of frequent item sets, which should be set, as an
+ Integer value or 0, if the Apriori algorithm should
+ not try to find a specific number of frequent item sets
+
+
+
+
+
+
+
+isGeneratingRules
+public boolean isGeneratingRules()
+Returns, whether association rules should be generated, or not.
+
+Returns: True, if association rules should be generated, false otherwise
+
+
+
+
+
+
+
+
+setGenerateRules
+protected void setGenerateRules(boolean generateRules)
+Sets, whether association rules should be generated, or not.
+
+Parameters: generateRules - True, if association rules should be generated, false otherwise
+
+
+
+
+
+
+
+getMinConfidence
+public double getMinConfidence()
+Returns the minimum confidence, which must at least be reached by association rules.
+
+Returns: The minimum confidence, which must at least be reached by association rules, as a
+ Double value
+
+
+
+
+
+
+
+
+setMinConfidence
+protected void setMinConfidence(double minConfidence)
+Sets the minimum confidence, which must at least be reached by association rules.
+
+Parameters: minConfidence - The confidence, which should be set, as a Double value. The
+ confidence must be at least 0 and at maximum the maximum confidence
+
+
+
+
+
+
+
+getMaxConfidence
+public double getMaxConfidence()
+Returns the minimum confidence, which should initially be used, when trying to generate a
+ specific number of association rules.
+
+Returns: The minimum confidence, which should initially be used, when trying to generate a
+ specific number of association rules, as a Double value
+
+
+
+
+
+
+
+
+setMaxConfidence
+protected void setMaxConfidence(double maxConfidence)
+Sets the minimum confidence, which should initially be used, when trying to generate a
+ specific number of association rules.
+
+Parameters: maxConfidence - The confidence, which should be set, as a Double value. The
+ confidence must be at least 0 and at maximum 1
+
+
+
+
+
+
+
+getConfidenceDelta
+public double getConfidenceDelta()
+Returns the value, the minimum confidence should be decreased by after each iteration,
+ when trying to generate a specific number of association rules.
+
+Returns: The value, the minimum confidence should be decreased by after each iteration,
+ when trying to generate a specific number of association rules, as a Double
+ value
+
+
+
+
+
+
+
+
+setConfidenceDelta
+protected void setConfidenceDelta(double confidenceDelta)
+Sets the value, the minimum confidence should be decreased by after each iteration, when
+ trying to generate a specific number of association rules.
+
+Parameters: confidenceDelta - The value, which should be set, as a Double value. The
+ value must be greater than 0
+
+
+
+
+
+
+
+getRuleCount
+public int getRuleCount()
+Returns the number of association rules, the Apriori algorithm should try to generate.
+
+Returns: The number of association rules, the Apriori algorithm should try to generate, as
+ an Integer value
+
+
+
+
+
+
+
+
+setRuleCount
+protected void setRuleCount(int ruleCount)
+Sets the number of association rule, the Apriori algorithm should try to generate.
+
+Parameters: ruleCount - The number of association rules, which should be set, as an Integer value or 0, if the Apriori algorithm should not try to generate
+ a specific number of association rules
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Apriori.RuleGeneratorBuilder
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.Apriori.RuleGeneratorBuilder<ItemType>
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+@NotNull Apriori.RuleGeneratorBuilder <ItemType >confidenceDelta Sets the value, the minimum confidence should be decreased by after each iteration, when
+ trying to generate a specific number of association rules.
+
+
+@NotNull Apriori.RuleGeneratorBuilder <ItemType >frequentItemSetCount Sets the number of of frequent item sets, the Apriori algorithm should try to find.
+
+
+@NotNull Apriori.RuleGeneratorBuilder <ItemType >maxConfidence Sets the minimum confidence, which should initially be used, when trying to generate a
+ specific number of association rules.
+
+
+@NotNull Apriori.RuleGeneratorBuilder <ItemType >maxSupport Sets the minimum support, which should initially be used, when trying to find a specific
+ number of frequent item sets.
+
+
+@NotNull Apriori.RuleGeneratorBuilder <ItemType >minConfidence Sets the minimum confidence, which must at least be reached by association rules.
+
+
+@NotNull Apriori.RuleGeneratorBuilder <ItemType >minSupport Sets the minimum support, which must at least be reached by an item set to be considered
+ frequent.
+
+
+@NotNull Apriori.RuleGeneratorBuilder <ItemType >ruleCount Sets the number of association rule, the Apriori algorithm should try to generate.
+
+
+@NotNull Apriori.RuleGeneratorBuilder <ItemType >supportDelta Sets the value, the minimum support should be decreased by after each iteration, when
+ trying to find a specific number of frequent item sets.
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+minSupport
+@NotNull
+public final @NotNull Apriori.RuleGeneratorBuilder <ItemType > minSupport(double minSupport)
+Sets the minimum support, which must at least be reached by an item set to be considered
+ frequent.
+
+Parameters: minSupport - The support, which should be set, as a Double value. The
+ support must at least be 0 and at maximum 1Returns: The builder, this method has been called upon, as an instance of the class Apriori.RuleGeneratorBuilder
+
+
+
+
+
+
+
+
+maxSupport
+@NotNull
+public final @NotNull Apriori.RuleGeneratorBuilder <ItemType > maxSupport(double maxSupport)
+Sets the minimum support, which should initially be used, when trying to find a specific
+ number of frequent item sets.
+
+Parameters: maxSupport - The support, which should be set, as a Double value. The
+ support must be at least the minimum supportReturns: The builder, this method has been called upon, as an instance of the class Apriori.RuleGeneratorBuilder
+
+
+
+
+
+
+
+
+supportDelta
+@NotNull
+public final @NotNull Apriori.RuleGeneratorBuilder <ItemType > supportDelta(double supportDelta)
+Sets the value, the minimum support should be decreased by after each iteration, when
+ trying to find a specific number of frequent item sets.
+
+Parameters: supportDelta - The value, which should be set, as a Double value. The value
+ must be greater than 0 and less than the maximum supportReturns: The builder, this method has been called upon, as an instance of the class Apriori.RuleGeneratorBuilder
+
+
+
+
+
+
+
+
+frequentItemSetCount
+@NotNull
+public final @NotNull Apriori.RuleGeneratorBuilder <ItemType > frequentItemSetCount(int frequentItemSetCount)
+Sets the number of of frequent item sets, the Apriori algorithm should try to find.
+
+Parameters: frequentItemSetCount - The number of frequent item sets, which should be set, as an
+ Integer value or 0, if the Apriori algorithm should
+ not try to find a specific number of frequent item setsReturns: The builder, this method has been called upon, as an instance of the class Apriori.RuleGeneratorBuilder
+
+
+
+
+
+
+
+
+minConfidence
+@NotNull
+public final @NotNull Apriori.RuleGeneratorBuilder <ItemType > minConfidence(double minConfidence)
+Sets the minimum confidence, which must at least be reached by association rules.
+
+Parameters: minConfidence - The confidence, which should be set, as a Double value. The
+ confidence must be at least 0 and at maximum 1Returns: The builder, this method has been called upon, as an instance of the class Apriori.RuleGeneratorBuilder
+
+
+
+
+
+
+
+
+maxConfidence
+@NotNull
+public final @NotNull Apriori.RuleGeneratorBuilder <ItemType > maxConfidence(double maxConfidence)
+Sets the minimum confidence, which should initially be used, when trying to generate a
+ specific number of association rules.
+
+Parameters: maxConfidence - The confidence, which should be set, as a Double value. The
+ confidence must be at least 0 and at maximum 1Returns: The builder, this method has been called upon, as an instance of the class Apriori.RuleGeneratorBuilder
+
+
+
+
+
+
+
+
+confidenceDelta
+@NotNull
+public final @NotNull Apriori.RuleGeneratorBuilder <ItemType > confidenceDelta(double confidenceDelta)
+Sets the value, the minimum confidence should be decreased by after each iteration, when
+ trying to generate a specific number of association rules.
+
+Parameters: confidenceDelta - The value, which should be set, as a Double value. The
+ value must be greater than 0 and less than the maximum confidenceReturns: The builder, this method has been called upon, as an instance of the class Apriori.RuleGeneratorBuilder
+
+
+
+
+
+
+
+
+ruleCount
+@NotNull
+public final @NotNull Apriori.RuleGeneratorBuilder <ItemType > ruleCount(int ruleCount)
+Sets the number of association rule, the Apriori algorithm should try to generate.
+
+Parameters: ruleCount - The number of association rules, which should be set, as an Integer value or 0, if the Apriori algorithm should not try to generate
+ a specific number of association rulesReturns: The builder, this method has been called upon, as an instance of the class Apriori.RuleGeneratorBuilder
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+ Apriori
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.Apriori<ItemType>
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, which are processed by the algorithm
+public class Apriori<ItemType extends Item >
+extends java.lang.Object
+An implementation of the Apriori algorithm for mining frequent item sets and (optionally)
+ generating association rules. The algorithm processes a set of transactions, of which each one
+ consists of multiple items.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Nested Class Summary
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Modifier
+Constructor and Description
+
+
+protected Apriori Apriori.Configuration configuration)Creates a new implementation of the Apriori algorithm for mining frequent item sets and
+ (optionally) generating association rules.
+
+
+protected Apriori Apriori.Configuration configuration,
+ @NotNull FrequentItemSetMinerTask <ItemType > frequentItemSetMinerTask,
+ @NotNull AssociationRuleGeneratorTask <ItemType > associationRuleGeneratorTask)Creates a new implementation of the Apriori algorithm for mining frequent item sets and
+ (optionally) generating association rules.
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+Apriori
+protected Apriori(@NotNull
+ @NotNull Apriori.Configuration configuration)
+Creates a new implementation of the Apriori algorithm for mining frequent item sets and
+ (optionally) generating association rules.
+
+Parameters: configuration - The configuration, which should be used by the apriori algorithm, as an
+ instance of the class Apriori.Configuration
+
+
+
+
+
+
+
+Apriori
+protected Apriori(@NotNull
+ @NotNull Apriori.Configuration configuration,
+ @NotNull
+ @NotNull FrequentItemSetMinerTask <ItemType > frequentItemSetMinerTask,
+ @NotNull
+ @NotNull AssociationRuleGeneratorTask <ItemType > associationRuleGeneratorTask)
+Creates a new implementation of the Apriori algorithm for mining frequent item sets and
+ (optionally) generating association rules.
+
+Parameters: configuration - The configuration, which should be used by the apriori
+ algorithm, as an instance of the class Apriori.ConfigurationfrequentItemSetMinerTask - The task, which should be used to find frequent item
+ sets, as an instance of the class FrequentItemSetMinerTaskassociationRuleGeneratorTask - The task, which should be used to generate association
+ rules, as an instance of the class AssociationRuleGeneratorTask
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+getConfiguration
+@NotNull
+public final @NotNull Apriori.Configuration getConfiguration()
+Returns the configuration, which is used by the Apriori algorithm.
+
+Returns: The configuration, which is used by the Apriori algorithm, as an instance of the
+ class Apriori.Configuration
+
+
+
+
+
+
+
+
+execute
+@NotNull
+public final @NotNull Output <ItemType > execute(@NotNull
+ @NotNull java.util.Iterator<Transaction <ItemType >> iterator)
+Executes the Apriori algorithm on a specific set of transactions in order to learn
+ association rules, which specify frequent item sets.
+
+Parameters: iterator - An iterator, which allows to iterate the transactions, as an instance of the
+ type Iterable. The iterable may not be nullReturns: The rule set, which contains the association rules, which have been learned by the
+ algorithm, as an instance of the class RuleSet
+
+
+
+
+
+
+
+
AssociationRule.Comparator
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.AssociationRule.Comparator
+
+
+
+
+
+
+
+All Implemented Interfaces:
+java.util.Comparator<AssociationRule <?>>
+
+
+Enclosing class:
+AssociationRule <ItemType extends Item >
+public static class AssociationRule.Comparator
+extends java.lang.Object
+implements java.util.Comparator<AssociationRule <?>>
+A comparator, which allows to compare the heuristic values of two association rules according
+ to a certain metric or operator.
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+Methods inherited from interface java.util.Comparator
+comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
+
+
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+ AssociationRule
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.AssociationRule<ItemType>
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, the association rule's body and head consist of
+
+All Implemented Interfaces:
+java.io.Serializable, java.lang.Cloneable
+
+public class AssociationRule<ItemType extends Item >
+extends java.lang.Object
+implements java.io.Serializable, java.lang.Cloneable
+An association rule of the form X -> Y, which consists of a body X and a head Y. Both, the
+ body and the head of an association rule consist of one or several items. These item sets must be
+ distinct. An association rule specifies, that if the items, which are contained by its body,
+ occur in a transaction, the items, which are given in its head, do also occur with a certain
+ probability.
+
+Since: 1.0.0
+See Also: Serialized Form
+
+
+
+
+
+
+
+
+
+
+
+Nested Class Summary
+
+Nested Classes
+Modifier and Type
+Class and Description
+
+
+static class AssociationRule.Comparator A comparator, which allows to compare the heuristic values of two association rules according
+ to a certain metric or operator.
+
+
+
+
+
+
+
+
+Constructor Summary
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+finalize, getClass, notify, notifyAll, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+AssociationRule
+public AssociationRule(@NotNull
+ @NotNull ItemSet <ItemType > body,
+ @NotNull
+ @NotNull ItemSet <ItemType > head,
+ double support)
+Creates a new association rule.
+
+Parameters: body - An item set, which contains the items, which are contained by the association
+ rule's body, as an instance of the class ItemSethead - An item set, which contains the items, which are contained by the association
+ rule's head, as an instance of the class ItemSetsupport - The support of the association rule as a Double value. The support
+ must be at least 0 and at maximum 1
+
+
+
+
+
+
+
+
+
Item
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+
+
+
+
+
+
+All Superinterfaces:
+java.lang.Comparable<Item >, java.io.Serializable
+
+public interface Item
+extends java.lang.Comparable<Item >, java.io.Serializable
+Defines the interface, an item, which is part of a transaction, must implement. The Apriori
+ algorithm relies on items to correctly implement the Object.hashCode() and Object.equals(Object) methods to be able to compare items to each other. Furthermore, the
+ interface Comparable must be implemented. This allows to sort items (e.g. by their names)
+ in order to generate candidates in an efficient way, when searching for frequent item sets.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+Methods inherited from interface java.lang.Comparable
+compareTo
+
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+
+ ItemSet
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.ItemSet<ItemType>
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, which are contained by the item set
+
+All Implemented Interfaces:
+java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<ItemSet <ItemType>>, java.lang.Iterable<ItemType>, java.util.Collection<ItemType>, java.util.Set<ItemType>, java.util.SortedSet<ItemType>
+
+
+Direct Known Subclasses:
+TransactionalItemSet
+public class ItemSet<ItemType>
+extends java.lang.Object
+implements java.util.SortedSet<ItemType>, java.lang.Comparable<ItemSet <ItemType>>, java.io.Serializable, java.lang.Cloneable
+An item set, which may contain several items. An item set may not contain duplicates. The
+ contained items are ordered according to the implementation of their Comparable.compareTo(Object) method.
+
+Since: 1.0.0
+See Also: Serialized Form
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+ItemSet Creates an empty item set.
+
+
+ItemSet ItemSet <ItemType > itemSet)Creates a new item set by copying another item set.
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+finalize, getClass, notify, notifyAll, wait, wait, wait
+
+
+
+
+Methods inherited from interface java.util.SortedSet
+spliterator
+
+
+
+
+Methods inherited from interface java.util.Collection
+parallelStream, removeIf, stream
+
+
+
+
+Methods inherited from interface java.lang.Iterable
+forEach
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Metric
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+
+
+
+
+
+All Superinterfaces:
+Operator
+
+All Known Implementing Classes:
+Confidence , Leverage , Lift , Support
+public interface Metric
+extends Operator
+Defines the interface, a class, which allows to measure the "interestingly" of association
+ rules according to a certain metric, must implement.
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Abstract Methods
+Modifier and Type
+Method and Description
+
+
+doublemaxValue Returns the maximum heuristic value of the metric.
+
+
+doubleminValue Returns the minimum heuristic value of the metric.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+ Operator
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+
+
+
+
+
+All Known Subinterfaces:
+Metric
+
+All Known Implementing Classes:
+ArithmeticMean , Confidence , HarmonicMean , Leverage , Lift , Support
+public interface Operator
+Defines the interface, a class, which allows to calculate heuristic values of association rules,
+ must implement. This applies to metrics, which measure the "interestingly" of rules, as well as
+ to meta-heuristics, which average the results of multiple metrics.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+ Output
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.Output<ItemType>
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, which have been processed by the Apriori algorithm
+
+All Implemented Interfaces:
+java.io.Serializable, java.lang.Cloneable
+
+public class Output<ItemType extends Item >
+extends java.lang.Object
+implements java.io.Serializable, java.lang.Cloneable
+An output of the Apriori algorithm.
+
+Since: 1.0.0
+See Also: Serialized Form
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+finalize, getClass, notify, notifyAll, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+Output
+public Output(@NotNull
+ @NotNull Apriori.Configuration configuration,
+ long startTime,
+ long endTime,
+ @NotNull
+ @NotNull FrequentItemSetArraySet <ItemType > frequentItemSets,
+ @Nullable
+ @Nullable RuleSet <ItemType > ruleSet)
+Creates a new output of the Apriori algorithm.
+
+Parameters: configuration - The configuration of the Apriori algorithm as an instance of the
+ class Apriori.ConfigurationstartTime - The time, the Apriori algorithm has been started, in milliseconds as
+ a Long value. The time must be at least 0endTime - The time, the Apriori algorithm has been ended, in milliseconds as a
+ Long value. The time must be at least the start timefrequentItemSets - The frequent item sets, which have been found by the Apriori
+ algorithm as an instance of the type SortedSet or an empty
+ set, if no frequent item sets have been foundruleSet - The rule set, which contains the association rules, which have been
+ generated by the Apriori algorithm, as an instance of the class
+ RuleSet
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getFrequentItemSets
+@NotNull
+public final @NotNull java.util.SortedSet<ItemSet <ItemType >> getFrequentItemSets()
+Returns the frequent item sets, which have been found by the Apriori algorithm.
+
+Returns: The frequent item sets, which have been found by the Apriori algorithm as an instance
+ of the type SortedSet or an empty set, if no frequent item sets have been found
+
+
+
+
+
+
+
+
+getRuleSet
+@Nullable
+public final @Nullable RuleSet <ItemType > getRuleSet()
+Returns the association rules, which have been generated by the Apriori algorithm.
+
+Returns: A rule set, which contains the association rules, which have been generated by the
+ Apriori algorithm, as an instance of the class RuleSet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
RuleSet
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.RuleSet<ItemType>
+
+
+
+
+
+
+
+All Implemented Interfaces:
+java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<AssociationRule <ItemType>>, java.util.Collection<AssociationRule <ItemType>>, java.util.Set<AssociationRule <ItemType>>, java.util.SortedSet<AssociationRule <ItemType>>
+
+public class RuleSet<ItemType extends Item >
+extends java.lang.Object
+implements java.util.SortedSet<AssociationRule <ItemType>>, java.io.Serializable, java.lang.Cloneable
+A rule set, which contains multiple association rules. The rules, which are contained by a rule
+ set, are unordered.
+
+Since: 1.0.0
+See Also: Serialized Form
+
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+Fields
+Modifier and Type
+Field and Description
+
+
+java.util.SortedSet<AssociationRule <ItemType >>rules A sorted set, which contains the rules, the rule set consists of.
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Modifier
+Constructor and Description
+
+
+ RuleSet Creates an empty rule set.
+
+
+protected RuleSet AssociationRule <ItemType >> rules)Creates a new rule set from a sorted set.
+
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+booleanadd AssociationRule <ItemType > rule)
+
+booleanaddAll AssociationRule <ItemType >> c)
+
+voidclear
+
+RuleSet <ItemType >clone
+
+@Nullable java.util.Comparator<? super AssociationRule <ItemType >>comparator
+
+booleancontains
+
+booleancontainsAll
+
+booleanequals
+
+@NotNull RuleSet <ItemType >filter Operator operator,
+ double threshold)Filters all rules, which are contained by the rule set, whose heuristic value according to a
+ specific operator or metric is greater or equal than a specific threshold.
+
+
+@NotNull RuleSet <ItemType >filter Operator operator,
+ double threshold,
+ @NotNull TieBreaker tieBreaker)Filters all rules, which are contained by the rule set, whose heuristic value according to a
+ specific operator or metric is greater or equal than a specific threshold.
+
+
+AssociationRule <ItemType >first
+
+inthashCode
+
+@NotNull java.util.SortedSet<AssociationRule <ItemType >>headSet AssociationRule <ItemType > toElement)
+
+booleanisEmpty
+
+@NotNull java.util.Iterator<AssociationRule <ItemType >>iterator
+
+AssociationRule <ItemType >last
+
+booleanremove
+
+booleanremoveAll
+
+booleanretainAll
+
+intsize
+
+@NotNull RuleSet <ItemType >sort Operator operator)Sorts the rules, which are contained by the rule set, by their heuristic values according to
+ a specific operator or metric in descending order.
+
+
+@NotNull RuleSet <ItemType >sort Operator operator,
+ @NotNull TieBreaker tieBreaker)Sorts the rules, which are contained by the rule set, by their heuristic values according to
+ a specific operator or metric in descending order.
+
+
+@NotNull java.util.SortedSet<AssociationRule <ItemType >>subSet AssociationRule <ItemType > fromElement,
+ AssociationRule <ItemType > toElement)
+
+@NotNull java.util.SortedSet<AssociationRule <ItemType >>tailSet AssociationRule <ItemType > fromElement)
+
+@NotNull java.lang.Object[]toArray
+
+<T> T[]toArray
+
+java.lang.StringtoString
+
+
+
+
+
+Methods inherited from class java.lang.Object
+finalize, getClass, notify, notifyAll, wait, wait, wait
+
+
+
+
+Methods inherited from interface java.util.SortedSet
+spliterator
+
+
+
+
+Methods inherited from interface java.util.Collection
+parallelStream, removeIf, stream
+
+
+
+
+Methods inherited from interface java.lang.Iterable
+forEach
+
+
+
+
+
+
+
+
+
+
+
+
+Field Detail
+
+
+
+
+
+rules
+public final java.util.SortedSet<AssociationRule <ItemType extends Item >> rules
+A sorted set, which contains the rules, the rule set consists of.
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+sort
+@NotNull
+public final @NotNull RuleSet <ItemType > sort(@NotNull
+ @NotNull Operator operator)
+Sorts the rules, which are contained by the rule set, by their heuristic values according to
+ a specific operator or metric in descending order. By default, no tie-breaking strategy is
+ used.
+
+Parameters: operator - The operator, which should be used to calculate the heuristic values of the
+ rules, as an instance of the type OperatorReturns: A new rule set, which contains the sorted rules, as an instance of the class RuleSet
+
+
+
+
+
+
+
+
+sort
+@NotNull
+public final @NotNull RuleSet <ItemType > sort(@NotNull
+ @NotNull Operator operator,
+ @NotNull
+ @NotNull TieBreaker tieBreaker)
+Sorts the rules, which are contained by the rule set, by their heuristic values according to
+ a specific operator or metric in descending order.
+
+Parameters: operator - The operator, which should be used to calculate the heuristic values of the
+ rules, as an instance of the type OperatortieBreaker - The tie-breaking strategy, which should be used, as an instance of the
+ class TieBreakerReturns: A new rule set, which contains the sorted rules, as an instance of the class RuleSet
+
+
+
+
+
+
+
+
+filter
+@NotNull
+public final @NotNull RuleSet <ItemType > filter(@NotNull
+ @NotNull Operator operator,
+ double threshold)
+Filters all rules, which are contained by the rule set, whose heuristic value according to a
+ specific operator or metric is greater or equal than a specific threshold. By default, no
+ tie-breaking strategy is used.
+
+Parameters: operator - The operator, which should be used to calculate the heuristic value of the
+ rules, as an instance of the type Metricthreshold - The threshold, which must be reached by the filtered rules, as a Double value. The threshold must be greater than 0Returns: A new rule set, which contains the rules, which reach the given threshold, as an
+ instance of the class RuleSet
+
+
+
+
+
+
+
+
+filter
+@NotNull
+public final @NotNull RuleSet <ItemType > filter(@NotNull
+ @NotNull Operator operator,
+ double threshold,
+ @NotNull
+ @NotNull TieBreaker tieBreaker)
+Filters all rules, which are contained by the rule set, whose heuristic value according to a
+ specific operator or metric is greater or equal than a specific threshold.
+
+Parameters: operator - The operator, which should be used to calculate the heuristic value of the
+ rules, as an instance of the type Metricthreshold - The threshold, which must be reached by the filtered rules, as a Double value. The threshold must be greater than 0tieBreaker - The tie-breaking strategy, which should be used, as an instance of the
+ class TieBreakerReturns: A new rule set, which contains the rules, which reach the given threshold, as an
+ instance of the class RuleSet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TieBreaker
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.TieBreaker
+
+
+
+
+
+
+public class TieBreaker
+extends java.lang.Object
+A tie-breaking strategy, which allows to decide, which one of two association rules is considered
+ to be more "interestingly", if their heuristic values are equal.
+
+Since: 1.1.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+TieBreaker Creates a new tie-breaking strategy.
+
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+@NotNull TieBreaker byOperator Operator operator)Adds an additional criteria to the current tie-breaking strategy, which performs tie-breaking
+ according to a specific operator.
+
+
+@NotNull TieBreaker custom AssociationRule ,AssociationRule ,java.lang.Integer> function)Adds an additional custom criteria to the current tie-breaking strategy.
+
+
+@NotNull TieBreaker preferComplex Adds an additional criteria to the current tie-breaking strategy, which prefers complex
+ association rules over simple ones.
+
+
+@NotNull TieBreaker preferComplexBody Adds an additional criteria to the current tie-breaking strategy, which prefers complex
+ bodies over simple ones.
+
+
+@NotNull TieBreaker preferComplexHead Adds an additional criteria to the current tie-breaking strategy, which prefers complex heads
+ over simple ones.
+
+
+@NotNull TieBreaker preferSimple Adds an additional criteria to the current tie-breaking strategy, which prefers simple
+ association rules over complex ones.
+
+
+@NotNull TieBreaker preferSimpleBody Adds an additional criteria to the current tie-breaking strategy, which prefers simple bodies
+ over simple ones.
+
+
+@NotNull TieBreaker preferSimpleHead Adds an additional criteria to the current tie-breaking strategy, which prefers simple heads
+ over simple ones.
+
+
+inttieBreak AssociationRule <?> rule1,
+ AssociationRule <?> rule2)Decides, which one of two association rules is considered to be more "interestingly"
+ according to the tie-breaking strategy.
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+byOperator
+@NotNull
+public final @NotNull TieBreaker byOperator(@NotNull
+ @NotNull Operator operator)
+Adds an additional criteria to the current tie-breaking strategy, which performs tie-breaking
+ according to a specific operator. I.e., if an association rule reaches a greater performance
+ according to the given operator, it is considered to be more "interestingly".
+
+Parameters: operator - The operator, which should be used for tie-breaking, as an instance of the
+ type OperatorReturns: The tie-breaking strategy, including the added criteria, as an instance of the class
+ TieBreaker
+
+
+
+
+
+
+
+
+preferSimple
+@NotNull
+public final @NotNull TieBreaker preferSimple()
+Adds an additional criteria to the current tie-breaking strategy, which prefers simple
+ association rules over complex ones. I.e., if an association rule contains less items than
+ its counterpart in its body and head, it is considered to be more "interestingly".
+
+Returns: The tie-breaking strategy, including the added criteria, as an instance of the class
+ TieBreaker
+
+
+
+
+
+
+
+
+preferComplex
+@NotNull
+public final @NotNull TieBreaker preferComplex()
+Adds an additional criteria to the current tie-breaking strategy, which prefers complex
+ association rules over simple ones. I.e., if an association rule contains more items than its
+ counterpart in its body and head, it is considered to be more "interestingly".
+
+Returns: The tie-breaking strategy, including the added criteria, as an instance of the class
+ TieBreaker
+
+
+
+
+
+
+
+
+preferSimpleBody
+@NotNull
+public final @NotNull TieBreaker preferSimpleBody()
+Adds an additional criteria to the current tie-breaking strategy, which prefers simple bodies
+ over simple ones. I.e., if an association rule contains less items than its counterpart in
+ its body, it is considered to be more "interestingly".
+
+Returns: The tie-breaking strategy, including the added criteria, as an instance of the class
+ TieBreaker
+
+
+
+
+
+
+
+
+preferComplexBody
+@NotNull
+public final @NotNull TieBreaker preferComplexBody()
+Adds an additional criteria to the current tie-breaking strategy, which prefers complex
+ bodies over simple ones. I.e., if an association rule contains more items than its
+ counterpart in its body, it is considered to be more "interestingly".
+
+Returns: The tie-breaking strategy, including the added criteria, as an instance of the class
+ TieBreaker
+
+
+
+
+
+
+
+
+preferSimpleHead
+@NotNull
+public final @NotNull TieBreaker preferSimpleHead()
+Adds an additional criteria to the current tie-breaking strategy, which prefers simple heads
+ over simple ones. I.e., if an association rule contains less items than its counterpart in
+ its head, it is considered to be more "interestingly".
+
+Returns: The tie-breaking strategy, including the added criteria, as an instance of the class
+ TieBreaker
+
+
+
+
+
+
+
+
+preferComplexHead
+@NotNull
+public final @NotNull TieBreaker preferComplexHead()
+Adds an additional criteria to the current tie-breaking strategy, which prefers complex heads
+ over simple ones. I.e., if an association rule contains more items than its counterpart in
+ its head, it is considered to be more "interestingly".
+
+Returns: The tie-breaking strategy, including the added criteria, as an instance of the class
+ TieBreaker
+
+
+
+
+
+
+
+
+custom
+@NotNull
+public final @NotNull TieBreaker custom(@NotNull
+ @NotNull java.util.function.BiFunction<AssociationRule ,AssociationRule ,java.lang.Integer> function)
+Adds an additional custom criteria to the current tie-breaking strategy. The given
+ tie-breaking function must return 1, if the first association rule should be preferred, -1,
+ if the second one should be preferred or 0, if no decision could be made.
+
+Parameters: function - The custom tie-breaking function as an instance of the type BiFunction. The tie-breaking function may not be nullReturns: The tie-breaking strategy, including the added criteria, as an instance of the class
+ TieBreaker
+
+
+
+
+
+
+
+
+tieBreak
+public final int tieBreak(AssociationRule <?> rule1,
+ AssociationRule <?> rule2)
+Decides, which one of two association rules is considered to be more "interestingly"
+ according to the tie-breaking strategy.
+
+Parameters: rule1 - The first association rule as an instance of the class AssociationRulerule2 - The second association rule as an instance of the class AssociationRuleReturns: The decision of the tie-breaking strategy as an Integer value. A value of 1
+ means, that the first association rule is preferred, -1 means that the second association
+ rule is preferred and 0 means that no decision could be made
+
+
+
+
+
+
+
+
Transaction
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, the transaction consists of
+
+All Superinterfaces:
+java.lang.Iterable<ItemType>
+
+public interface Transaction<ItemType extends Item >
+extends java.lang.Iterable<ItemType>
+Defines the interface, a transaction, which consists of multiple items, must implement. The
+ Apriori algorithm processes a set of transactions in order to find frequent item sets.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+Methods inherited from interface java.lang.Iterable
+forEach, iterator, spliterator
+
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+
+ FrequentItemSetArraySet
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.util.datastructure.SortedArraySet<ItemSet <ItemType>>
+
+
+de.mrapp.apriori.datastructure.FrequentItemSetArraySet<ItemType>
+
+
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, which are contained by the frequent item sets
+
+All Implemented Interfaces:
+java.lang.Cloneable, java.lang.Iterable<ItemSet <ItemType>>, java.util.Collection<ItemSet <ItemType>>, java.util.Set<ItemSet <ItemType>>, java.util.SortedSet<ItemSet <ItemType>>
+
+public class FrequentItemSetArraySet<ItemType extends Item >
+extends de.mrapp.util.datastructure.SortedArraySet<ItemSet <ItemType>>
+implements java.lang.Cloneable
+A tree set, which contains frequent item sets.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+FrequentItemSetArraySet ItemSet <ItemType >> comparator)Creates a new tree set, which contains frequent item sets.
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class de.mrapp.util.datastructure.SortedArraySet
+add, addAll, clear, comparator, contains, containsAll, equals, first, hashCode, headSet, isEmpty, iterator, last, remove, removeAll, retainAll, size, subSet, tailSet, toArray, toArray, toString
+
+
+
+
+Methods inherited from class java.lang.Object
+finalize, getClass, notify, notifyAll, wait, wait, wait
+
+
+
+
+Methods inherited from interface java.util.SortedSet
+spliterator
+
+
+
+
+Methods inherited from interface java.util.Collection
+parallelStream, removeIf, stream
+
+
+
+
+Methods inherited from interface java.lang.Iterable
+forEach
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+FrequentItemSetArraySet
+public FrequentItemSetArraySet(@Nullable
+ @Nullable java.util.Comparator<? super ItemSet <ItemType >> comparator)
+Creates a new tree set, which contains frequent item sets.
+
+Parameters: comparator - The comparator, which should be used to sort the set, as as an instance of
+ the type Comparator or null, if the natural ordering should be
+ used
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+formatFrequentItemSets
+@NotNull
+public static <T> @NotNull java.lang.String formatFrequentItemSets(@NotNull
+ @NotNull java.util.Collection<? extends ItemSet <T>> frequentItemSets)
+Creates and returns a string, which contains information about the frequent item set, which
+ have been found by the algorithm.
+
+Type Parameters: T - The type of the items, which are contained by the item setsParameters: frequentItemSets - A collection, which contains the frequent item sets, as an instance
+ of the type Collection or null, if no frequent item sets have
+ been found by the algorithmReturns: A string, which contains information about the given frequent item sets, as a String. The string may neither be null, nor empty
+
+
+
+
+
+
+
+
+
+
+
+
TransactionalItemSet
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class de.mrapp.apriori.ItemSet
+add , addAll , clear , clone , comparator , compareTo , contains , containsAll , equals , first , getSupport , hashCode , headSet , isEmpty , iterator , last , remove , removeAll , retainAll , setSupport , size , subSet , tailSet , toArray , toArray , toString
+
+
+
+
+Methods inherited from class java.lang.Object
+finalize, getClass, notify, notifyAll, wait, wait, wait
+
+
+
+
+Methods inherited from interface java.util.SortedSet
+spliterator
+
+
+
+
+Methods inherited from interface java.util.Collection
+parallelStream, removeIf, stream
+
+
+
+
+Methods inherited from interface java.lang.Iterable
+forEach
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+getTransactions
+@NotNull
+public final @NotNull java.util.Map<java.lang.Integer,Transaction <ItemType >> getTransactions()
+Returns the transactions, the item set occurs in.
+
+Returns: A map, which contains the transactions, the item set occurs in, as an instance of the
+ type Map. The map may not be null
+
+
+
+
+
+
+
+
+setTransactions
+public final void setTransactions(@NotNull
+ @NotNull java.util.Map<java.lang.Integer,Transaction <ItemType >> transactions)
+Sets the transactions, the item set occurs in.
+
+Parameters: transactions - A map, which contains the transactions, which should be set, as an
+ instance of the type Map. The map may not be null
+
+
+
+
+
+
+
de.mrapp.apriori.datastructure
+de.mrapp.apriori.datastructure
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Class Summary
+Class
+Description
+
+
+
+FrequentItemSetArraySet <ItemType extends Item >
+A tree set, which contains frequent item sets.
+
+
+
+TransactionalItemSet <ItemType extends Item >
+An extension of the class
ItemSet, which allows to store the transactions, the item
+ set occurs in.
+
+
+
+
+
+
de.mrapp.apriori.datastructure Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
Class Hierarchy
+
+java.lang.Object
+
+de.mrapp.apriori.ItemSet
+de.mrapp.util.datastructure.SortedArraySet<T> (implements java.util.SortedSet<E>)
+
+
+
+
+
+
Confidence
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.metrics.Confidence
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Metric , Operator
+public class Confidence
+extends java.lang.Object
+implements Metric
+A metric, which measures the confidence of an association rule. By definition, confidence
+ measures the percentage of transactions for which the head of the rule is true, among all
+ transaction for which the body is true.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+Confidence
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+doubleevaluate AssociationRule <?> rule)Calculates the heuristic value of a specific association rule.
+
+
+doublemaxValue Returns the maximum heuristic value of the metric.
+
+
+doubleminValue Returns the minimum heuristic value of the metric.
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+Confidence
+public Confidence()
+
+
+
+
+
+
+
+
+
Leverage
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.metrics.Leverage
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Metric , Operator
+public class Leverage
+extends java.lang.Object
+implements Metric
+A metric, which measures the leverage of an association rule. By definition, leverage is the
+ difference between the rule's support and the expected support for the body and head, if they
+ were independent. Furthermore, the leverage of a rule is a lower bound for its support. As a
+ consequence, in contrast to optimizing confidence or lift, optimizing the leverage of a rule
+ guarantees a certain minimum support.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+Leverage
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+doubleevaluate AssociationRule <?> rule)Calculates the heuristic value of a specific association rule.
+
+
+doublemaxValue Returns the maximum heuristic value of the metric.
+
+
+doubleminValue Returns the minimum heuristic value of the metric.
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+Leverage
+public Leverage()
+
+
+
+
+
+
+
+
+
Lift
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.metrics.Lift
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Metric , Operator
+public class Lift
+extends java.lang.Object
+implements Metric
+A metric, which measures the lift of an association rule. By definition, lift is calculated as
+ the ratio of the rule's confidence over a priori expectation for the rule's head.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+Lift
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+doubleevaluate AssociationRule <?> rule)Calculates the heuristic value of a specific association rule.
+
+
+doublemaxValue Returns the maximum heuristic value of the metric.
+
+
+doubleminValue Returns the minimum heuristic value of the metric.
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+Lift
+public Lift()
+
+
+
+
+
+
+
+
+
Support
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.metrics.Support
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Metric , Operator
+public class Support
+extends java.lang.Object
+implements Metric
+A metric, which measures the support of an association rule. By definition, support measures the
+ percentage of transactions for which the body and head of the rule is true.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+Support
+
+
+
+
+
+
+
+Method Summary
+
+All Methods Instance Methods Concrete Methods
+Modifier and Type
+Method and Description
+
+
+doubleevaluate AssociationRule <?> rule)Calculates the heuristic value of a specific association rule.
+
+
+doublemaxValue Returns the maximum heuristic value of the metric.
+
+
+doubleminValue Returns the minimum heuristic value of the metric.
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+Support
+public Support()
+
+
+
+
+
+
+
+
+
de.mrapp.apriori.metrics
+de.mrapp.apriori.metrics
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Class Summary
+Class
+Description
+
+
+
+Confidence
+A metric, which measures the confidence of an association rule.
+
+
+
+Leverage
+A metric, which measures the leverage of an association rule.
+
+
+
+Lift
+A metric, which measures the lift of an association rule.
+
+
+
+Support
+A metric, which measures the support of an association rule.
+
+
+
+
+
+
+
de.mrapp.apriori.metrics Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
Class Hierarchy
+
+java.lang.Object
+
+de.mrapp.apriori.metrics.Confidence Metric )
+de.mrapp.apriori.metrics.Leverage Metric )
+de.mrapp.apriori.metrics.Lift Metric )
+de.mrapp.apriori.metrics.Support Metric )
+
+
+
+
AssociationRuleGenerator
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, which are processed by the algorithm
+
+All Known Implementing Classes:
+AssociationRuleGeneratorModule
+public interface AssociationRuleGenerator<ItemType extends Item >
+Defines the interface, a class, which allows to generate association rules, must implement.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+generateAssociationRules
+@NotNull
+@NotNull RuleSet <ItemType > generateAssociationRules(@NotNull
+ @NotNull java.util.Map<java.lang.Integer,? extends ItemSet <ItemType >> frequentItemSets,
+ double minConfidence)
+Generates association rules from frequent item sets.
+
+Parameters: frequentItemSets - A map, which contains all available frequent item sets, as an
+ instance of the type Map or an empty map, if no frequent item
+ sets are available. The map must store the frequent item sets as
+ values and their hash codes as the corresponding keysminConfidence - The minimum confidence, which must at least be reached by association
+ rules, as a Double value. The confidence must be at least 0
+ and at maximum 1Returns: A rule set, which contains the association rules, which have been generated, as an
+ instance of the class RuleSet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+ AssociationRuleGeneratorModule
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.modules.AssociationRuleGeneratorModule<ItemType>
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, which are processed by the algorithm
+
+All Implemented Interfaces:
+AssociationRuleGenerator <ItemType>
+public class AssociationRuleGeneratorModule<ItemType extends Item >
+extends java.lang.Object
+implements AssociationRuleGenerator <ItemType>
+A module, which allows to generate association rules from frequent item sets. An association rule
+ specifies, that if certain items occur in a transaction, other items do also occur with a certain
+ probability. Among all possible association rules, which can be generated from the frequent item
+ sets, only those, whose "interestingly" according to the confidence metric is greater or equal
+ than a specific threshold, are taken into account.
+
+ In order to prune the search for association rules, the algorithm exploits the anti-monotonicity
+ property of the confidence metric, which states, that the confidence of the rule A,B -> C is
+ an upper bound to the confidence of a rule A -> B,C. Consequently, the algorithm starts by
+ generating rules, which contain a single item in there heads. Based on those rules, which reach
+ the minimum confidence, additional rules are created by moving items from their bodies to the
+ heads. For each rule said process is continued until the minimum threshold cannot be reached
+ anymore.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+generateAssociationRules
+@NotNull
+public final @NotNull RuleSet <ItemType > generateAssociationRules(@NotNull
+ @NotNull java.util.Map<java.lang.Integer,? extends ItemSet <ItemType >> frequentItemSets,
+ double minConfidence)
+
+Generates association rules from frequent item sets.
+
+Specified by: generateAssociationRules AssociationRuleGenerator <ItemType extends Item >Parameters: frequentItemSets - A map, which contains all available frequent item sets, as an
+ instance of the type Map or an empty map, if no frequent item
+ sets are available. The map must store the frequent item sets as
+ values and their hash codes as the corresponding keysminConfidence - The minimum confidence, which must at least be reached by association
+ rules, as a Double value. The confidence must be at least 0
+ and at maximum 1Returns: A rule set, which contains the association rules, which have been generated, as an
+ instance of the class RuleSet
+
+
+
+
+
+
+
+
FrequentItemSetMiner
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, which are processed by the algorithm
+
+All Known Implementing Classes:
+FrequentItemSetMinerModule
+public interface FrequentItemSetMiner<ItemType extends Item >
+Defines the interface, a class, which allows to find frequent item sets, must implement.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+findFrequentItemSets
+@NotNull
+@NotNull java.util.Map<java.lang.Integer,TransactionalItemSet <ItemType >> findFrequentItemSets(@NotNull
+ @NotNull java.util.Iterator<Transaction <ItemType >> iterator,
+ double minSupport)
+Searches for frequent item sets.
+
+Parameters: iterator - An iterator, which allows to iterate the transactions of the data set,
+ which should be processed by the algorithm, as an instance of the type
+ Iterator. The iterator may not be nullminSupport - The minimum support, which must at least be reached by an item set to be
+ considered frequent, as a Double value. The support must be at
+ least 0 and at maximum 1Returns: A map, which contains the frequent item sets, which have been found, as an instance
+ of the type Map or an empty map, if no frequent item sets have been found. The map
+ stores instances of the class ItemSet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Summary:
+Nested |
+Field |
+Constr |
+Method
+
+Detail:
+Field |
+Constr |
+Method
+
+
+
+ FrequentItemSetMinerModule
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.modules.FrequentItemSetMinerModule<ItemType>
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, which are processed by the algorithm
+
+All Implemented Interfaces:
+FrequentItemSetMiner <ItemType>
+public class FrequentItemSetMinerModule<ItemType extends Item >
+extends java.lang.Object
+implements FrequentItemSetMiner <ItemType>
+A module, which allows to find all frequent item sets, which occur in a data set. The data set
+ must contain multiple transactions of which each one consists of multiple items. Item sets are
+ considered frequent, if their support is greater or equal than a specific threshold.
+
+ In order to search for frequent item sets efficiently, the algorithm exploits the
+ anti-monotonicity property of the support metric, which states, that an item set can only be
+ frequent, if all of its subsets are frequent as well. The other way around, the supersets of an
+ infrequent item set are also infrequent. Furthermore, the items must be sortable (e.g. by their
+ names) in order to generate possible candidates in an efficient way.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+findFrequentItemSets
+@NotNull
+public final @NotNull java.util.Map<java.lang.Integer,TransactionalItemSet <ItemType >> findFrequentItemSets(@NotNull
+ @NotNull java.util.Iterator<Transaction <ItemType >> iterator,
+ double minSupport)
+
+Searches for frequent item sets.
+
+Specified by: findFrequentItemSets FrequentItemSetMiner <ItemType extends Item >Parameters: iterator - An iterator, which allows to iterate the transactions of the data set,
+ which should be processed by the algorithm, as an instance of the type
+ Iterator. The iterator may not be nullminSupport - The minimum support, which must at least be reached by an item set to be
+ considered frequent, as a Double value. The support must be at
+ least 0 and at maximum 1Returns: A map, which contains the frequent item sets, which have been found, as an instance
+ of the type Map or an empty map, if no frequent item sets have been found. The map
+ stores instances of the class ItemSet
+
+
+
+
+
+
+
+
de.mrapp.apriori.modules
+
+
Interfaces
+
+
Classes
+
+
de.mrapp.apriori.modules
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Interface Summary
+Interface
+Description
+
+
+
+AssociationRuleGenerator <ItemType extends Item >
+Defines the interface, a class, which allows to generate association rules, must implement.
+
+
+
+FrequentItemSetMiner <ItemType extends Item >
+Defines the interface, a class, which allows to find frequent item sets, must implement.
+
+
+
+
+
+
+
+Class Summary
+Class
+Description
+
+
+
+AssociationRuleGeneratorModule <ItemType extends Item >
+A module, which allows to generate association rules from frequent item sets.
+
+
+
+FrequentItemSetMinerModule <ItemType extends Item >
+A module, which allows to find all frequent item sets, which occur in a data set.
+
+
+
+
+
+
+
de.mrapp.apriori.modules Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
Class Hierarchy
+
+
Interface Hierarchy
+
+
ArithmeticMean
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.operators.ArithmeticMean
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Operator
+public class ArithmeticMean
+extends java.lang.Object
+implements Operator
+An operator, which allows to average the heuristic values, which are calculated by applying
+ multiple metrics to a rule, according to the arithmetic mean operation.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+ArithmeticMean Creates a new arithmetic mean operator.
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+
+
+
+
+add
+@NotNull
+public final @NotNull ArithmeticMean add(@NotNull
+ @NotNull Metric metric,
+ double weight)
+Adds a new metric to the arithmetic mean operator.
+
+Parameters: metric - The metric, which should be added, as an instance of the type Metricweight - The weight of the metric, which should be added, as a Double value. The
+ weight must be greater than 0Returns: The arithmetic mean operator, this method has been called upon, as an instance of the
+ class ArithmeticMean
+
+
+
+
+
+
+
+
+
+
+
+
HarmonicMean
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.operators.HarmonicMean
+
+
+
+
+
+
+
+All Implemented Interfaces:
+Operator
+public class HarmonicMean
+extends java.lang.Object
+implements Operator
+An operator, which allows to average the heuristic values, which are calculated by applying
+ multiple metrics to a rule, according to the harmonic mean operation.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+HarmonicMean Creates a new harmonic mean operator.
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+
+
+
+
+add
+@NotNull
+public final @NotNull HarmonicMean add(@NotNull
+ @NotNull Metric metric,
+ double weight)
+Adds a new metric to the harmonic mean operator.
+
+Parameters: metric - The metric, which should be added, as an instance of the type Metricweight - The weight of the metric, which should be added, as a Double value. The
+ weight must be greater than 0Returns: The harmonic mean operator, this method has been called upon, as an instance of the
+ class HarmonicMean
+
+
+
+
+
+
+
+
+
+
+
+
de.mrapp.apriori.operators
+de.mrapp.apriori.operators
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Class Summary
+Class
+Description
+
+
+
+ArithmeticMean
+An operator, which allows to average the heuristic values, which are calculated by applying
+ multiple metrics to a rule, according to the arithmetic mean operation.
+
+
+
+HarmonicMean
+An operator, which allows to average the heuristic values, which are calculated by applying
+ multiple metrics to a rule, according to the harmonic mean operation.
+
+
+
+
+
+
+
de.mrapp.apriori.operators Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/javadoc/de/mrapp/apriori/package-frame.html b/doc/javadoc/de/mrapp/apriori/package-frame.html
new file mode 100644
index 0000000..01d2aaa
--- /dev/null
+++ b/doc/javadoc/de/mrapp/apriori/package-frame.html
@@ -0,0 +1,36 @@
+
+
+
+
+
+de.mrapp.apriori
+
+
Interfaces
+
+
Classes
+
+
de.mrapp.apriori
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Interface Summary
+Interface
+Description
+
+
+
+Item
+Defines the interface, an item, which is part of a transaction, must implement.
+
+
+
+Metric
+Defines the interface, a class, which allows to measure the "interestingly" of association
+ rules according to a certain metric, must implement.
+
+
+
+Operator
+Defines the interface, a class, which allows to calculate heuristic values of association rules,
+ must implement.
+
+
+
+Transaction <ItemType extends Item >
+Defines the interface, a transaction, which consists of multiple items, must implement.
+
+
+
+
+
+
+
+Class Summary
+Class
+Description
+
+
+
+Apriori <ItemType extends Item >
+An implementation of the Apriori algorithm for mining frequent item sets and (optionally)
+ generating association rules.
+
+
+
+Apriori.Builder <ItemType extends Item >
+A builder, which allows to configure and create instances of the class
Apriori.
+
+
+Apriori.Configuration
+An configuration of the Apriori algorithm.
+
+
+
+Apriori.RuleGeneratorBuilder <ItemType extends Item >
+A builder, which allows to configure and create instances of the class
Apriori, which
+ are configured to generate association rules.
+
+
+AssociationRule <ItemType extends Item >
+An association rule of the form X -> Y, which consists of a body X and a head Y.
+
+
+
+AssociationRule.Comparator
+A comparator, which allows to compare the heuristic values of two association rules according
+ to a certain metric or operator.
+
+
+
+ItemSet <ItemType>
+An item set, which may contain several items.
+
+
+
+Output <ItemType extends Item >
+An output of the Apriori algorithm.
+
+
+
+RuleSet <ItemType extends Item >
+A rule set, which contains multiple association rules.
+
+
+
+TieBreaker
+A tie-breaking strategy, which allows to decide, which one of two association rules is considered
+ to be more "interestingly", if their heuristic values are equal.
+
+
+
+
+
+
+
de.mrapp.apriori Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
Class Hierarchy
+
+java.lang.Object
+
+de.mrapp.apriori.Apriori
+de.mrapp.apriori.Apriori.Builder
+de.mrapp.apriori.Apriori.Configuration
+de.mrapp.apriori.Apriori.RuleGeneratorBuilder
+de.mrapp.apriori.AssociationRule
+de.mrapp.apriori.AssociationRule.Comparator
+de.mrapp.apriori.ItemSet
+de.mrapp.apriori.Output
+de.mrapp.apriori.RuleSet
+de.mrapp.apriori.TieBreaker
+
+
+
+
Interface Hierarchy
+
+java.lang.Comparable<T>
+
+de.mrapp.apriori.Item
+
+
+java.lang.Iterable<T>
+
+
+de.mrapp.apriori.Operator
+java.io.Serializable
+
+de.mrapp.apriori.Item
+
+
+
+
AbstractTask
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+de.mrapp.apriori.tasks.AbstractTask<ItemType>
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, which are processed by the algorithm
+
+Direct Known Subclasses:
+AssociationRuleGeneratorTask , FrequentItemSetMinerTask
+public abstract class AbstractTask<ItemType extends Item >
+extends java.lang.Object
+An abstract base class for all tasks, which execute a module multiple times in order to
+ obtain the results, which are requested according to a specific configuration.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+Constructors
+Constructor and Description
+
+
+AbstractTask Apriori.Configuration configuration)Creates a new task, which executes a module multiple times in order to obtain the results,
+ which are requested according to a specific configuration.
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+AbstractTask
+public AbstractTask(@NotNull
+ @NotNull Apriori.Configuration configuration)
+Creates a new task, which executes a module multiple times in order to obtain the results,
+ which are requested according to a specific configuration.
+
+Parameters: configuration - The configuration, which should be used by the task, as an instance of
+ the class Apriori.Configuration
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+getConfiguration
+@NotNull
+protected final @NotNull Apriori.Configuration getConfiguration()
+Returns the configuration, which is used by the task.
+
+Returns: The configuration, which is used by the task, as an instance of the class Apriori.Configuration
+
+
+
+
+
+
+
+
AssociationRuleGeneratorTask
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, which are processed by the algorithm
+public class AssociationRuleGeneratorTask<ItemType extends Item >
+extends AbstractTask <ItemType>
+A task, which tries to generate a specific number of association rules.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+AssociationRuleGeneratorTask
+public AssociationRuleGeneratorTask(@NotNull
+ @NotNull Apriori.Configuration configuration)
+Creates a new task, which tries to generate a specific number of association rules.
+
+Parameters: configuration - The configuration, which should be used by the task, as an instance of
+ the class Apriori.Configuration
+
+
+
+
+
+
+
+AssociationRuleGeneratorTask
+public AssociationRuleGeneratorTask(@NotNull
+ @NotNull Apriori.Configuration configuration,
+ @NotNull
+ @NotNull AssociationRuleGenerator <ItemType > associationRuleGenerator)
+Creates a new task, which tries to generate a specific number of association rules.
+
+Parameters: configuration - The configuration, which should be used by the task, as an
+ instance of the class Apriori.ConfigurationassociationRuleGenerator - The association rule generator, which should be used by the
+ task, as an instance of the type AssociationRuleGenerator
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+generateAssociationRules
+@NotNull
+public final @NotNull RuleSet <ItemType > generateAssociationRules(@NotNull
+ @NotNull java.util.Map<java.lang.Integer,? extends ItemSet <ItemType >> frequentItemSets)
+Tries to generate a specific number of association rules from frequent item sets.
+
+Parameters: frequentItemSets - A map, which contains all available frequent item sets, as an
+ instance of the type Map or an empty map, if no frequent item
+ sets are available. The map must store the frequent item sets as
+ values and their hash codes as the corresponding keysReturns: A rule set, which contains the association rules, which have been generated, as an
+ instance of the class RuleSet
+
+
+
+
+
+
+
+
FrequentItemSetMinerTask
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+java.lang.Object
+
+
+
+
+
+
+
+
+Type Parameters: ItemType - The type of the items, which are processed by the algorithm
+public class FrequentItemSetMinerTask<ItemType extends Item >
+extends AbstractTask <ItemType>
+A task, which tries to find a specific number of frequent item sets.
+
+Since: 1.0.0
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+
+
+
+
+
+
+Method Summary
+
+
+
+
+
+
+Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+
+FrequentItemSetMinerTask
+public FrequentItemSetMinerTask(@NotNull
+ @NotNull Apriori.Configuration configuration)
+Creates a new task, which tries to find a specific number of frequent item sets.
+
+Parameters: configuration - The configuration, which is used by the taks, as an instance of the
+ class Apriori.Configuration
+
+
+
+
+
+
+
+FrequentItemSetMinerTask
+public FrequentItemSetMinerTask(@NotNull
+ @NotNull Apriori.Configuration configuration,
+ @NotNull
+ @NotNull FrequentItemSetMiner <ItemType > frequentItemSetMiner)
+Creates a new task, which tries to find a specific number of frequent item sets.
+
+Parameters: configuration - The configuration, which is used by the taks, as an instance of
+ the class Apriori.ConfigurationfrequentItemSetMiner - The frequent item set miner, which should be used by the task, as
+ an instance of the class FrequentItemSetMiner
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+
+findFrequentItemSets
+@NotNull
+public final @NotNull java.util.Map<java.lang.Integer,TransactionalItemSet <ItemType >> findFrequentItemSets(@NotNull
+ @NotNull java.util.Iterator<Transaction <ItemType >> iterator)
+Tries to find a specific number of frequent item sets.
+
+Parameters: iterator - An iterator, which allows to iterate the transactions of the data set, which
+ should be processed by the algorithm, as an instance of the type Iterator. The iterator may not be nullReturns: A map, which contains the frequent item sets, which have been found, as an instance
+ of the type Map or an empty map, if no frequent item sets have been found. The map
+ stores instances of the class ItemSet
+
+
+
+
+
+
+
+
de.mrapp.apriori.tasks
+de.mrapp.apriori.tasks
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+Class Summary
+Class
+Description
+
+
+
+AbstractTask <ItemType extends Item >
+An abstract base class for all tasks, which execute a module multiple times in order to
+ obtain the results, which are requested according to a specific configuration.
+
+
+
+AssociationRuleGeneratorTask <ItemType extends Item >
+A task, which tries to generate a specific number of association rules.
+
+
+
+FrequentItemSetMinerTask <ItemType extends Item >
+A task, which tries to find a specific number of frequent item sets.
+
+
+
+
+
+
+
de.mrapp.apriori.tasks Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/javadoc/deprecated-list.html b/doc/javadoc/deprecated-list.html
new file mode 100644
index 0000000..6122c3d
--- /dev/null
+++ b/doc/javadoc/deprecated-list.html
@@ -0,0 +1,122 @@
+
+
+
+
+
+Deprecated List
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/javadoc/help-doc.html b/doc/javadoc/help-doc.html
new file mode 100644
index 0000000..17c5928
--- /dev/null
+++ b/doc/javadoc/help-doc.html
@@ -0,0 +1,223 @@
+
+
+
+
+
+API Help
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+Overview
+The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+
+
+Package
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+
+Interfaces (italic)
+Classes
+Enums
+Exceptions
+Errors
+Annotation Types
+
+
+
+Class/Interface
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
+Class inheritance diagram
+Direct Subclasses
+All Known Subinterfaces
+All Known Implementing Classes
+Class/interface declaration
+Class/interface description
+
+
+Nested Class Summary
+Field Summary
+Constructor Summary
+Method Summary
+
+
+Field Detail
+Constructor Detail
+Method Detail
+
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+Annotation Type
+Each annotation type has its own separate page with the following sections:
+
+Annotation Type declaration
+Annotation Type description
+Required Element Summary
+Optional Element Summary
+Element Detail
+
+
+
+Enum
+Each enum has its own separate page with the following sections:
+
+Enum declaration
+Enum description
+Enum Constant Summary
+Enum Constant Detail
+
+
+
+Tree (Class Hierarchy)
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
+
+When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
+When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+
+
+Deprecated API
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+
+
+Index
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+
+
+Prev/Next
+These links take you to the next or previous class, interface, package, or related page.
+
+
+Frames/No Frames
+These links show and hide the HTML frames. All pages are available with or without frames.
+
+
+All Classes
+The All Classes link shows all classes and interfaces except non-static nested types.
+
+
+Serialized Form
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+
+
+Constant Field Values
+The Constant Field Values page lists the static final fields and their values.
+
+
+
This help file applies to API documentation generated using the standard doclet. A-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
A
+
+AbstractTask ItemType extends Item > - Class in de.mrapp.apriori.tasks
+An abstract base class for all tasks, which execute a module multiple times in order to
+ obtain the results, which are requested according to a specific configuration.
+
+AbstractTask(Apriori.Configuration) AbstractTask
+Creates a new task, which executes a module multiple times in order to obtain the results,
+ which are requested according to a specific configuration.
+
+add(ItemType) ItemSet
+add(Metric) ArithmeticMean
+Adds a new metric to the arithmetic mean operator.
+
+add(Metric, double) ArithmeticMean
+Adds a new metric to the arithmetic mean operator.
+
+add(Metric) HarmonicMean
+Adds a new metric to the harmonic mean operator.
+
+add(Metric, double) HarmonicMean
+Adds a new metric to the harmonic mean operator.
+
+add(AssociationRule<ItemType>) RuleSet
+addAll(Collection<? extends ItemType>) ItemSet
+addAll(Collection<? extends AssociationRule<ItemType>>) RuleSet
+Apriori ItemType extends Item > - Class in de.mrapp.apriori
+An implementation of the Apriori algorithm for mining frequent item sets and (optionally)
+ generating association rules.
+
+Apriori(Apriori.Configuration) Apriori
+Creates a new implementation of the Apriori algorithm for mining frequent item sets and
+ (optionally) generating association rules.
+
+Apriori(Apriori.Configuration, FrequentItemSetMinerTask<ItemType>, AssociationRuleGeneratorTask<ItemType>) Apriori
+Creates a new implementation of the Apriori algorithm for mining frequent item sets and
+ (optionally) generating association rules.
+
+Apriori.Builder ItemType extends Item > - Class in de.mrapp.apriori
+A builder, which allows to configure and create instances of the class
Apriori.
+Apriori.Configuration de.mrapp.apriori
+An configuration of the Apriori algorithm.
+
+Apriori.RuleGeneratorBuilder ItemType extends Item > - Class in de.mrapp.apriori
+A builder, which allows to configure and create instances of the class
Apriori, which
+ are configured to generate association rules.
+ArithmeticMean de.mrapp.apriori.operators
+An operator, which allows to average the heuristic values, which are calculated by applying
+ multiple metrics to a rule, according to the arithmetic mean operation.
+
+ArithmeticMean() ArithmeticMean
+Creates a new arithmetic mean operator.
+
+AssociationRule ItemType extends Item > - Class in de.mrapp.apriori
+An association rule of the form X -> Y, which consists of a body X and a head Y.
+
+AssociationRule(ItemSet<ItemType>, ItemSet<ItemType>, double) AssociationRule
+Creates a new association rule.
+
+AssociationRule.Comparator de.mrapp.apriori
+A comparator, which allows to compare the heuristic values of two association rules according
+ to a certain metric or operator.
+
+AssociationRuleGenerator ItemType extends Item > - Interface in de.mrapp.apriori.modules
+Defines the interface, a class, which allows to generate association rules, must implement.
+
+AssociationRuleGeneratorModule ItemType extends Item > - Class in de.mrapp.apriori.modules
+A module, which allows to generate association rules from frequent item sets.
+
+AssociationRuleGeneratorModule() AssociationRuleGeneratorModule
+AssociationRuleGeneratorTask ItemType extends Item > - Class in de.mrapp.apriori.tasks
+A task, which tries to generate a specific number of association rules.
+
+AssociationRuleGeneratorTask(Apriori.Configuration) AssociationRuleGeneratorTask
+Creates a new task, which tries to generate a specific number of association rules.
+
+AssociationRuleGeneratorTask(Apriori.Configuration, AssociationRuleGenerator<ItemType>) AssociationRuleGeneratorTask
+Creates a new task, which tries to generate a specific number of association rules.
+
+
+
A B C D E F G H I L M O P R S T L-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
L
+
+last() ItemSet
+last() RuleSet
+Leverage de.mrapp.apriori.metrics
+A metric, which measures the leverage of an association rule.
+
+Leverage() Leverage
+Lift de.mrapp.apriori.metrics
+A metric, which measures the lift of an association rule.
+
+Lift() Lift
+
+
A B C D E F G H I L M O P R S T M-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
M
+
+maxConfidence(double) Apriori.RuleGeneratorBuilder
+Sets the minimum confidence, which should initially be used, when trying to generate a
+ specific number of association rules.
+
+maxSupport(double) Apriori.Builder
+Sets the minimum support, which should initially be used, when trying to find a specific
+ number of frequent item sets.
+
+maxSupport(double) Apriori.RuleGeneratorBuilder
+Sets the minimum support, which should initially be used, when trying to find a specific
+ number of frequent item sets.
+
+maxValue() Metric
+Returns the maximum heuristic value of the metric.
+
+maxValue() Confidence
+maxValue() Leverage
+maxValue() Lift
+maxValue() Support
+Metric de.mrapp.apriori
+Defines the interface, a class, which allows to measure the "interestingly" of association
+ rules according to a certain metric, must implement.
+
+minConfidence(double) Apriori.RuleGeneratorBuilder
+Sets the minimum confidence, which must at least be reached by association rules.
+
+minSupport(double) Apriori.Builder
+Sets the minimum support, which must at least be reached by an item set to be considered
+ frequent.
+
+minSupport(double) Apriori.RuleGeneratorBuilder
+Sets the minimum support, which must at least be reached by an item set to be considered
+ frequent.
+
+minValue() Metric
+Returns the minimum heuristic value of the metric.
+
+minValue() Confidence
+minValue() Leverage
+minValue() Lift
+minValue() Support
+
+
A B C D E F G H I L M O P R S T O-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
O
+
+Operator de.mrapp.apriori
+Defines the interface, a class, which allows to calculate heuristic values of association rules,
+ must implement.
+
+Output ItemType extends Item > - Class in de.mrapp.apriori
+An output of the Apriori algorithm.
+
+Output(Apriori.Configuration, long, long, FrequentItemSetArraySet<ItemType>, RuleSet<ItemType>) Output
+Creates a new output of the Apriori algorithm.
+
+
+
A B C D E F G H I L M O P R S T P-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
P
+
+preferComplex() TieBreaker
+Adds an additional criteria to the current tie-breaking strategy, which prefers complex
+ association rules over simple ones.
+
+preferComplexBody() TieBreaker
+Adds an additional criteria to the current tie-breaking strategy, which prefers complex
+ bodies over simple ones.
+
+preferComplexHead() TieBreaker
+Adds an additional criteria to the current tie-breaking strategy, which prefers complex heads
+ over simple ones.
+
+preferSimple() TieBreaker
+Adds an additional criteria to the current tie-breaking strategy, which prefers simple
+ association rules over complex ones.
+
+preferSimpleBody() TieBreaker
+Adds an additional criteria to the current tie-breaking strategy, which prefers simple bodies
+ over simple ones.
+
+preferSimpleHead() TieBreaker
+Adds an additional criteria to the current tie-breaking strategy, which prefers simple heads
+ over simple ones.
+
+
+
A B C D E F G H I L M O P R S T R-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
R
+
+remove(Object) ItemSet
+remove(Object) RuleSet
+removeAll(Collection<?>) ItemSet
+removeAll(Collection<?>) RuleSet
+retainAll(Collection<?>) ItemSet
+retainAll(Collection<?>) RuleSet
+ruleCount(int) Apriori.RuleGeneratorBuilder
+Sets the number of association rule, the Apriori algorithm should try to generate.
+
+rules RuleSet
+A sorted set, which contains the rules, the rule set consists of.
+
+RuleSet ItemType extends Item > - Class in de.mrapp.apriori
+A rule set, which contains multiple association rules.
+
+RuleSet() RuleSet
+Creates an empty rule set.
+
+RuleSet(SortedSet<AssociationRule<ItemType>>) RuleSet
+Creates a new rule set from a sorted set.
+
+
+
A B C D E F G H I L M O P R S T S-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
S
+
+setConfidenceDelta(double) Apriori.Configuration
+Sets the value, the minimum confidence should be decreased by after each iteration, when
+ trying to generate a specific number of association rules.
+
+setFrequentItemSetCount(int) Apriori.Configuration
+Sets the number of of frequent item sets, the Apriori algorithm should try to find.
+
+setGenerateRules(boolean) Apriori.Configuration
+Sets, whether association rules should be generated, or not.
+
+setMaxConfidence(double) Apriori.Configuration
+Sets the minimum confidence, which should initially be used, when trying to generate a
+ specific number of association rules.
+
+setMaxSupport(double) Apriori.Configuration
+Sets the minimum support, which should initially be used, when trying to find a specific
+ number of frequent item sets.
+
+setMinConfidence(double) Apriori.Configuration
+Sets the minimum confidence, which must at least be reached by association rules.
+
+setMinSupport(double) Apriori.Configuration
+Sets the minimum support, which must at least be reached by an item set to be considered
+ frequent.
+
+setRuleCount(int) Apriori.Configuration
+Sets the number of association rule, the Apriori algorithm should try to generate.
+
+setSupport(double) ItemSet
+Sets the support of the item set.
+
+setSupportDelta(double) Apriori.Configuration
+Sets the value, the minimum support should be decreased by after each iteration, when
+ trying to find a specific number of frequent item sets.
+
+setTransactions(Map<Integer, Transaction<ItemType>>) TransactionalItemSet
+Sets the transactions, the item set occurs in.
+
+size() ItemSet
+size() RuleSet
+sort(Operator) RuleSet
+Sorts the rules, which are contained by the rule set, by their heuristic values according to
+ a specific operator or metric in descending order.
+
+sort(Operator, TieBreaker) RuleSet
+Sorts the rules, which are contained by the rule set, by their heuristic values according to
+ a specific operator or metric in descending order.
+
+subSet(ItemType, ItemType) ItemSet
+subSet(AssociationRule<ItemType>, AssociationRule<ItemType>) RuleSet
+Support de.mrapp.apriori.metrics
+A metric, which measures the support of an association rule.
+
+Support() Support
+supportDelta(double) Apriori.Builder
+Sets the value, the minimum support should be decreased by after each iteration, when
+ trying to find a specific number of frequent item sets.
+
+supportDelta(double) Apriori.RuleGeneratorBuilder
+Sets the value, the minimum support should be decreased by after each iteration, when
+ trying to find a specific number of frequent item sets.
+
+
+
A B C D E F G H I L M O P R S T T-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
T
+
+tailSet(ItemType) ItemSet
+tailSet(AssociationRule<ItemType>) RuleSet
+tieBreak(AssociationRule<?>, AssociationRule<?>) TieBreaker
+Decides, which one of two association rules is considered to be more "interestingly"
+ according to the tie-breaking strategy.
+
+TieBreaker de.mrapp.apriori
+A tie-breaking strategy, which allows to decide, which one of two association rules is considered
+ to be more "interestingly", if their heuristic values are equal.
+
+TieBreaker() TieBreaker
+Creates a new tie-breaking strategy.
+
+toArray() ItemSet
+toArray(T[]) ItemSet
+toArray() RuleSet
+toArray(T[]) RuleSet
+toString() Apriori.Configuration
+toString() AssociationRule
+toString() ItemSet
+toString() Output
+toString() RuleSet
+Transaction ItemType extends Item > - Interface in de.mrapp.apriori
+Defines the interface, a transaction, which consists of multiple items, must implement.
+
+TransactionalItemSet ItemType extends Item > - Class in de.mrapp.apriori.datastructure
+An extension of the class
ItemSet, which allows to store the transactions, the item
+ set occurs in.
+TransactionalItemSet() TransactionalItemSet
+Creates an empty item set.
+
+TransactionalItemSet(TransactionalItemSet<ItemType>) TransactionalItemSet
+Creates a new item set by copying another item set.
+
+
+
A B C D E F G H I L M O P R S T B-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
B
+
+Builder(double) Apriori.Builder
+Creates a new builder, which allows to configure and create instances of the class
Apriori.
+Builder(int) Apriori.Builder
+Creates a new builder, which allows to configure and create instances of the class
Apriori.
+byOperator(Operator) TieBreaker
+Adds an additional criteria to the current tie-breaking strategy, which performs tie-breaking
+ according to a specific operator.
+
+
+
A B C D E F G H I L M O P R S T C-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
C
+
+clear() ItemSet
+clear() RuleSet
+clone() Apriori.Configuration
+clone() AssociationRule
+clone() FrequentItemSetArraySet
+clone() ItemSet
+clone() Output
+clone() RuleSet
+comparator() ItemSet
+comparator() RuleSet
+compare(AssociationRule<?>, AssociationRule<?>) AssociationRule.Comparator
+compareTo(ItemSet<ItemType>) ItemSet
+Confidence de.mrapp.apriori.metrics
+A metric, which measures the confidence of an association rule.
+
+Confidence() Confidence
+confidenceDelta(double) Apriori.RuleGeneratorBuilder
+Sets the value, the minimum confidence should be decreased by after each iteration, when
+ trying to generate a specific number of association rules.
+
+Configuration() Apriori.Configuration
+Creates a new configuration of the Apriori algorithm with default values.
+
+contains(Object) ItemSet
+contains(Object) RuleSet
+containsAll(Collection<?>) ItemSet
+containsAll(Collection<?>) RuleSet
+custom(BiFunction<AssociationRule, AssociationRule, Integer>) TieBreaker
+Adds an additional custom criteria to the current tie-breaking strategy.
+
+
+
A B C D E F G H I L M O P R S T D-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
D
+
+de.mrapp.apriori - package de.mrapp.apriori
+de.mrapp.apriori.datastructure - package de.mrapp.apriori.datastructure
+de.mrapp.apriori.metrics - package de.mrapp.apriori.metrics
+de.mrapp.apriori.modules - package de.mrapp.apriori.modules
+de.mrapp.apriori.operators - package de.mrapp.apriori.operators
+de.mrapp.apriori.tasks - package de.mrapp.apriori.tasks
+
+
A B C D E F G H I L M O P R S T E-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
E
+
+equals(Object) Apriori.Configuration
+equals(Object) AssociationRule
+equals(Object) ItemSet
+equals(Object) Output
+equals(Object) RuleSet
+evaluate(AssociationRule<?>) Confidence
+evaluate(AssociationRule<?>) Leverage
+evaluate(AssociationRule<?>) Lift
+evaluate(AssociationRule<?>) Support
+evaluate(AssociationRule<?>) Operator
+Calculates the heuristic value of a specific association rule.
+
+evaluate(AssociationRule<?>) ArithmeticMean
+evaluate(AssociationRule<?>) HarmonicMean
+execute(Iterator<Transaction<ItemType>>) Apriori
+Executes the Apriori algorithm on a specific set of transactions in order to learn
+ association rules, which specify frequent item sets.
+
+
+
A B C D E F G H I L M O P R S T F-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
F
+
+filter(Operator, double) RuleSet
+Filters all rules, which are contained by the rule set, whose heuristic value according to a
+ specific operator or metric is greater or equal than a specific threshold.
+
+filter(Operator, double, TieBreaker) RuleSet
+Filters all rules, which are contained by the rule set, whose heuristic value according to a
+ specific operator or metric is greater or equal than a specific threshold.
+
+findFrequentItemSets(Iterator<Transaction<ItemType>>, double) FrequentItemSetMiner
+Searches for frequent item sets.
+
+findFrequentItemSets(Iterator<Transaction<ItemType>>, double) FrequentItemSetMinerModule
+findFrequentItemSets(Iterator<Transaction<ItemType>>) FrequentItemSetMinerTask
+Tries to find a specific number of frequent item sets.
+
+first() ItemSet
+first() RuleSet
+formatFrequentItemSets(Collection<? extends ItemSet<T>>) FrequentItemSetArraySet
+Creates and returns a string, which contains information about the frequent item set, which
+ have been found by the algorithm.
+
+FrequentItemSetArraySet ItemType extends Item > - Class in de.mrapp.apriori.datastructure
+A tree set, which contains frequent item sets.
+
+FrequentItemSetArraySet(Comparator<? super ItemSet<ItemType>>) FrequentItemSetArraySet
+Creates a new tree set, which contains frequent item sets.
+
+frequentItemSetCount(int) Apriori.Builder
+Sets the number of of frequent item sets, the Apriori algorithm should try to find.
+
+frequentItemSetCount(int) Apriori.RuleGeneratorBuilder
+Sets the number of of frequent item sets, the Apriori algorithm should try to find.
+
+FrequentItemSetMiner ItemType extends Item > - Interface in de.mrapp.apriori.modules
+Defines the interface, a class, which allows to find frequent item sets, must implement.
+
+FrequentItemSetMinerModule ItemType extends Item > - Class in de.mrapp.apriori.modules
+A module, which allows to find all frequent item sets, which occur in a data set.
+
+FrequentItemSetMinerModule() FrequentItemSetMinerModule
+FrequentItemSetMinerTask ItemType extends Item > - Class in de.mrapp.apriori.tasks
+A task, which tries to find a specific number of frequent item sets.
+
+FrequentItemSetMinerTask(Apriori.Configuration) FrequentItemSetMinerTask
+Creates a new task, which tries to find a specific number of frequent item sets.
+
+FrequentItemSetMinerTask(Apriori.Configuration, FrequentItemSetMiner<ItemType>) FrequentItemSetMinerTask
+Creates a new task, which tries to find a specific number of frequent item sets.
+
+
+
A B C D E F G H I L M O P R S T G-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
G
+
+generateAssociationRules(Map<Integer, ? extends ItemSet<ItemType>>, double) AssociationRuleGenerator
+Generates association rules from frequent item sets.
+
+generateAssociationRules(Map<Integer, ? extends ItemSet<ItemType>>, double) AssociationRuleGeneratorModule
+generateAssociationRules(Map<Integer, ? extends ItemSet<ItemType>>) AssociationRuleGeneratorTask
+Tries to generate a specific number of association rules from frequent item sets.
+
+generateRules(double) Apriori.Builder
+Enables to generate association rules.
+
+generateRules(int) Apriori.Builder
+Enables to generate association rules.
+
+getBody() AssociationRule
+Returns the body of the association rule.
+
+getConfidenceDelta() Apriori.Configuration
+Returns the value, the minimum confidence should be decreased by after each iteration,
+ when trying to generate a specific number of association rules.
+
+getConfiguration() Apriori
+Returns the configuration, which is used by the Apriori algorithm.
+
+getConfiguration() Output
+Returns the configuration of the Apriori algorithm.
+
+getConfiguration() AbstractTask
+Returns the configuration, which is used by the task.
+
+getEndTime() Output
+Returns the time, the Apriori algorithm has been ended.
+
+getFrequentItemSetCount() Apriori.Configuration
+Returns the number of frequent item sets, the Apriori algorithm should try to find.
+
+getFrequentItemSets() Output
+Returns the frequent item sets, which have been found by the Apriori algorithm.
+
+getHead() AssociationRule
+Returns the head of the association rule.
+
+getMaxConfidence() Apriori.Configuration
+Returns the minimum confidence, which should initially be used, when trying to generate a
+ specific number of association rules.
+
+getMaxSupport() Apriori.Configuration
+Returns the minimum support, which should initially be used, when trying to find a
+ specific number of frequent item sets.
+
+getMinConfidence() Apriori.Configuration
+Returns the minimum confidence, which must at least be reached by association rules.
+
+getMinSupport() Apriori.Configuration
+Returns the minimum support, which must at least be reached by an item set to be
+ considered frequent.
+
+getRuleCount() Apriori.Configuration
+Returns the number of association rules, the Apriori algorithm should try to generate.
+
+getRuleSet() Output
+Returns the association rules, which have been generated by the Apriori algorithm.
+
+getRuntime() Output
+Returns the runtime of the Apriori algorithm.
+
+getStartTime() Output
+Returns the time, the Apriori algorithm has been started.
+
+getSupport() AssociationRule
+Returns the support of the association rule.
+
+getSupport() ItemSet
+Returns the support of the item set.
+
+getSupportDelta() Apriori.Configuration
+Returns the value, the minimum support should be decreased by after each iteration, when
+ trying to find a specific number of frequent item sets.
+
+getTransactions() TransactionalItemSet
+Returns the transactions, the item set occurs in.
+
+
+
A B C D E F G H I L M O P R S T H-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
H
+
+HarmonicMean de.mrapp.apriori.operators
+An operator, which allows to average the heuristic values, which are calculated by applying
+ multiple metrics to a rule, according to the harmonic mean operation.
+
+HarmonicMean() HarmonicMean
+Creates a new harmonic mean operator.
+
+hashCode() Apriori.Configuration
+hashCode() AssociationRule
+hashCode() ItemSet
+hashCode() Output
+hashCode() RuleSet
+headSet(ItemType) ItemSet
+headSet(AssociationRule<ItemType>) RuleSet
+
+
A B C D E F G H I L M O P R S T I-Index
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+A B C D E F G H I L M O P R S T
+
+
+
I
+
+isEmpty() ItemSet
+isEmpty() RuleSet
+isGeneratingRules() Apriori.Configuration
+Returns, whether association rules should be generated, or not.
+
+Item de.mrapp.apriori
+Defines the interface, an item, which is part of a transaction, must implement.
+
+ItemSet ItemType > - Class in de.mrapp.apriori
+An item set, which may contain several items.
+
+ItemSet() ItemSet
+Creates an empty item set.
+
+ItemSet(ItemSet<ItemType>) ItemSet
+Creates a new item set by copying another item set.
+
+iterator() ItemSet
+iterator() RuleSet
+
+
A B C D E F G H I L M O P R S T Generated Documentation (Untitled)
+
+
+
+
+
+<![CDATA[
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<h2>Frame Alert</h2>
+<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p>
+]]>
+
+
diff --git a/doc/javadoc/overview-frame.html b/doc/javadoc/overview-frame.html
new file mode 100644
index 0000000..ea3a175
--- /dev/null
+++ b/doc/javadoc/overview-frame.html
@@ -0,0 +1,26 @@
+
+
+
+
+
+Overview List
+
+
+
diff --git a/doc/javadoc/overview-summary.html b/doc/javadoc/overview-summary.html
new file mode 100644
index 0000000..c8e6836
--- /dev/null
+++ b/doc/javadoc/overview-summary.html
@@ -0,0 +1,153 @@
+
+
+
+
+
+Overview
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/javadoc/overview-tree.html b/doc/javadoc/overview-tree.html
new file mode 100644
index 0000000..62ca891
--- /dev/null
+++ b/doc/javadoc/overview-tree.html
@@ -0,0 +1,197 @@
+
+
+
+
+
+Class Hierarchy
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
Class Hierarchy
+
+
Interface Hierarchy
+
+de.mrapp.apriori.modules.AssociationRuleGenerator
+java.lang.Comparable<T>
+
+de.mrapp.apriori.Item
+
+
+de.mrapp.apriori.modules.FrequentItemSetMiner
+java.lang.Iterable<T>
+
+
+de.mrapp.apriori.Operator
+java.io.Serializable
+
+de.mrapp.apriori.Item
+
+
+
+
" + tabs[value][1] + " ";
+ }
+ }
+}
diff --git a/doc/javadoc/serialized-form.html b/doc/javadoc/serialized-form.html
new file mode 100644
index 0000000..0b51a66
--- /dev/null
+++ b/doc/javadoc/serialized-form.html
@@ -0,0 +1,339 @@
+
+
+
+
+
+Serialized Form
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/javadoc/stylesheet.css b/doc/javadoc/stylesheet.css
new file mode 100644
index 0000000..98055b2
--- /dev/null
+++ b/doc/javadoc/stylesheet.css
@@ -0,0 +1,574 @@
+/* Javadoc style sheet */
+/*
+Overall document style
+*/
+
+@import url('resources/fonts/dejavu.css');
+
+body {
+ background-color:#ffffff;
+ color:#353833;
+ font-family:'DejaVu Sans', Arial, Helvetica, sans-serif;
+ font-size:14px;
+ margin:0;
+}
+a:link, a:visited {
+ text-decoration:none;
+ color:#4A6782;
+}
+a:hover, a:focus {
+ text-decoration:none;
+ color:#bb7a2a;
+}
+a:active {
+ text-decoration:none;
+ color:#4A6782;
+}
+a[name] {
+ color:#353833;
+}
+a[name]:hover {
+ text-decoration:none;
+ color:#353833;
+}
+pre {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+}
+h1 {
+ font-size:20px;
+}
+h2 {
+ font-size:18px;
+}
+h3 {
+ font-size:16px;
+ font-style:italic;
+}
+h4 {
+ font-size:13px;
+}
+h5 {
+ font-size:12px;
+}
+h6 {
+ font-size:11px;
+}
+ul {
+ list-style-type:disc;
+}
+code, tt {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+ padding-top:4px;
+ margin-top:8px;
+ line-height:1.4em;
+}
+dt code {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+ padding-top:4px;
+}
+table tr td dt code {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+ vertical-align:top;
+ padding-top:4px;
+}
+sup {
+ font-size:8px;
+}
+/*
+Document title and Copyright styles
+*/
+.clear {
+ clear:both;
+ height:0px;
+ overflow:hidden;
+}
+.aboutLanguage {
+ float:right;
+ padding:0px 21px;
+ font-size:11px;
+ z-index:200;
+ margin-top:-9px;
+}
+.legalCopy {
+ margin-left:.5em;
+}
+.bar a, .bar a:link, .bar a:visited, .bar a:active {
+ color:#FFFFFF;
+ text-decoration:none;
+}
+.bar a:hover, .bar a:focus {
+ color:#bb7a2a;
+}
+.tab {
+ background-color:#0066FF;
+ color:#ffffff;
+ padding:8px;
+ width:5em;
+ font-weight:bold;
+}
+/*
+Navigation bar styles
+*/
+.bar {
+ background-color:#4D7A97;
+ color:#FFFFFF;
+ padding:.8em .5em .4em .8em;
+ height:auto;/*height:1.8em;*/
+ font-size:11px;
+ margin:0;
+}
+.topNav {
+ background-color:#4D7A97;
+ color:#FFFFFF;
+ float:left;
+ padding:0;
+ width:100%;
+ clear:right;
+ height:2.8em;
+ padding-top:10px;
+ overflow:hidden;
+ font-size:12px;
+}
+.bottomNav {
+ margin-top:10px;
+ background-color:#4D7A97;
+ color:#FFFFFF;
+ float:left;
+ padding:0;
+ width:100%;
+ clear:right;
+ height:2.8em;
+ padding-top:10px;
+ overflow:hidden;
+ font-size:12px;
+}
+.subNav {
+ background-color:#dee3e9;
+ float:left;
+ width:100%;
+ overflow:hidden;
+ font-size:12px;
+}
+.subNav div {
+ clear:left;
+ float:left;
+ padding:0 0 5px 6px;
+ text-transform:uppercase;
+}
+ul.navList, ul.subNavList {
+ float:left;
+ margin:0 25px 0 0;
+ padding:0;
+}
+ul.navList li{
+ list-style:none;
+ float:left;
+ padding: 5px 6px;
+ text-transform:uppercase;
+}
+ul.subNavList li{
+ list-style:none;
+ float:left;
+}
+.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited {
+ color:#FFFFFF;
+ text-decoration:none;
+ text-transform:uppercase;
+}
+.topNav a:hover, .bottomNav a:hover {
+ text-decoration:none;
+ color:#bb7a2a;
+ text-transform:uppercase;
+}
+.navBarCell1Rev {
+ background-color:#F8981D;
+ color:#253441;
+ margin: auto 5px;
+}
+.skipNav {
+ position:absolute;
+ top:auto;
+ left:-9999px;
+ overflow:hidden;
+}
+/*
+Page header and footer styles
+*/
+.header, .footer {
+ clear:both;
+ margin:0 20px;
+ padding:5px 0 0 0;
+}
+.indexHeader {
+ margin:10px;
+ position:relative;
+}
+.indexHeader span{
+ margin-right:15px;
+}
+.indexHeader h1 {
+ font-size:13px;
+}
+.title {
+ color:#2c4557;
+ margin:10px 0;
+}
+.subTitle {
+ margin:5px 0 0 0;
+}
+.header ul {
+ margin:0 0 15px 0;
+ padding:0;
+}
+.footer ul {
+ margin:20px 0 5px 0;
+}
+.header ul li, .footer ul li {
+ list-style:none;
+ font-size:13px;
+}
+/*
+Heading styles
+*/
+div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 {
+ background-color:#dee3e9;
+ border:1px solid #d0d9e0;
+ margin:0 0 6px -8px;
+ padding:7px 5px;
+}
+ul.blockList ul.blockList ul.blockList li.blockList h3 {
+ background-color:#dee3e9;
+ border:1px solid #d0d9e0;
+ margin:0 0 6px -8px;
+ padding:7px 5px;
+}
+ul.blockList ul.blockList li.blockList h3 {
+ padding:0;
+ margin:15px 0;
+}
+ul.blockList li.blockList h2 {
+ padding:0px 0 20px 0;
+}
+/*
+Page layout container styles
+*/
+.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer {
+ clear:both;
+ padding:10px 20px;
+ position:relative;
+}
+.indexContainer {
+ margin:10px;
+ position:relative;
+ font-size:12px;
+}
+.indexContainer h2 {
+ font-size:13px;
+ padding:0 0 3px 0;
+}
+.indexContainer ul {
+ margin:0;
+ padding:0;
+}
+.indexContainer ul li {
+ list-style:none;
+ padding-top:2px;
+}
+.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt {
+ font-size:12px;
+ font-weight:bold;
+ margin:10px 0 0 0;
+ color:#4E4E4E;
+}
+.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd {
+ margin:5px 0 10px 0px;
+ font-size:14px;
+ font-family:'DejaVu Sans Mono',monospace;
+}
+.serializedFormContainer dl.nameValue dt {
+ margin-left:1px;
+ font-size:1.1em;
+ display:inline;
+ font-weight:bold;
+}
+.serializedFormContainer dl.nameValue dd {
+ margin:0 0 0 1px;
+ font-size:1.1em;
+ display:inline;
+}
+/*
+List styles
+*/
+ul.horizontal li {
+ display:inline;
+ font-size:0.9em;
+}
+ul.inheritance {
+ margin:0;
+ padding:0;
+}
+ul.inheritance li {
+ display:inline;
+ list-style:none;
+}
+ul.inheritance li ul.inheritance {
+ margin-left:15px;
+ padding-left:15px;
+ padding-top:1px;
+}
+ul.blockList, ul.blockListLast {
+ margin:10px 0 10px 0;
+ padding:0;
+}
+ul.blockList li.blockList, ul.blockListLast li.blockList {
+ list-style:none;
+ margin-bottom:15px;
+ line-height:1.4;
+}
+ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList {
+ padding:0px 20px 5px 10px;
+ border:1px solid #ededed;
+ background-color:#f8f8f8;
+}
+ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList {
+ padding:0 0 5px 8px;
+ background-color:#ffffff;
+ border:none;
+}
+ul.blockList ul.blockList ul.blockList ul.blockList li.blockList {
+ margin-left:0;
+ padding-left:0;
+ padding-bottom:15px;
+ border:none;
+}
+ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast {
+ list-style:none;
+ border-bottom:none;
+ padding-bottom:0;
+}
+table tr td dl, table tr td dl dt, table tr td dl dd {
+ margin-top:0;
+ margin-bottom:1px;
+}
+/*
+Table styles
+*/
+.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary {
+ width:100%;
+ border-left:1px solid #EEE;
+ border-right:1px solid #EEE;
+ border-bottom:1px solid #EEE;
+}
+.overviewSummary, .memberSummary {
+ padding:0px;
+}
+.overviewSummary caption, .memberSummary caption, .typeSummary caption,
+.useSummary caption, .constantsSummary caption, .deprecatedSummary caption {
+ position:relative;
+ text-align:left;
+ background-repeat:no-repeat;
+ color:#253441;
+ font-weight:bold;
+ clear:none;
+ overflow:hidden;
+ padding:0px;
+ padding-top:10px;
+ padding-left:1px;
+ margin:0px;
+ white-space:pre;
+}
+.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link,
+.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link,
+.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover,
+.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover,
+.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active,
+.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active,
+.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited,
+.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited {
+ color:#FFFFFF;
+}
+.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span,
+.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span {
+ white-space:nowrap;
+ padding-top:5px;
+ padding-left:12px;
+ padding-right:12px;
+ padding-bottom:7px;
+ display:inline-block;
+ float:left;
+ background-color:#F8981D;
+ border: none;
+ height:16px;
+}
+.memberSummary caption span.activeTableTab span {
+ white-space:nowrap;
+ padding-top:5px;
+ padding-left:12px;
+ padding-right:12px;
+ margin-right:3px;
+ display:inline-block;
+ float:left;
+ background-color:#F8981D;
+ height:16px;
+}
+.memberSummary caption span.tableTab span {
+ white-space:nowrap;
+ padding-top:5px;
+ padding-left:12px;
+ padding-right:12px;
+ margin-right:3px;
+ display:inline-block;
+ float:left;
+ background-color:#4D7A97;
+ height:16px;
+}
+.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab {
+ padding-top:0px;
+ padding-left:0px;
+ padding-right:0px;
+ background-image:none;
+ float:none;
+ display:inline;
+}
+.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd,
+.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd {
+ display:none;
+ width:5px;
+ position:relative;
+ float:left;
+ background-color:#F8981D;
+}
+.memberSummary .activeTableTab .tabEnd {
+ display:none;
+ width:5px;
+ margin-right:3px;
+ position:relative;
+ float:left;
+ background-color:#F8981D;
+}
+.memberSummary .tableTab .tabEnd {
+ display:none;
+ width:5px;
+ margin-right:3px;
+ position:relative;
+ background-color:#4D7A97;
+ float:left;
+
+}
+.overviewSummary td, .memberSummary td, .typeSummary td,
+.useSummary td, .constantsSummary td, .deprecatedSummary td {
+ text-align:left;
+ padding:0px 0px 12px 10px;
+}
+th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th,
+td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{
+ vertical-align:top;
+ padding-right:0px;
+ padding-top:8px;
+ padding-bottom:3px;
+}
+th.colFirst, th.colLast, th.colOne, .constantsSummary th {
+ background:#dee3e9;
+ text-align:left;
+ padding:8px 3px 3px 7px;
+}
+td.colFirst, th.colFirst {
+ white-space:nowrap;
+ font-size:13px;
+}
+td.colLast, th.colLast {
+ font-size:13px;
+}
+td.colOne, th.colOne {
+ font-size:13px;
+}
+.overviewSummary td.colFirst, .overviewSummary th.colFirst,
+.useSummary td.colFirst, .useSummary th.colFirst,
+.overviewSummary td.colOne, .overviewSummary th.colOne,
+.memberSummary td.colFirst, .memberSummary th.colFirst,
+.memberSummary td.colOne, .memberSummary th.colOne,
+.typeSummary td.colFirst{
+ width:25%;
+ vertical-align:top;
+}
+td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover {
+ font-weight:bold;
+}
+.tableSubHeadingColor {
+ background-color:#EEEEFF;
+}
+.altColor {
+ background-color:#FFFFFF;
+}
+.rowColor {
+ background-color:#EEEEEF;
+}
+/*
+Content styles
+*/
+.description pre {
+ margin-top:0;
+}
+.deprecatedContent {
+ margin:0;
+ padding:10px 0;
+}
+.docSummary {
+ padding:0;
+}
+
+ul.blockList ul.blockList ul.blockList li.blockList h3 {
+ font-style:normal;
+}
+
+div.block {
+ font-size:14px;
+ font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
+}
+
+td.colLast div {
+ padding-top:0px;
+}
+
+
+td.colLast a {
+ padding-bottom:3px;
+}
+/*
+Formatting effect styles
+*/
+.sourceLineNo {
+ color:green;
+ padding:0 30px 0 0;
+}
+h1.hidden {
+ visibility:hidden;
+ overflow:hidden;
+ font-size:10px;
+}
+.block {
+ display:block;
+ margin:3px 10px 2px 0px;
+ color:#474747;
+}
+.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink,
+.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel,
+.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink {
+ font-weight:bold;
+}
+.deprecationComment, .emphasizedPhrase, .interfaceName {
+ font-style:italic;
+}
+
+div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase,
+div.block div.block span.interfaceName {
+ font-style:normal;
+}
+
+div.contentContainer ul.blockList li.blockList h2{
+ padding-bottom:0px;
+}